Zeebe.Client.Api.Builder.ICamundaCloudClientBuilder Interface Reference

Simplifies the setup of an IZeebeClient which targets Camunda Cloud. More...

Public Member Functions
ICamundaCloudClientBuilderStep1	UseClientId (string clientId)
	Defines the client id, which should be used to communicate with the Camunda Cloud cluster. You need to create a client in the Camunda Cloud, after that you can find a newly generated client id there.
ICamundaCloudClientBuilderFinalStep	FromEnv ()
	Short cut operation. Reads from the environment all necessary information, to communicate with the camunda cloud cluster. Following environment variables are expected: ZEEBE_ADDRESS ZEEBE_CLIENT_ID ZEEBE_CLIENT_SECRET Optional the authorization server url can be set via: ZEEBE_AUTHORIZATION_SERVER_URL.

Detailed Description

Simplifies the setup of an IZeebeClient which targets Camunda Cloud.

Member Function Documentation

FromEnv()

ICamundaCloudClientBuilderFinalStep Zeebe.Client.Api.Builder.ICamundaCloudClientBuilder.FromEnv

(

)

Short cut operation. Reads from the environment all necessary information, to communicate with the camunda cloud cluster. Following environment variables are expected:

• ZEEBE_ADDRESS
• ZEEBE_CLIENT_ID
• ZEEBE_CLIENT_SECRET

Optional the authorization server url can be set via: ZEEBE_AUTHORIZATION_SERVER_URL.

Returns

the final ICamundaCloudClientBuilder step.

UseClientId()

ICamundaCloudClientBuilderStep1 Zeebe.Client.Api.Builder.ICamundaCloudClientBuilder.UseClientId

(

string

clientId

)

Defines the client id, which should be used to communicate with the Camunda Cloud cluster. You need to create a client in the Camunda Cloud, after that you can find a newly generated client id there.

Parameters

clientId

the client id, which is supplied by the Camunda Cloud.

Returns

the next step in building a ICamundaCloudClient.

---

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

• Client/Api/Builder/ICamundaCloudClientBuilder.cs