Class GatewayControlSettings (0.54.0) 

public class GatewayControlSettings extends ClientSettings<GatewayControlSettings>

Settings class to configure an instance of GatewayControlClient.

The default instance has everything set to sensible defaults:

  • The default service address (connectgateway.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of generateCredentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GatewayControlSettings.Builder gatewayControlSettingsBuilder =
     GatewayControlSettings.newBuilder();
 gatewayControlSettingsBuilder
     .generateCredentialsSettings()
     .setRetrySettings(
         gatewayControlSettingsBuilder
             .generateCredentialsSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 GatewayControlSettings gatewayControlSettings = gatewayControlSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > GatewayControlSettings

Static Methods

create(GatewayControlStubSettings stub)

public static final GatewayControlSettings create(GatewayControlStubSettings stub)
Parameter
Name Description
stub GatewayControlStubSettings
Returns
Type Description
GatewayControlSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static GatewayControlSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
GatewayControlSettings.Builder

newBuilder(ClientContext clientContext)

public static GatewayControlSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
GatewayControlSettings.Builder

Constructors

GatewayControlSettings(GatewayControlSettings.Builder settingsBuilder)

protected GatewayControlSettings(GatewayControlSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder GatewayControlSettings.Builder

Methods

generateCredentialsSettings()

public UnaryCallSettings<GenerateCredentialsRequest,GenerateCredentialsResponse> generateCredentialsSettings()

Returns the object with the settings used for calls to generateCredentials.

Returns
Type Description
UnaryCallSettings<GenerateCredentialsRequest,GenerateCredentialsResponse>

toBuilder()

public GatewayControlSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
GatewayControlSettings.Builder
Overrides