Class InterceptSettings (0.94.0)

public class InterceptSettings extends ClientSettings<InterceptSettings>

Settings class to configure an instance of InterceptClient.

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
 InterceptSettings.Builder interceptSettingsBuilder = InterceptSettings.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());
 InterceptSettings 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
 InterceptSettings.Builder interceptSettingsBuilder = InterceptSettings.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 > ClientSettings > InterceptSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(InterceptStubSettings stub)

public static final InterceptSettings create(InterceptStubSettings stub)

Parameter
Name	Description
`stub`	`InterceptStubSettings`

Returns
Type	Description
`InterceptSettings`

Exceptions
Type	Description
`IOException`

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

Returns the default 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 InterceptSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
`InterceptSettings.Builder`

newBuilder(ClientContext clientContext)

public static InterceptSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`InterceptSettings.Builder`

Constructors

InterceptSettings(InterceptSettings.Builder settingsBuilder)

protected InterceptSettings(InterceptSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`InterceptSettings.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>`

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>`

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>`

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 InterceptSettings.Builder toBuilder()

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

Returns
Type	Description
`InterceptSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>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()