Zeebe.Client.Api.Builder.IZeebeSecureClientBuilder Interface Reference

Inheritance diagram for Zeebe.Client.Api.Builder.IZeebeSecureClientBuilder:

Public Member Functions
IZeebeSecureClientBuilder	AllowUntrustedCertificates ()
	DANGER: This allows untrusted certificates for the gRPC connection with Zeebe. This setting tells the client to allow to use untrusted certificates in the underlying SocketHttpHandler. For further details see https://github.com/dotnet/runtime/issues/42482. This might be useful for testing.
IZeebeClientFinalBuildStep	UseAccessToken (string accessToken)
	Client should use the given access token to authenticate with.
IZeebeClientFinalBuildStep	UseAccessTokenSupplier (IAccessTokenSupplier supplier)
	Client should use an access token to authenticate with and the given supplier should be used to receive the token.
Public Member Functions inherited from Zeebe.Client.Api.Builder.IZeebeClientFinalBuildStep
IZeebeClientFinalBuildStep	UseKeepAlive (TimeSpan keepAlive)
	Uses the given time interval to determine when to send a keepalive ping to the gateway. The default is 30 seconds.
IZeebeClientFinalBuildStep	UseRetrySleepDurationProvider (Func< int, TimeSpan > sleepDurationProvider)
	Uses the given duration provider for the send retries. On each retry, the duration to wait is calculated by calling sleepDurationProvider with the current retry number (1 for first retry, 2 for second etc).
IZeebeClient	Build ()
	Builds the client with the given configuration.

Member Function Documentation

AllowUntrustedCertificates()

IZeebeSecureClientBuilder Zeebe.Client.Api.Builder.IZeebeSecureClientBuilder.AllowUntrustedCertificates

(

)

DANGER: This allows untrusted certificates for the gRPC connection with Zeebe. This setting tells the client to allow to use untrusted certificates in the underlying SocketHttpHandler. For further details see https://github.com/dotnet/runtime/issues/42482. This might be useful for testing.

Returns

the builder to create a secure client.

UseAccessToken()

IZeebeClientFinalBuildStep Zeebe.Client.Api.Builder.IZeebeSecureClientBuilder.UseAccessToken

(

string

accessToken

)

Client should use the given access token to authenticate with.

Parameters

accessToken

the access token which is used for authentication.

Returns

the final client builder step.

UseAccessTokenSupplier()

IZeebeClientFinalBuildStep Zeebe.Client.Api.Builder.IZeebeSecureClientBuilder.UseAccessTokenSupplier

(

IAccessTokenSupplier

supplier

)

Client should use an access token to authenticate with and the given supplier should be used to receive the token.

Parameters

supplier

the access token supplier which is called to supplied the access token.

Returns

the final client builder step.

---

The documentation for this interface was generated from the following file:

• Client/Api/Builder/IZeebeClientBuilder.cs