Class CrossNetworkAutomationServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<CrossNetworkAutomationServiceStubSettings>
com.google.cloud.networkconnectivity.v1.stub.CrossNetworkAutomationServiceStubSettings
@Generated("by gapic-generator-java")
public class CrossNetworkAutomationServiceStubSettings
extends StubSettings<CrossNetworkAutomationServiceStubSettings>
Settings class to configure an instance of
CrossNetworkAutomationServiceStub.
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 getServiceConnectionMap:
// 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
CrossNetworkAutomationServiceStubSettings.Builder crossNetworkAutomationServiceSettingsBuilder =
CrossNetworkAutomationServiceStubSettings.newBuilder();
crossNetworkAutomationServiceSettingsBuilder
.getServiceConnectionMapSettings()
.setRetrySettings(
crossNetworkAutomationServiceSettingsBuilder
.getServiceConnectionMapSettings()
.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());
CrossNetworkAutomationServiceStubSettings crossNetworkAutomationServiceSettings =
crossNetworkAutomationServiceSettingsBuilder.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 createServiceConnectionMap:
// 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
CrossNetworkAutomationServiceStubSettings.Builder crossNetworkAutomationServiceSettingsBuilder =
CrossNetworkAutomationServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
crossNetworkAutomationServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CrossNetworkAutomationServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCrossNetworkAutomationServiceStubSettings(CrossNetworkAutomationServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createServiceConnectionMap.Returns the object with the settings used for calls to createServiceConnectionMap.OperationCallSettings<CreateServiceConnectionPolicyRequest,ServiceConnectionPolicy, OperationMetadata> Returns the object with the settings used for calls to createServiceConnectionPolicy.Returns the object with the settings used for calls to createServiceConnectionPolicy.Returns the object with the settings used for calls to createServiceConnectionToken.Returns the object with the settings used for calls to createServiceConnectionToken.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<DeleteServiceClassRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteServiceClass.Returns the object with the settings used for calls to deleteServiceClass.OperationCallSettings<DeleteServiceConnectionMapRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteServiceConnectionMap.Returns the object with the settings used for calls to deleteServiceConnectionMap.OperationCallSettings<DeleteServiceConnectionPolicyRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteServiceConnectionPolicy.Returns the object with the settings used for calls to deleteServiceConnectionPolicy.OperationCallSettings<DeleteServiceConnectionTokenRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteServiceConnectionToken.Returns the object with the settings used for calls to deleteServiceConnectionToken.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 getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getServiceClass.Returns the object with the settings used for calls to getServiceConnectionMap.Returns the object with the settings used for calls to getServiceConnectionPolicy.Returns the object with the settings used for calls to getServiceConnectionToken.Returns the default service name.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, CrossNetworkAutomationServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListServiceClassesRequest,ListServiceClassesResponse, CrossNetworkAutomationServiceClient.ListServiceClassesPagedResponse> Returns the object with the settings used for calls to listServiceClasses.PagedCallSettings<ListServiceConnectionMapsRequest,ListServiceConnectionMapsResponse, CrossNetworkAutomationServiceClient.ListServiceConnectionMapsPagedResponse> Returns the object with the settings used for calls to listServiceConnectionMaps.PagedCallSettings<ListServiceConnectionPoliciesRequest,ListServiceConnectionPoliciesResponse, CrossNetworkAutomationServiceClient.ListServiceConnectionPoliciesPagedResponse> Returns the object with the settings used for calls to listServiceConnectionPolicies.PagedCallSettings<ListServiceConnectionTokensRequest,ListServiceConnectionTokensResponse, CrossNetworkAutomationServiceClient.ListServiceConnectionTokensPagedResponse> Returns the object with the settings used for calls to listServiceConnectionTokens.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateServiceClass.Returns the object with the settings used for calls to updateServiceClass.Returns the object with the settings used for calls to updateServiceConnectionMap.Returns the object with the settings used for calls to updateServiceConnectionMap.OperationCallSettings<UpdateServiceConnectionPolicyRequest,ServiceConnectionPolicy, OperationMetadata> Returns the object with the settings used for calls to updateServiceConnectionPolicy.Returns the object with the settings used for calls to updateServiceConnectionPolicy.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
-
CrossNetworkAutomationServiceStubSettings
protected CrossNetworkAutomationServiceStubSettings(CrossNetworkAutomationServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listServiceConnectionMapsSettings
public PagedCallSettings<ListServiceConnectionMapsRequest,ListServiceConnectionMapsResponse, listServiceConnectionMapsSettings()CrossNetworkAutomationServiceClient.ListServiceConnectionMapsPagedResponse> Returns the object with the settings used for calls to listServiceConnectionMaps. -
getServiceConnectionMapSettings
public UnaryCallSettings<GetServiceConnectionMapRequest,ServiceConnectionMap> getServiceConnectionMapSettings()Returns the object with the settings used for calls to getServiceConnectionMap. -
createServiceConnectionMapSettings
public UnaryCallSettings<CreateServiceConnectionMapRequest,Operation> createServiceConnectionMapSettings()Returns the object with the settings used for calls to createServiceConnectionMap. -
createServiceConnectionMapOperationSettings
public OperationCallSettings<CreateServiceConnectionMapRequest,ServiceConnectionMap, createServiceConnectionMapOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createServiceConnectionMap. -
updateServiceConnectionMapSettings
public UnaryCallSettings<UpdateServiceConnectionMapRequest,Operation> updateServiceConnectionMapSettings()Returns the object with the settings used for calls to updateServiceConnectionMap. -
updateServiceConnectionMapOperationSettings
public OperationCallSettings<UpdateServiceConnectionMapRequest,ServiceConnectionMap, updateServiceConnectionMapOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateServiceConnectionMap. -
deleteServiceConnectionMapSettings
public UnaryCallSettings<DeleteServiceConnectionMapRequest,Operation> deleteServiceConnectionMapSettings()Returns the object with the settings used for calls to deleteServiceConnectionMap. -
deleteServiceConnectionMapOperationSettings
public OperationCallSettings<DeleteServiceConnectionMapRequest,com.google.protobuf.Empty, deleteServiceConnectionMapOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteServiceConnectionMap. -
listServiceConnectionPoliciesSettings
public PagedCallSettings<ListServiceConnectionPoliciesRequest,ListServiceConnectionPoliciesResponse, listServiceConnectionPoliciesSettings()CrossNetworkAutomationServiceClient.ListServiceConnectionPoliciesPagedResponse> Returns the object with the settings used for calls to listServiceConnectionPolicies. -
getServiceConnectionPolicySettings
public UnaryCallSettings<GetServiceConnectionPolicyRequest,ServiceConnectionPolicy> getServiceConnectionPolicySettings()Returns the object with the settings used for calls to getServiceConnectionPolicy. -
createServiceConnectionPolicySettings
public UnaryCallSettings<CreateServiceConnectionPolicyRequest,Operation> createServiceConnectionPolicySettings()Returns the object with the settings used for calls to createServiceConnectionPolicy. -
createServiceConnectionPolicyOperationSettings
public OperationCallSettings<CreateServiceConnectionPolicyRequest,ServiceConnectionPolicy, createServiceConnectionPolicyOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createServiceConnectionPolicy. -
updateServiceConnectionPolicySettings
public UnaryCallSettings<UpdateServiceConnectionPolicyRequest,Operation> updateServiceConnectionPolicySettings()Returns the object with the settings used for calls to updateServiceConnectionPolicy. -
updateServiceConnectionPolicyOperationSettings
public OperationCallSettings<UpdateServiceConnectionPolicyRequest,ServiceConnectionPolicy, updateServiceConnectionPolicyOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateServiceConnectionPolicy. -
deleteServiceConnectionPolicySettings
public UnaryCallSettings<DeleteServiceConnectionPolicyRequest,Operation> deleteServiceConnectionPolicySettings()Returns the object with the settings used for calls to deleteServiceConnectionPolicy. -
deleteServiceConnectionPolicyOperationSettings
public OperationCallSettings<DeleteServiceConnectionPolicyRequest,com.google.protobuf.Empty, deleteServiceConnectionPolicyOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteServiceConnectionPolicy. -
listServiceClassesSettings
public PagedCallSettings<ListServiceClassesRequest,ListServiceClassesResponse, listServiceClassesSettings()CrossNetworkAutomationServiceClient.ListServiceClassesPagedResponse> Returns the object with the settings used for calls to listServiceClasses. -
getServiceClassSettings
Returns the object with the settings used for calls to getServiceClass. -
updateServiceClassSettings
Returns the object with the settings used for calls to updateServiceClass. -
updateServiceClassOperationSettings
public OperationCallSettings<UpdateServiceClassRequest,ServiceClass, updateServiceClassOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateServiceClass. -
deleteServiceClassSettings
Returns the object with the settings used for calls to deleteServiceClass. -
deleteServiceClassOperationSettings
public OperationCallSettings<DeleteServiceClassRequest,com.google.protobuf.Empty, deleteServiceClassOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteServiceClass. -
getServiceConnectionTokenSettings
public UnaryCallSettings<GetServiceConnectionTokenRequest,ServiceConnectionToken> getServiceConnectionTokenSettings()Returns the object with the settings used for calls to getServiceConnectionToken. -
listServiceConnectionTokensSettings
public PagedCallSettings<ListServiceConnectionTokensRequest,ListServiceConnectionTokensResponse, listServiceConnectionTokensSettings()CrossNetworkAutomationServiceClient.ListServiceConnectionTokensPagedResponse> Returns the object with the settings used for calls to listServiceConnectionTokens. -
createServiceConnectionTokenSettings
public UnaryCallSettings<CreateServiceConnectionTokenRequest,Operation> createServiceConnectionTokenSettings()Returns the object with the settings used for calls to createServiceConnectionToken. -
createServiceConnectionTokenOperationSettings
public OperationCallSettings<CreateServiceConnectionTokenRequest,ServiceConnectionToken, createServiceConnectionTokenOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createServiceConnectionToken. -
deleteServiceConnectionTokenSettings
public UnaryCallSettings<DeleteServiceConnectionTokenRequest,Operation> deleteServiceConnectionTokenSettings()Returns the object with the settings used for calls to deleteServiceConnectionToken. -
deleteServiceConnectionTokenOperationSettings
public OperationCallSettings<DeleteServiceConnectionTokenRequest,com.google.protobuf.Empty, deleteServiceConnectionTokenOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteServiceConnectionToken. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()CrossNetworkAutomationServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<CrossNetworkAutomationServiceStubSettings>
-
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
public static CrossNetworkAutomationServiceStubSettings.Builder newBuilder(ClientContext clientContext) Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<CrossNetworkAutomationServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<CrossNetworkAutomationServiceStubSettings>
-