Class ProvisioningStubSettings (0.8.0) 

public class ProvisioningStubSettings extends StubSettings<ProvisioningStubSettings>

Settings class to configure an instance of ProvisioningStub.

The default instance has everything set to sensible defaults:

  • The default service address (apihub.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 getApiHubInstance:


 // 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
 ProvisioningStubSettings.Builder provisioningSettingsBuilder =
     ProvisioningStubSettings.newBuilder();
 provisioningSettingsBuilder
     .getApiHubInstanceSettings()
     .setRetrySettings(
         provisioningSettingsBuilder
             .getApiHubInstanceSettings()
             .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());
 ProvisioningStubSettings provisioningSettings = provisioningSettingsBuilder.build();

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

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createApiHubInstance:


 // 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
 ProvisioningStubSettings.Builder provisioningSettingsBuilder =
     ProvisioningStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 provisioningSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > ProvisioningStubSettings

Static Methods

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

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 ProvisioningStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
ProvisioningStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ProvisioningStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ProvisioningStubSettings.Builder

Constructors

ProvisioningStubSettings(ProvisioningStubSettings.Builder settingsBuilder)

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

Methods

createApiHubInstanceOperationSettings()

public OperationCallSettings<CreateApiHubInstanceRequest,ApiHubInstance,OperationMetadata> createApiHubInstanceOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateApiHubInstanceRequest,ApiHubInstance,OperationMetadata>

createApiHubInstanceSettings()

public UnaryCallSettings<CreateApiHubInstanceRequest,Operation> createApiHubInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<CreateApiHubInstanceRequest,Operation>

createStub()

public ProvisioningStub createStub()
Returns
Type Description
ProvisioningStub
Exceptions
Type Description
IOException

getApiHubInstanceSettings()

public UnaryCallSettings<GetApiHubInstanceRequest,ApiHubInstance> getApiHubInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<GetApiHubInstanceRequest,ApiHubInstance>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ProvisioningClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

lookupApiHubInstanceSettings()

public UnaryCallSettings<LookupApiHubInstanceRequest,LookupApiHubInstanceResponse> lookupApiHubInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<LookupApiHubInstanceRequest,LookupApiHubInstanceResponse>

toBuilder()

public ProvisioningStubSettings.Builder toBuilder()

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

Returns
Type Description
ProvisioningStubSettings.Builder
Overrides