Class AccessContextManagerSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<AccessContextManagerSettings>
com.google.identity.accesscontextmanager.v1.AccessContextManagerSettings
@Generated("by gapic-generator-java")
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](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 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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for AccessContextManagerSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAccessContextManagerSettings(AccessContextManagerSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<CommitServicePerimetersRequest,CommitServicePerimetersResponse, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to commitServicePerimeters.Returns the object with the settings used for calls to commitServicePerimeters.static final AccessContextManagerSettingsReturns the object with the settings used for calls to createAccessLevel.Returns the object with the settings used for calls to createAccessLevel.Returns the object with the settings used for calls to createAccessPolicy.Returns the object with the settings used for calls to createAccessPolicy.OperationCallSettings<CreateGcpUserAccessBindingRequest,GcpUserAccessBinding, GcpUserAccessBindingOperationMetadata> Returns the object with the settings used for calls to createGcpUserAccessBinding.Returns the object with the settings used for calls to createGcpUserAccessBinding.OperationCallSettings<CreateServicePerimeterRequest,ServicePerimeter, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to createServicePerimeter.Returns the object with the settings used for calls to createServicePerimeter.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 gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteAccessLevelRequest,com.google.protobuf.Empty, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to deleteAccessLevel.Returns the object with the settings used for calls to deleteAccessLevel.OperationCallSettings<DeleteAccessPolicyRequest,com.google.protobuf.Empty, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to deleteAccessPolicy.Returns the object with the settings used for calls to deleteAccessPolicy.OperationCallSettings<DeleteGcpUserAccessBindingRequest,com.google.protobuf.Empty, GcpUserAccessBindingOperationMetadata> Returns the object with the settings used for calls to deleteGcpUserAccessBinding.Returns the object with the settings used for calls to deleteGcpUserAccessBinding.OperationCallSettings<DeleteServicePerimeterRequest,com.google.protobuf.Empty, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to deleteServicePerimeter.Returns the object with the settings used for calls to deleteServicePerimeter.Returns the object with the settings used for calls to getAccessLevel.Returns the object with the settings used for calls to getAccessPolicy.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getGcpUserAccessBinding.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getServicePerimeter.PagedCallSettings<ListAccessLevelsRequest,ListAccessLevelsResponse, AccessContextManagerClient.ListAccessLevelsPagedResponse> Returns the object with the settings used for calls to listAccessLevels.PagedCallSettings<ListAccessPoliciesRequest,ListAccessPoliciesResponse, AccessContextManagerClient.ListAccessPoliciesPagedResponse> Returns the object with the settings used for calls to listAccessPolicies.PagedCallSettings<ListGcpUserAccessBindingsRequest,ListGcpUserAccessBindingsResponse, AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse> Returns the object with the settings used for calls to listGcpUserAccessBindings.PagedCallSettings<ListServicePerimetersRequest,ListServicePerimetersResponse, AccessContextManagerClient.ListServicePerimetersPagedResponse> Returns the object with the settings used for calls to listServicePerimeters.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.OperationCallSettings<ReplaceAccessLevelsRequest,ReplaceAccessLevelsResponse, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to replaceAccessLevels.Returns the object with the settings used for calls to replaceAccessLevels.OperationCallSettings<ReplaceServicePerimetersRequest,ReplaceServicePerimetersResponse, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to replaceServicePerimeters.Returns the object with the settings used for calls to replaceServicePerimeters.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> Returns the object with the settings used for calls to setIamPolicy.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> 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 updateAccessLevel.Returns the object with the settings used for calls to updateAccessLevel.Returns the object with the settings used for calls to updateAccessPolicy.Returns the object with the settings used for calls to updateAccessPolicy.OperationCallSettings<UpdateGcpUserAccessBindingRequest,GcpUserAccessBinding, GcpUserAccessBindingOperationMetadata> Returns the object with the settings used for calls to updateGcpUserAccessBinding.Returns the object with the settings used for calls to updateGcpUserAccessBinding.OperationCallSettings<UpdateServicePerimeterRequest,ServicePerimeter, AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to updateServicePerimeter.Returns the object with the settings used for calls to updateServicePerimeter.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
AccessContextManagerSettings
protected AccessContextManagerSettings(AccessContextManagerSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listAccessPoliciesSettings
public PagedCallSettings<ListAccessPoliciesRequest,ListAccessPoliciesResponse, listAccessPoliciesSettings()AccessContextManagerClient.ListAccessPoliciesPagedResponse> Returns the object with the settings used for calls to listAccessPolicies. -
getAccessPolicySettings
Returns the object with the settings used for calls to getAccessPolicy. -
createAccessPolicySettings
Returns the object with the settings used for calls to createAccessPolicy. -
createAccessPolicyOperationSettings
public OperationCallSettings<AccessPolicy,AccessPolicy, createAccessPolicyOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to createAccessPolicy. -
updateAccessPolicySettings
Returns the object with the settings used for calls to updateAccessPolicy. -
updateAccessPolicyOperationSettings
public OperationCallSettings<UpdateAccessPolicyRequest,AccessPolicy, updateAccessPolicyOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to updateAccessPolicy. -
deleteAccessPolicySettings
Returns the object with the settings used for calls to deleteAccessPolicy. -
deleteAccessPolicyOperationSettings
public OperationCallSettings<DeleteAccessPolicyRequest,com.google.protobuf.Empty, deleteAccessPolicyOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to deleteAccessPolicy. -
listAccessLevelsSettings
public PagedCallSettings<ListAccessLevelsRequest,ListAccessLevelsResponse, listAccessLevelsSettings()AccessContextManagerClient.ListAccessLevelsPagedResponse> Returns the object with the settings used for calls to listAccessLevels. -
getAccessLevelSettings
Returns the object with the settings used for calls to getAccessLevel. -
createAccessLevelSettings
Returns the object with the settings used for calls to createAccessLevel. -
createAccessLevelOperationSettings
public OperationCallSettings<CreateAccessLevelRequest,AccessLevel, createAccessLevelOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to createAccessLevel. -
updateAccessLevelSettings
Returns the object with the settings used for calls to updateAccessLevel. -
updateAccessLevelOperationSettings
public OperationCallSettings<UpdateAccessLevelRequest,AccessLevel, updateAccessLevelOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to updateAccessLevel. -
deleteAccessLevelSettings
Returns the object with the settings used for calls to deleteAccessLevel. -
deleteAccessLevelOperationSettings
public OperationCallSettings<DeleteAccessLevelRequest,com.google.protobuf.Empty, deleteAccessLevelOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to deleteAccessLevel. -
replaceAccessLevelsSettings
Returns the object with the settings used for calls to replaceAccessLevels. -
replaceAccessLevelsOperationSettings
public OperationCallSettings<ReplaceAccessLevelsRequest,ReplaceAccessLevelsResponse, replaceAccessLevelsOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to replaceAccessLevels. -
listServicePerimetersSettings
public PagedCallSettings<ListServicePerimetersRequest,ListServicePerimetersResponse, listServicePerimetersSettings()AccessContextManagerClient.ListServicePerimetersPagedResponse> Returns the object with the settings used for calls to listServicePerimeters. -
getServicePerimeterSettings
Returns the object with the settings used for calls to getServicePerimeter. -
createServicePerimeterSettings
Returns the object with the settings used for calls to createServicePerimeter. -
createServicePerimeterOperationSettings
public OperationCallSettings<CreateServicePerimeterRequest,ServicePerimeter, createServicePerimeterOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to createServicePerimeter. -
updateServicePerimeterSettings
Returns the object with the settings used for calls to updateServicePerimeter. -
updateServicePerimeterOperationSettings
public OperationCallSettings<UpdateServicePerimeterRequest,ServicePerimeter, updateServicePerimeterOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to updateServicePerimeter. -
deleteServicePerimeterSettings
Returns the object with the settings used for calls to deleteServicePerimeter. -
deleteServicePerimeterOperationSettings
public OperationCallSettings<DeleteServicePerimeterRequest,com.google.protobuf.Empty, deleteServicePerimeterOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to deleteServicePerimeter. -
replaceServicePerimetersSettings
public UnaryCallSettings<ReplaceServicePerimetersRequest,Operation> replaceServicePerimetersSettings()Returns the object with the settings used for calls to replaceServicePerimeters. -
replaceServicePerimetersOperationSettings
public OperationCallSettings<ReplaceServicePerimetersRequest,ReplaceServicePerimetersResponse, replaceServicePerimetersOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to replaceServicePerimeters. -
commitServicePerimetersSettings
public UnaryCallSettings<CommitServicePerimetersRequest,Operation> commitServicePerimetersSettings()Returns the object with the settings used for calls to commitServicePerimeters. -
commitServicePerimetersOperationSettings
public OperationCallSettings<CommitServicePerimetersRequest,CommitServicePerimetersResponse, commitServicePerimetersOperationSettings()AccessContextManagerOperationMetadata> Returns the object with the settings used for calls to commitServicePerimeters. -
listGcpUserAccessBindingsSettings
public PagedCallSettings<ListGcpUserAccessBindingsRequest,ListGcpUserAccessBindingsResponse, listGcpUserAccessBindingsSettings()AccessContextManagerClient.ListGcpUserAccessBindingsPagedResponse> Returns the object with the settings used for calls to listGcpUserAccessBindings. -
getGcpUserAccessBindingSettings
public UnaryCallSettings<GetGcpUserAccessBindingRequest,GcpUserAccessBinding> getGcpUserAccessBindingSettings()Returns the object with the settings used for calls to getGcpUserAccessBinding. -
createGcpUserAccessBindingSettings
public UnaryCallSettings<CreateGcpUserAccessBindingRequest,Operation> createGcpUserAccessBindingSettings()Returns the object with the settings used for calls to createGcpUserAccessBinding. -
createGcpUserAccessBindingOperationSettings
public OperationCallSettings<CreateGcpUserAccessBindingRequest,GcpUserAccessBinding, createGcpUserAccessBindingOperationSettings()GcpUserAccessBindingOperationMetadata> Returns the object with the settings used for calls to createGcpUserAccessBinding. -
updateGcpUserAccessBindingSettings
public UnaryCallSettings<UpdateGcpUserAccessBindingRequest,Operation> updateGcpUserAccessBindingSettings()Returns the object with the settings used for calls to updateGcpUserAccessBinding. -
updateGcpUserAccessBindingOperationSettings
public OperationCallSettings<UpdateGcpUserAccessBindingRequest,GcpUserAccessBinding, updateGcpUserAccessBindingOperationSettings()GcpUserAccessBindingOperationMetadata> Returns the object with the settings used for calls to updateGcpUserAccessBinding. -
deleteGcpUserAccessBindingSettings
public UnaryCallSettings<DeleteGcpUserAccessBindingRequest,Operation> deleteGcpUserAccessBindingSettings()Returns the object with the settings used for calls to deleteGcpUserAccessBinding. -
deleteGcpUserAccessBindingOperationSettings
public OperationCallSettings<DeleteGcpUserAccessBindingRequest,com.google.protobuf.Empty, deleteGcpUserAccessBindingOperationSettings()GcpUserAccessBindingOperationMetadata> Returns the object with the settings used for calls to deleteGcpUserAccessBinding. -
setIamPolicySettings
public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final AccessContextManagerSettings create(AccessContextManagerStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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 gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST 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 classClientSettings<AccessContextManagerSettings>
-