Skip to main content

Interface: CloudOperationsConnectionOptions

cloud.CloudOperationsConnectionOptions

The Temporal Cloud Operations Client API is an experimental feature and may be subject to change.

Properties​

address​

• Optional address: string

The address of the Temporal Cloud Operations API to connect to, in hostname:port format.

Default

saas-api.tmprl.cloud:443

apiKey​

• apiKey: string | () => string

API key for Temporal. This becomes the "Authorization" HTTP header with "Bearer " prepended.

You may provide a static string or a callback. Also see CloudOperationsConnection.withApiKey or Connection.setApiKey

channelArgs​

• Optional channelArgs: ChannelOptions

GRPC Channel arguments

See

option descriptions here

By default the SDK sets the following keepalive arguments:

grpc.keepalive_permit_without_calls: 1
grpc.keepalive_time_ms: 30_000
grpc.keepalive_timeout_ms: 15_000

To opt-out of keepalive, override these keys with undefined.

connectTimeout​

• Optional connectTimeout: Duration

Milliseconds to wait until establishing a connection with the server.

Format

number of milliseconds or ms-formatted string

Default

10 seconds

interceptors​

• Optional interceptors: Interceptor[]

gRPC interceptors which will be applied to every RPC call performed by this connection. By default, an interceptor will be included which automatically retries retryable errors. If you do not wish to perform automatic retries, set this to an empty list (or a list with your own interceptors). If you want to add your own interceptors while keeping the default retry behavior, add this to your list of interceptors: makeGrpcRetryInterceptor(defaultGrpcRetryOptions()).

See:

  • makeGrpcRetryInterceptor
  • defaultGrpcRetryOptions

metadata​

• Optional metadata: Metadata

Optional mapping of gRPC metadata (HTTP headers) to send with each request to the server. An Authorization header set through metadata will be ignored and overriden by the value of the apiKey option.

In order to dynamically set metadata, use CloudOperationsConnection.withMetadata

tls​

• Optional tls: true | Pick<TLSConfig, "serverNameOverride">

TLS configuration. TLS is required for connecting to the Temporal Cloud Operations API.

Default

true