Package com.google.cloud.apihub.v1
Class ProvisioningSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<ProvisioningSettings>
com.google.cloud.apihub.v1.ProvisioningSettings
@Generated("by gapic-generator-java")
public class ProvisioningSettings
extends ClientSettings<ProvisioningSettings>
Settings class to configure an instance of
ProvisioningClient.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
ProvisioningSettings.Builder provisioningSettingsBuilder = ProvisioningSettings.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());
ProvisioningSettings provisioningSettings = provisioningSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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
ProvisioningSettings.Builder provisioningSettingsBuilder = ProvisioningSettings.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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ProvisioningSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedProvisioningSettings(ProvisioningSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final ProvisioningSettingsReturns the object with the settings used for calls to createApiHubInstance.Returns the object with the settings used for calls to createApiHubInstance.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteApiHubInstanceRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteApiHubInstance.Returns the object with the settings used for calls to deleteApiHubInstance.Returns the object with the settings used for calls to getApiHubInstance.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ProvisioningClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to lookupApiHubInstance.static ProvisioningSettings.BuilderReturns a new builder for this class.static ProvisioningSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a builder containing all the values of this settings class.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
ProvisioningSettings
- Throws:
IOException
-
-
Method Details
-
createApiHubInstanceSettings
Returns the object with the settings used for calls to createApiHubInstance. -
createApiHubInstanceOperationSettings
public OperationCallSettings<CreateApiHubInstanceRequest,ApiHubInstance, createApiHubInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createApiHubInstance. -
deleteApiHubInstanceSettings
Returns the object with the settings used for calls to deleteApiHubInstance. -
deleteApiHubInstanceOperationSettings
public OperationCallSettings<DeleteApiHubInstanceRequest,com.google.protobuf.Empty, deleteApiHubInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteApiHubInstance. -
getApiHubInstanceSettings
Returns the object with the settings used for calls to getApiHubInstance. -
lookupApiHubInstanceSettings
public UnaryCallSettings<LookupApiHubInstanceRequest,LookupApiHubInstanceResponse> lookupApiHubInstanceSettings()Returns the object with the settings used for calls to lookupApiHubInstance. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ProvisioningClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultHttpJsonTransportProviderBuilder
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<ProvisioningSettings>
-