Class InterceptStubSettings (0.94.0)

0.94.0 (latest) 0.91.0 0.90.0 0.88.0 0.86.0 0.85.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.75.0 0.73.0 0.71.0 0.70.0 0.67.0 0.66.0 0.65.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.4 0.5.1 0.4.4

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 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 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();
 

Inheritance

java.lang.Object > StubSettings > InterceptStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getLibraryMetadata()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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()

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

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 InterceptStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
InterceptStubSettings.Builder

newBuilder(ClientContext clientContext)

public static InterceptStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
InterceptStubSettings.Builder

Constructors

InterceptStubSettings(InterceptStubSettings.Builder settingsBuilder)

protected InterceptStubSettings(InterceptStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	InterceptStubSettings.Builder

Methods

createInterceptDeploymentGroupOperationSettings()

public OperationCallSettings<CreateInterceptDeploymentGroupRequest,InterceptDeploymentGroup,OperationMetadata> createInterceptDeploymentGroupOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateInterceptDeploymentGroupRequest,InterceptDeploymentGroup,OperationMetadata>

createInterceptDeploymentGroupSettings()

public UnaryCallSettings<CreateInterceptDeploymentGroupRequest,Operation> createInterceptDeploymentGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateInterceptDeploymentGroupRequest,Operation>

createInterceptDeploymentOperationSettings()

public OperationCallSettings<CreateInterceptDeploymentRequest,InterceptDeployment,OperationMetadata> createInterceptDeploymentOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateInterceptDeploymentRequest,InterceptDeployment,OperationMetadata>

createInterceptDeploymentSettings()

public UnaryCallSettings<CreateInterceptDeploymentRequest,Operation> createInterceptDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateInterceptDeploymentRequest,Operation>

createInterceptEndpointGroupAssociationOperationSettings()

public OperationCallSettings<CreateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation,OperationMetadata> createInterceptEndpointGroupAssociationOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation,OperationMetadata>

createInterceptEndpointGroupAssociationSettings()

public UnaryCallSettings<CreateInterceptEndpointGroupAssociationRequest,Operation> createInterceptEndpointGroupAssociationSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateInterceptEndpointGroupAssociationRequest,Operation>

createInterceptEndpointGroupOperationSettings()

public OperationCallSettings<CreateInterceptEndpointGroupRequest,InterceptEndpointGroup,OperationMetadata> createInterceptEndpointGroupOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateInterceptEndpointGroupRequest,InterceptEndpointGroup,OperationMetadata>

createInterceptEndpointGroupSettings()

public UnaryCallSettings<CreateInterceptEndpointGroupRequest,Operation> createInterceptEndpointGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateInterceptEndpointGroupRequest,Operation>

createStub()

public InterceptStub createStub()

Returns
Type	Description
InterceptStub

Exceptions
Type	Description
IOException

deleteInterceptDeploymentGroupOperationSettings()

public OperationCallSettings<DeleteInterceptDeploymentGroupRequest,Empty,OperationMetadata> deleteInterceptDeploymentGroupOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteInterceptDeploymentGroupRequest,Empty,OperationMetadata>

deleteInterceptDeploymentGroupSettings()

public UnaryCallSettings<DeleteInterceptDeploymentGroupRequest,Operation> deleteInterceptDeploymentGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteInterceptDeploymentGroupRequest,Operation>

deleteInterceptDeploymentOperationSettings()

public OperationCallSettings<DeleteInterceptDeploymentRequest,Empty,OperationMetadata> deleteInterceptDeploymentOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteInterceptDeploymentRequest,Empty,OperationMetadata>

deleteInterceptDeploymentSettings()

public UnaryCallSettings<DeleteInterceptDeploymentRequest,Operation> deleteInterceptDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteInterceptDeploymentRequest,Operation>

deleteInterceptEndpointGroupAssociationOperationSettings()

public OperationCallSettings<DeleteInterceptEndpointGroupAssociationRequest,Empty,OperationMetadata> deleteInterceptEndpointGroupAssociationOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteInterceptEndpointGroupAssociationRequest,Empty,OperationMetadata>

deleteInterceptEndpointGroupAssociationSettings()

public UnaryCallSettings<DeleteInterceptEndpointGroupAssociationRequest,Operation> deleteInterceptEndpointGroupAssociationSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteInterceptEndpointGroupAssociationRequest,Operation>

deleteInterceptEndpointGroupOperationSettings()

public OperationCallSettings<DeleteInterceptEndpointGroupRequest,Empty,OperationMetadata> deleteInterceptEndpointGroupOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteInterceptEndpointGroupRequest,Empty,OperationMetadata>

deleteInterceptEndpointGroupSettings()

public UnaryCallSettings<DeleteInterceptEndpointGroupRequest,Operation> deleteInterceptEndpointGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteInterceptEndpointGroupRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getInterceptDeploymentGroupSettings()

public UnaryCallSettings<GetInterceptDeploymentGroupRequest,InterceptDeploymentGroup> getInterceptDeploymentGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<GetInterceptDeploymentGroupRequest,InterceptDeploymentGroup>

getInterceptDeploymentSettings()

public UnaryCallSettings<GetInterceptDeploymentRequest,InterceptDeployment> getInterceptDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<GetInterceptDeploymentRequest,InterceptDeployment>

getInterceptEndpointGroupAssociationSettings()

public UnaryCallSettings<GetInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation> getInterceptEndpointGroupAssociationSettings()

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

Returns
Type	Description
UnaryCallSettings<GetInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation>

getInterceptEndpointGroupSettings()

public UnaryCallSettings<GetInterceptEndpointGroupRequest,InterceptEndpointGroup> getInterceptEndpointGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<GetInterceptEndpointGroupRequest,InterceptEndpointGroup>

getLibraryMetadata()

protected LibraryMetadata getLibraryMetadata()

Returns
Type	Description
LibraryMetadata

Overrides

StubSettings<SettingsT>.getLibraryMetadata()

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

StubSettings<SettingsT>.getServiceName()

listInterceptDeploymentGroupsSettings()

public PagedCallSettings<ListInterceptDeploymentGroupsRequest,ListInterceptDeploymentGroupsResponse,InterceptClient.ListInterceptDeploymentGroupsPagedResponse> listInterceptDeploymentGroupsSettings()

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

Returns
Type	Description
PagedCallSettings<ListInterceptDeploymentGroupsRequest,ListInterceptDeploymentGroupsResponse,ListInterceptDeploymentGroupsPagedResponse>

listInterceptDeploymentsSettings()

public PagedCallSettings<ListInterceptDeploymentsRequest,ListInterceptDeploymentsResponse,InterceptClient.ListInterceptDeploymentsPagedResponse> listInterceptDeploymentsSettings()

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

Returns
Type	Description
PagedCallSettings<ListInterceptDeploymentsRequest,ListInterceptDeploymentsResponse,ListInterceptDeploymentsPagedResponse>

listInterceptEndpointGroupAssociationsSettings()

public PagedCallSettings<ListInterceptEndpointGroupAssociationsRequest,ListInterceptEndpointGroupAssociationsResponse,InterceptClient.ListInterceptEndpointGroupAssociationsPagedResponse> listInterceptEndpointGroupAssociationsSettings()

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

Returns
Type	Description
PagedCallSettings<ListInterceptEndpointGroupAssociationsRequest,ListInterceptEndpointGroupAssociationsResponse,ListInterceptEndpointGroupAssociationsPagedResponse>

listInterceptEndpointGroupsSettings()

public PagedCallSettings<ListInterceptEndpointGroupsRequest,ListInterceptEndpointGroupsResponse,InterceptClient.ListInterceptEndpointGroupsPagedResponse> listInterceptEndpointGroupsSettings()

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

Returns
Type	Description
PagedCallSettings<ListInterceptEndpointGroupsRequest,ListInterceptEndpointGroupsResponse,ListInterceptEndpointGroupsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,InterceptClient.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>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public InterceptStubSettings.Builder toBuilder()

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

Returns
Type	Description
InterceptStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateInterceptDeploymentGroupOperationSettings()

public OperationCallSettings<UpdateInterceptDeploymentGroupRequest,InterceptDeploymentGroup,OperationMetadata> updateInterceptDeploymentGroupOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateInterceptDeploymentGroupRequest,InterceptDeploymentGroup,OperationMetadata>

updateInterceptDeploymentGroupSettings()

public UnaryCallSettings<UpdateInterceptDeploymentGroupRequest,Operation> updateInterceptDeploymentGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateInterceptDeploymentGroupRequest,Operation>

updateInterceptDeploymentOperationSettings()

public OperationCallSettings<UpdateInterceptDeploymentRequest,InterceptDeployment,OperationMetadata> updateInterceptDeploymentOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateInterceptDeploymentRequest,InterceptDeployment,OperationMetadata>

updateInterceptDeploymentSettings()

public UnaryCallSettings<UpdateInterceptDeploymentRequest,Operation> updateInterceptDeploymentSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateInterceptDeploymentRequest,Operation>

updateInterceptEndpointGroupAssociationOperationSettings()

public OperationCallSettings<UpdateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation,OperationMetadata> updateInterceptEndpointGroupAssociationOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateInterceptEndpointGroupAssociationRequest,InterceptEndpointGroupAssociation,OperationMetadata>

updateInterceptEndpointGroupAssociationSettings()

public UnaryCallSettings<UpdateInterceptEndpointGroupAssociationRequest,Operation> updateInterceptEndpointGroupAssociationSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateInterceptEndpointGroupAssociationRequest,Operation>

updateInterceptEndpointGroupOperationSettings()

public OperationCallSettings<UpdateInterceptEndpointGroupRequest,InterceptEndpointGroup,OperationMetadata> updateInterceptEndpointGroupOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateInterceptEndpointGroupRequest,InterceptEndpointGroup,OperationMetadata>

updateInterceptEndpointGroupSettings()

public UnaryCallSettings<UpdateInterceptEndpointGroupRequest,Operation> updateInterceptEndpointGroupSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateInterceptEndpointGroupRequest,Operation>