Class HubServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<HubServiceStubSettings>
com.google.cloud.networkconnectivity.v1alpha1.stub.HubServiceStubSettings
@BetaApi
@Generated("by gapic-generator-java")
public class HubServiceStubSettings
extends StubSettings<HubServiceStubSettings>
Settings class to configure an instance of
HubServiceStub.
The default instance has everything set to sensible defaults:
- The default service address (networkconnectivity.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 getHub:
// 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
HubServiceStubSettings.Builder hubServiceSettingsBuilder = HubServiceStubSettings.newBuilder();
hubServiceSettingsBuilder
.getHubSettings()
.setRetrySettings(
hubServiceSettingsBuilder
.getHubSettings()
.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());
HubServiceStubSettings hubServiceSettings = hubServiceSettingsBuilder.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 createHub:
// 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
HubServiceStubSettings.Builder hubServiceSettingsBuilder = HubServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
hubServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for HubServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedHubServiceStubSettings(HubServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createHub.Returns the object with the settings used for calls to createHub.Returns the object with the settings used for calls to createSpoke.Returns the object with the settings used for calls to createSpoke.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<DeleteHubRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteHub.Returns the object with the settings used for calls to deleteHub.OperationCallSettings<DeleteSpokeRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteSpoke.Returns the object with the settings used for calls to deleteSpoke.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getHub.protected LibraryMetadataReturns the default service name.Returns the object with the settings used for calls to getSpoke.Returns the object with the settings used for calls to listHubs.Returns the object with the settings used for calls to listSpokes.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateHub.Returns the object with the settings used for calls to updateHub.Returns the object with the settings used for calls to updateSpoke.Returns the object with the settings used for calls to updateSpoke.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
HubServiceStubSettings
- Throws:
IOException
-
-
Method Details
-
listHubsSettings
public PagedCallSettings<ListHubsRequest,ListHubsResponse, listHubsSettings()HubServiceClient.ListHubsPagedResponse> Returns the object with the settings used for calls to listHubs. -
getHubSettings
Returns the object with the settings used for calls to getHub. -
createHubSettings
Returns the object with the settings used for calls to createHub. -
createHubOperationSettings
Returns the object with the settings used for calls to createHub. -
updateHubSettings
Returns the object with the settings used for calls to updateHub. -
updateHubOperationSettings
Returns the object with the settings used for calls to updateHub. -
deleteHubSettings
Returns the object with the settings used for calls to deleteHub. -
deleteHubOperationSettings
public OperationCallSettings<DeleteHubRequest,com.google.protobuf.Empty, deleteHubOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteHub. -
listSpokesSettings
public PagedCallSettings<ListSpokesRequest,ListSpokesResponse, listSpokesSettings()HubServiceClient.ListSpokesPagedResponse> Returns the object with the settings used for calls to listSpokes. -
getSpokeSettings
Returns the object with the settings used for calls to getSpoke. -
createSpokeSettings
Returns the object with the settings used for calls to createSpoke. -
createSpokeOperationSettings
public OperationCallSettings<CreateSpokeRequest,Spoke, createSpokeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createSpoke. -
updateSpokeSettings
Returns the object with the settings used for calls to updateSpoke. -
updateSpokeOperationSettings
public OperationCallSettings<UpdateSpokeRequest,Spoke, updateSpokeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateSpoke. -
deleteSpokeSettings
Returns the object with the settings used for calls to deleteSpoke. -
deleteSpokeOperationSettings
public OperationCallSettings<DeleteSpokeRequest,com.google.protobuf.Empty, deleteSpokeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteSpoke. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<HubServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
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 classStubSettings<HubServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<HubServiceStubSettings>
-