Class CloudServiceStubsOptions.Builder

java.lang.Object

io.temporal.serviceclient.ServiceStubsOptions.Builder<CloudServiceStubsOptions.Builder>

io.temporal.serviceclient.CloudServiceStubsOptions.Builder

Enclosing class:

CloudServiceStubsOptions

public static class CloudServiceStubsOptions.Builder
extends ServiceStubsOptions.Builder<CloudServiceStubsOptions.Builder>

Builder is the builder for ClientOptions.

Method Summary

Modifier and Type	Method	Description
CloudServiceStubsOptions	build()	Builds and returns a ClientOptions object.
CloudServiceStubsOptions.Builder	setChannel(io.grpc.ManagedChannel channel)	Sets fully custom user-configured gRPC channel to use.
CloudServiceStubsOptions.Builder	setTarget(String target)	Default is CloudServiceStubsOptions.DEFAULT_CLOUD_TARGET.
CloudServiceStubsOptions.Builder	setVersion(String version)	Set a cloud operation service version.
CloudServiceStubsOptions	validateAndBuildWithDefaults()

Methods inherited from class io.temporal.serviceclient.ServiceStubsOptions.Builder

addApiKey, addGrpcClientInterceptor, addGrpcMetadataProvider, setChannelInitializer, setConnectionBackoffResetFrequency, setEnableHttps, setEnableKeepAlive, setGrpcClientInterceptors, setGrpcCompression, setGrpcMetadataProviders, setGrpcReconnectFrequency, setHeaders, setHealthCheckAttemptTimeout, setHealthCheckTimeout, setKeepAlivePermitWithoutStream, setKeepAliveTime, setKeepAliveTimeout, setMetricsScope, setRpcTimeout, setSslContext, setSystemInfoTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setVersion

public CloudServiceStubsOptions.Builder setVersion(String version)

Set a cloud operation service version. This sets the version header for each call.

setTarget

public CloudServiceStubsOptions.Builder setTarget(String target)

Default is CloudServiceStubsOptions.DEFAULT_CLOUD_TARGET. See inherited method for more details.

Overrides:

setTarget in class ServiceStubsOptions.Builder<CloudServiceStubsOptions.Builder>

Returns:

this

setChannel

public CloudServiceStubsOptions.Builder setChannel(io.grpc.ManagedChannel channel)

Description copied from class: ServiceStubsOptions.Builder

Sets fully custom user-configured gRPC channel to use.

Before supplying a fully custom channel using this method, it's recommended to first consider using ServiceStubsOptions.Builder.setTarget(String) + other options of WorkflowServiceStubsOptions.Builder + ServiceStubsOptions.Builder.setChannelInitializer(Consumer) for some rarely used configuration.
This option is not intended for the majority of users as it disables some Temporal connection management features and can lead to outages if the channel is configured or managed improperly.

Mutually exclusive with ServiceStubsOptions.Builder.setTarget(String), ServiceStubsOptions.Builder.setChannelInitializer(Consumer), ServiceStubsOptions.Builder.setSslContext(SslContext), ServiceStubsOptions.Builder.setGrpcReconnectFrequency(Duration) and ServiceStubsOptions.Builder.setConnectionBackoffResetFrequency(Duration). These options are ignored if the custom channel is supplied.

Overrides:

setChannel in class ServiceStubsOptions.Builder<CloudServiceStubsOptions.Builder>

Returns:

this

build

public CloudServiceStubsOptions build()

Builds and returns a ClientOptions object.

Overrides:

build in class ServiceStubsOptions.Builder<CloudServiceStubsOptions.Builder>

Returns:

ClientOptions object with the specified params.

validateAndBuildWithDefaults

public CloudServiceStubsOptions validateAndBuildWithDefaults()

Overrides:

validateAndBuildWithDefaults in class ServiceStubsOptions.Builder<CloudServiceStubsOptions.Builder>