Class AccessContextManagerSettings (1.58.0) 

public class AccessContextManagerSettings extends ClientSettings<AccessContextManagerSettings>

Settings class to configure an instance of AccessContextManagerClient.

The default instance has everything set to sensible defaults:

  • The default service address (accesscontextmanager.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 getAccessPolicy:


 // 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
 AccessContextManagerSettings.Builder accessContextManagerSettingsBuilder =
     AccessContextManagerSettings.newBuilder();
 accessContextManagerSettingsBuilder
     .getAccessPolicySettings()
     .setRetrySettings(
         accessContextManagerSettingsBuilder
             .getAccessPolicySettings()
             .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());
 AccessContextManagerSettings accessContextManagerSettings =
     accessContextManagerSettingsBuilder.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 createAccessPolicy:


 // 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
 AccessContextManagerSettings.Builder accessContextManagerSettingsBuilder =
     AccessContextManagerSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 accessContextManagerSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > AccessContextManagerSettings

Static Methods

create(AccessContextManagerStubSettings stub)

public static final AccessContextManagerSettings create(AccessContextManagerStubSettings stub)
Parameter
Name Description
stub AccessContextManagerStubSettings
Returns
Type Description
AccessContextManagerSettings
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 gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 AccessContextManagerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
AccessContextManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static AccessContextManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
AccessContextManagerSettings.Builder

newHttpJsonBuilder()

public static AccessContextManagerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
AccessContextManagerSettings.Builder

Constructors

AccessContextManagerSettings(AccessContextManagerSettings.Builder settingsBuilder)

protected AccessContextManagerSettings(AccessContextManagerSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder AccessContextManagerSettings.Builder

Methods

commitServicePerimetersOperationSettings()

public OperationCallSettings<CommitServicePerimetersRequest,CommitServicePerimetersResponse,AccessContextManagerOperationMetadata> commitServicePerimetersOperationSettings()

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

Returns
Type Description
OperationCallSettings<CommitServicePerimetersRequest,CommitServicePerimetersResponse,AccessContextManagerOperationMetadata>

commitServicePerimetersSettings()

public UnaryCallSettings<CommitServicePerimetersRequest,Operation> commitServicePerimetersSettings()

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

Returns
Type Description
UnaryCallSettings<CommitServicePerimetersRequest,Operation>

createAccessLevelOperationSettings()

public OperationCallSettings<CreateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata> createAccessLevelOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata>

createAccessLevelSettings()

public UnaryCallSettings<CreateAccessLevelRequest,Operation> createAccessLevelSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAccessLevelRequest,Operation>

createAccessPolicyOperationSettings()

public OperationCallSettings<AccessPolicy,AccessPolicy,AccessContextManagerOperationMetadata> createAccessPolicyOperationSettings()

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

Returns
Type Description
OperationCallSettings<AccessPolicy,AccessPolicy,AccessContextManagerOperationMetadata>

createAccessPolicySettings()

public UnaryCallSettings<AccessPolicy,Operation> createAccessPolicySettings()

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

Returns
Type Description
UnaryCallSettings<AccessPolicy,Operation>

createGcpUserAccessBindingOperationSettings()

public OperationCallSettings<CreateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> createGcpUserAccessBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

createGcpUserAccessBindingSettings()

public UnaryCallSettings<CreateGcpUserAccessBindingRequest,Operation> createGcpUserAccessBindingSettings()

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

Returns
Type Description
UnaryCallSettings<CreateGcpUserAccessBindingRequest,Operation>

createServicePerimeterOperationSettings()

public OperationCallSettings<CreateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata> createServicePerimeterOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata>

createServicePerimeterSettings()

public UnaryCallSettings<CreateServicePerimeterRequest,Operation> createServicePerimeterSettings()

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

Returns
Type Description
UnaryCallSettings<CreateServicePerimeterRequest,Operation>

deleteAccessLevelOperationSettings()

public OperationCallSettings<DeleteAccessLevelRequest,Empty,AccessContextManagerOperationMetadata> deleteAccessLevelOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteAccessLevelRequest,Empty,AccessContextManagerOperationMetadata>

deleteAccessLevelSettings()

public UnaryCallSettings<DeleteAccessLevelRequest,Operation> deleteAccessLevelSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAccessLevelRequest,Operation>

deleteAccessPolicyOperationSettings()

public OperationCallSettings<DeleteAccessPolicyRequest,Empty,AccessContextManagerOperationMetadata> deleteAccessPolicyOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteAccessPolicyRequest,Empty,AccessContextManagerOperationMetadata>

deleteAccessPolicySettings()

public UnaryCallSettings<DeleteAccessPolicyRequest,Operation> deleteAccessPolicySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAccessPolicyRequest,Operation>

deleteGcpUserAccessBindingOperationSettings()

public OperationCallSettings<DeleteGcpUserAccessBindingRequest,Empty,GcpUserAccessBindingOperationMetadata> deleteGcpUserAccessBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteGcpUserAccessBindingRequest,Empty,GcpUserAccessBindingOperationMetadata>

deleteGcpUserAccessBindingSettings()

public UnaryCallSettings<DeleteGcpUserAccessBindingRequest,Operation> deleteGcpUserAccessBindingSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteGcpUserAccessBindingRequest,Operation>

deleteServicePerimeterOperationSettings()

public OperationCallSettings<DeleteServicePerimeterRequest,Empty,AccessContextManagerOperationMetadata> deleteServicePerimeterOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteServicePerimeterRequest,Empty,AccessContextManagerOperationMetadata>

deleteServicePerimeterSettings()

public UnaryCallSettings<DeleteServicePerimeterRequest,Operation> deleteServicePerimeterSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteServicePerimeterRequest,Operation>

getAccessLevelSettings()

public UnaryCallSettings<GetAccessLevelRequest,AccessLevel> getAccessLevelSettings()

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

Returns
Type Description
UnaryCallSettings<GetAccessLevelRequest,AccessLevel>

getAccessPolicySettings()

public UnaryCallSettings<GetAccessPolicyRequest,AccessPolicy> getAccessPolicySettings()

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

Returns
Type Description
UnaryCallSettings<GetAccessPolicyRequest,AccessPolicy>

getGcpUserAccessBindingSettings()

public UnaryCallSettings<GetGcpUserAccessBindingRequest,GcpUserAccessBinding> getGcpUserAccessBindingSettings()

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

Returns
Type Description
UnaryCallSettings<GetGcpUserAccessBindingRequest,GcpUserAccessBinding>

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>

getServicePerimeterSettings()

public UnaryCallSettings<GetServicePerimeterRequest,ServicePerimeter> getServicePerimeterSettings()

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

Returns
Type Description
UnaryCallSettings<GetServicePerimeterRequest,ServicePerimeter>

listAccessLevelsSettings()

public PagedCallSettings<ListAccessLevelsRequest,ListAccessLevelsResponse,AccessContextManagerClient.ListAccessLevelsPagedResponse> listAccessLevelsSettings()

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

Returns
Type Description
PagedCallSettings<ListAccessLevelsRequest,ListAccessLevelsResponse,ListAccessLevelsPagedResponse>

listAccessPoliciesSettings()

public PagedCallSettings<ListAccessPoliciesRequest,ListAccessPoliciesResponse,AccessContextManagerClient.ListAccessPoliciesPagedResponse> listAccessPoliciesSettings()

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

Returns
Type Description
PagedCallSettings<ListAccessPoliciesRequest,ListAccessPoliciesResponse,ListAccessPoliciesPagedResponse>

listGcpUserAccessBindingsSettings()

public PagedCallSettings<ListGcpUserAccessBindingsRequest,ListGcpUserAccessBindingsResponse,AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse> listGcpUserAccessBindingsSettings()

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

Returns
Type Description
PagedCallSettings<ListGcpUserAccessBindingsRequest,ListGcpUserAccessBindingsResponse,ListGcpUserAccessBindingsPagedResponse>

listServicePerimetersSettings()

public PagedCallSettings<ListServicePerimetersRequest,ListServicePerimetersResponse,AccessContextManagerClient.ListServicePerimetersPagedResponse> listServicePerimetersSettings()

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

Returns
Type Description
PagedCallSettings<ListServicePerimetersRequest,ListServicePerimetersResponse,ListServicePerimetersPagedResponse>

replaceAccessLevelsOperationSettings()

public OperationCallSettings<ReplaceAccessLevelsRequest,ReplaceAccessLevelsResponse,AccessContextManagerOperationMetadata> replaceAccessLevelsOperationSettings()

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

Returns
Type Description
OperationCallSettings<ReplaceAccessLevelsRequest,ReplaceAccessLevelsResponse,AccessContextManagerOperationMetadata>

replaceAccessLevelsSettings()

public UnaryCallSettings<ReplaceAccessLevelsRequest,Operation> replaceAccessLevelsSettings()

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

Returns
Type Description
UnaryCallSettings<ReplaceAccessLevelsRequest,Operation>

replaceServicePerimetersOperationSettings()

public OperationCallSettings<ReplaceServicePerimetersRequest,ReplaceServicePerimetersResponse,AccessContextManagerOperationMetadata> replaceServicePerimetersOperationSettings()

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

Returns
Type Description
OperationCallSettings<ReplaceServicePerimetersRequest,ReplaceServicePerimetersResponse,AccessContextManagerOperationMetadata>

replaceServicePerimetersSettings()

public UnaryCallSettings<ReplaceServicePerimetersRequest,Operation> replaceServicePerimetersSettings()

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

Returns
Type Description
UnaryCallSettings<ReplaceServicePerimetersRequest,Operation>

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

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

Returns
Type Description
AccessContextManagerSettings.Builder
Overrides

updateAccessLevelOperationSettings()

public OperationCallSettings<UpdateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata> updateAccessLevelOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateAccessLevelRequest,AccessLevel,AccessContextManagerOperationMetadata>

updateAccessLevelSettings()

public UnaryCallSettings<UpdateAccessLevelRequest,Operation> updateAccessLevelSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAccessLevelRequest,Operation>

updateAccessPolicyOperationSettings()

public OperationCallSettings<UpdateAccessPolicyRequest,AccessPolicy,AccessContextManagerOperationMetadata> updateAccessPolicyOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateAccessPolicyRequest,AccessPolicy,AccessContextManagerOperationMetadata>

updateAccessPolicySettings()

public UnaryCallSettings<UpdateAccessPolicyRequest,Operation> updateAccessPolicySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAccessPolicyRequest,Operation>

updateGcpUserAccessBindingOperationSettings()

public OperationCallSettings<UpdateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata> updateGcpUserAccessBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateGcpUserAccessBindingRequest,GcpUserAccessBinding,GcpUserAccessBindingOperationMetadata>

updateGcpUserAccessBindingSettings()

public UnaryCallSettings<UpdateGcpUserAccessBindingRequest,Operation> updateGcpUserAccessBindingSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateGcpUserAccessBindingRequest,Operation>

updateServicePerimeterOperationSettings()

public OperationCallSettings<UpdateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata> updateServicePerimeterOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateServicePerimeterRequest,ServicePerimeter,AccessContextManagerOperationMetadata>

updateServicePerimeterSettings()

public UnaryCallSettings<UpdateServicePerimeterRequest,Operation> updateServicePerimeterSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateServicePerimeterRequest,Operation>