Class InterceptStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<InterceptStubSettings>
com.google.cloud.networksecurity.v1.stub.InterceptStubSettings
@Generated("by gapic-generator-java")
public class InterceptStubSettings
extends StubSettings<InterceptStubSettings>
Settings class to configure an instance of
InterceptStub.
The default instance has everything set to sensible defaults:
- The default service address (networksecurity.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 getInterceptEndpointGroup:
// 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
InterceptStubSettings.Builder interceptSettingsBuilder = InterceptStubSettings.newBuilder();
interceptSettingsBuilder
.getInterceptEndpointGroupSettings()
.setRetrySettings(
interceptSettingsBuilder
.getInterceptEndpointGroupSettings()
.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());
InterceptStubSettings interceptSettings = interceptSettingsBuilder.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 createInterceptEndpointGroup:
// 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
InterceptStubSettings.Builder interceptSettingsBuilder = InterceptStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
interceptSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for InterceptStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedInterceptStubSettings(InterceptStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<CreateInterceptDeploymentGroupRequest,InterceptDeploymentGroup, OperationMetadata> Returns the object with the settings used for calls to createInterceptDeploymentGroup.Returns the object with the settings used for calls to createInterceptDeploymentGroup.Returns the object with the settings used for calls to createInterceptDeployment.Returns the object with the settings used for calls to createInterceptDeployment.OperationCallSettings<CreateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation, OperationMetadata> Returns the object with the settings used for calls to createInterceptEndpointGroupAssociation.Returns the object with the settings used for calls to createInterceptEndpointGroupAssociation.Returns the object with the settings used for calls to createInterceptEndpointGroup.Returns the object with the settings used for calls to createInterceptEndpointGroup.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<DeleteInterceptDeploymentGroupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteInterceptDeploymentGroup.Returns the object with the settings used for calls to deleteInterceptDeploymentGroup.OperationCallSettings<DeleteInterceptDeploymentRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteInterceptDeployment.Returns the object with the settings used for calls to deleteInterceptDeployment.OperationCallSettings<DeleteInterceptEndpointGroupAssociationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteInterceptEndpointGroupAssociation.Returns the object with the settings used for calls to deleteInterceptEndpointGroupAssociation.OperationCallSettings<DeleteInterceptEndpointGroupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteInterceptEndpointGroup.Returns the object with the settings used for calls to deleteInterceptEndpointGroup.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.Returns the object with the settings used for calls to getInterceptDeploymentGroup.Returns the object with the settings used for calls to getInterceptDeployment.Returns the object with the settings used for calls to getInterceptEndpointGroupAssociation.Returns the object with the settings used for calls to getInterceptEndpointGroup.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.PagedCallSettings<ListInterceptDeploymentGroupsRequest,ListInterceptDeploymentGroupsResponse, InterceptClient.ListInterceptDeploymentGroupsPagedResponse> Returns the object with the settings used for calls to listInterceptDeploymentGroups.PagedCallSettings<ListInterceptDeploymentsRequest,ListInterceptDeploymentsResponse, InterceptClient.ListInterceptDeploymentsPagedResponse> Returns the object with the settings used for calls to listInterceptDeployments.PagedCallSettings<ListInterceptEndpointGroupAssociationsRequest,ListInterceptEndpointGroupAssociationsResponse, InterceptClient.ListInterceptEndpointGroupAssociationsPagedResponse> Returns the object with the settings used for calls to listInterceptEndpointGroupAssociations.PagedCallSettings<ListInterceptEndpointGroupsRequest,ListInterceptEndpointGroupsResponse, InterceptClient.ListInterceptEndpointGroupsPagedResponse> Returns the object with the settings used for calls to listInterceptEndpointGroups.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, InterceptClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.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.OperationCallSettings<UpdateInterceptDeploymentGroupRequest,InterceptDeploymentGroup, OperationMetadata> Returns the object with the settings used for calls to updateInterceptDeploymentGroup.Returns the object with the settings used for calls to updateInterceptDeploymentGroup.Returns the object with the settings used for calls to updateInterceptDeployment.Returns the object with the settings used for calls to updateInterceptDeployment.OperationCallSettings<UpdateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation, OperationMetadata> Returns the object with the settings used for calls to updateInterceptEndpointGroupAssociation.Returns the object with the settings used for calls to updateInterceptEndpointGroupAssociation.Returns the object with the settings used for calls to updateInterceptEndpointGroup.Returns the object with the settings used for calls to updateInterceptEndpointGroup.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
-
InterceptStubSettings
- Throws:
IOException
-
-
Method Details
-
listInterceptEndpointGroupsSettings
public PagedCallSettings<ListInterceptEndpointGroupsRequest,ListInterceptEndpointGroupsResponse, listInterceptEndpointGroupsSettings()InterceptClient.ListInterceptEndpointGroupsPagedResponse> Returns the object with the settings used for calls to listInterceptEndpointGroups. -
getInterceptEndpointGroupSettings
public UnaryCallSettings<GetInterceptEndpointGroupRequest,InterceptEndpointGroup> getInterceptEndpointGroupSettings()Returns the object with the settings used for calls to getInterceptEndpointGroup. -
createInterceptEndpointGroupSettings
public UnaryCallSettings<CreateInterceptEndpointGroupRequest,Operation> createInterceptEndpointGroupSettings()Returns the object with the settings used for calls to createInterceptEndpointGroup. -
createInterceptEndpointGroupOperationSettings
public OperationCallSettings<CreateInterceptEndpointGroupRequest,InterceptEndpointGroup, createInterceptEndpointGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createInterceptEndpointGroup. -
updateInterceptEndpointGroupSettings
public UnaryCallSettings<UpdateInterceptEndpointGroupRequest,Operation> updateInterceptEndpointGroupSettings()Returns the object with the settings used for calls to updateInterceptEndpointGroup. -
updateInterceptEndpointGroupOperationSettings
public OperationCallSettings<UpdateInterceptEndpointGroupRequest,InterceptEndpointGroup, updateInterceptEndpointGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateInterceptEndpointGroup. -
deleteInterceptEndpointGroupSettings
public UnaryCallSettings<DeleteInterceptEndpointGroupRequest,Operation> deleteInterceptEndpointGroupSettings()Returns the object with the settings used for calls to deleteInterceptEndpointGroup. -
deleteInterceptEndpointGroupOperationSettings
public OperationCallSettings<DeleteInterceptEndpointGroupRequest,com.google.protobuf.Empty, deleteInterceptEndpointGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteInterceptEndpointGroup. -
listInterceptEndpointGroupAssociationsSettings
public PagedCallSettings<ListInterceptEndpointGroupAssociationsRequest,ListInterceptEndpointGroupAssociationsResponse, listInterceptEndpointGroupAssociationsSettings()InterceptClient.ListInterceptEndpointGroupAssociationsPagedResponse> Returns the object with the settings used for calls to listInterceptEndpointGroupAssociations. -
getInterceptEndpointGroupAssociationSettings
public UnaryCallSettings<GetInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation> getInterceptEndpointGroupAssociationSettings()Returns the object with the settings used for calls to getInterceptEndpointGroupAssociation. -
createInterceptEndpointGroupAssociationSettings
public UnaryCallSettings<CreateInterceptEndpointGroupAssociationRequest,Operation> createInterceptEndpointGroupAssociationSettings()Returns the object with the settings used for calls to createInterceptEndpointGroupAssociation. -
createInterceptEndpointGroupAssociationOperationSettings
public OperationCallSettings<CreateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation, createInterceptEndpointGroupAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createInterceptEndpointGroupAssociation. -
updateInterceptEndpointGroupAssociationSettings
public UnaryCallSettings<UpdateInterceptEndpointGroupAssociationRequest,Operation> updateInterceptEndpointGroupAssociationSettings()Returns the object with the settings used for calls to updateInterceptEndpointGroupAssociation. -
updateInterceptEndpointGroupAssociationOperationSettings
public OperationCallSettings<UpdateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation, updateInterceptEndpointGroupAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateInterceptEndpointGroupAssociation. -
deleteInterceptEndpointGroupAssociationSettings
public UnaryCallSettings<DeleteInterceptEndpointGroupAssociationRequest,Operation> deleteInterceptEndpointGroupAssociationSettings()Returns the object with the settings used for calls to deleteInterceptEndpointGroupAssociation. -
deleteInterceptEndpointGroupAssociationOperationSettings
public OperationCallSettings<DeleteInterceptEndpointGroupAssociationRequest,com.google.protobuf.Empty, deleteInterceptEndpointGroupAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteInterceptEndpointGroupAssociation. -
listInterceptDeploymentGroupsSettings
public PagedCallSettings<ListInterceptDeploymentGroupsRequest,ListInterceptDeploymentGroupsResponse, listInterceptDeploymentGroupsSettings()InterceptClient.ListInterceptDeploymentGroupsPagedResponse> Returns the object with the settings used for calls to listInterceptDeploymentGroups. -
getInterceptDeploymentGroupSettings
public UnaryCallSettings<GetInterceptDeploymentGroupRequest,InterceptDeploymentGroup> getInterceptDeploymentGroupSettings()Returns the object with the settings used for calls to getInterceptDeploymentGroup. -
createInterceptDeploymentGroupSettings
public UnaryCallSettings<CreateInterceptDeploymentGroupRequest,Operation> createInterceptDeploymentGroupSettings()Returns the object with the settings used for calls to createInterceptDeploymentGroup. -
createInterceptDeploymentGroupOperationSettings
public OperationCallSettings<CreateInterceptDeploymentGroupRequest,InterceptDeploymentGroup, createInterceptDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createInterceptDeploymentGroup. -
updateInterceptDeploymentGroupSettings
public UnaryCallSettings<UpdateInterceptDeploymentGroupRequest,Operation> updateInterceptDeploymentGroupSettings()Returns the object with the settings used for calls to updateInterceptDeploymentGroup. -
updateInterceptDeploymentGroupOperationSettings
public OperationCallSettings<UpdateInterceptDeploymentGroupRequest,InterceptDeploymentGroup, updateInterceptDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateInterceptDeploymentGroup. -
deleteInterceptDeploymentGroupSettings
public UnaryCallSettings<DeleteInterceptDeploymentGroupRequest,Operation> deleteInterceptDeploymentGroupSettings()Returns the object with the settings used for calls to deleteInterceptDeploymentGroup. -
deleteInterceptDeploymentGroupOperationSettings
public OperationCallSettings<DeleteInterceptDeploymentGroupRequest,com.google.protobuf.Empty, deleteInterceptDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteInterceptDeploymentGroup. -
listInterceptDeploymentsSettings
public PagedCallSettings<ListInterceptDeploymentsRequest,ListInterceptDeploymentsResponse, listInterceptDeploymentsSettings()InterceptClient.ListInterceptDeploymentsPagedResponse> Returns the object with the settings used for calls to listInterceptDeployments. -
getInterceptDeploymentSettings
public UnaryCallSettings<GetInterceptDeploymentRequest,InterceptDeployment> getInterceptDeploymentSettings()Returns the object with the settings used for calls to getInterceptDeployment. -
createInterceptDeploymentSettings
public UnaryCallSettings<CreateInterceptDeploymentRequest,Operation> createInterceptDeploymentSettings()Returns the object with the settings used for calls to createInterceptDeployment. -
createInterceptDeploymentOperationSettings
public OperationCallSettings<CreateInterceptDeploymentRequest,InterceptDeployment, createInterceptDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createInterceptDeployment. -
updateInterceptDeploymentSettings
public UnaryCallSettings<UpdateInterceptDeploymentRequest,Operation> updateInterceptDeploymentSettings()Returns the object with the settings used for calls to updateInterceptDeployment. -
updateInterceptDeploymentOperationSettings
public OperationCallSettings<UpdateInterceptDeploymentRequest,InterceptDeployment, updateInterceptDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateInterceptDeployment. -
deleteInterceptDeploymentSettings
public UnaryCallSettings<DeleteInterceptDeploymentRequest,Operation> deleteInterceptDeploymentSettings()Returns the object with the settings used for calls to deleteInterceptDeployment. -
deleteInterceptDeploymentOperationSettings
public OperationCallSettings<DeleteInterceptDeploymentRequest,com.google.protobuf.Empty, deleteInterceptDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteInterceptDeployment. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()InterceptClient.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<InterceptStubSettings>
-
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<InterceptStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<InterceptStubSettings>
-