Class PrivilegedAccessManagerSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<PrivilegedAccessManagerSettings>
com.google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManagerSettings
@Generated("by gapic-generator-java")
public class PrivilegedAccessManagerSettings
extends ClientSettings<PrivilegedAccessManagerSettings>
Settings class to configure an instance of
PrivilegedAccessManagerClient.
The default instance has everything set to sensible defaults:
- The default service address (privilegedaccessmanager.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 checkOnboardingStatus:
// 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
PrivilegedAccessManagerSettings.Builder privilegedAccessManagerSettingsBuilder =
PrivilegedAccessManagerSettings.newBuilder();
privilegedAccessManagerSettingsBuilder
.checkOnboardingStatusSettings()
.setRetrySettings(
privilegedAccessManagerSettingsBuilder
.checkOnboardingStatusSettings()
.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());
PrivilegedAccessManagerSettings privilegedAccessManagerSettings =
privilegedAccessManagerSettingsBuilder.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 createEntitlement:
// 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
PrivilegedAccessManagerSettings.Builder privilegedAccessManagerSettingsBuilder =
PrivilegedAccessManagerSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
privilegedAccessManagerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for PrivilegedAccessManagerSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPrivilegedAccessManagerSettings(PrivilegedAccessManagerSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to approveGrant.Returns the object with the settings used for calls to checkOnboardingStatus.static final PrivilegedAccessManagerSettingsReturns the object with the settings used for calls to createEntitlement.Returns the object with the settings used for calls to createEntitlement.Returns the object with the settings used for calls to createGrant.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 TransportChannelProviderReturns the object with the settings used for calls to deleteEntitlement.Returns the object with the settings used for calls to deleteEntitlement.Returns the object with the settings used for calls to denyGrant.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getEntitlement.Returns the object with the settings used for calls to getGrant.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse, PrivilegedAccessManagerClient.ListEntitlementsPagedResponse> Returns the object with the settings used for calls to listEntitlements.PagedCallSettings<ListGrantsRequest,ListGrantsResponse, PrivilegedAccessManagerClient.ListGrantsPagedResponse> Returns the object with the settings used for calls to listGrants.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, PrivilegedAccessManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.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.Returns the object with the settings used for calls to revokeGrant.Returns the object with the settings used for calls to revokeGrant.PagedCallSettings<SearchEntitlementsRequest,SearchEntitlementsResponse, PrivilegedAccessManagerClient.SearchEntitlementsPagedResponse> Returns the object with the settings used for calls to searchEntitlements.PagedCallSettings<SearchGrantsRequest,SearchGrantsResponse, PrivilegedAccessManagerClient.SearchGrantsPagedResponse> Returns the object with the settings used for calls to searchGrants.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateEntitlement.Returns the object with the settings used for calls to updateEntitlement.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
-
PrivilegedAccessManagerSettings
protected PrivilegedAccessManagerSettings(PrivilegedAccessManagerSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
checkOnboardingStatusSettings
public UnaryCallSettings<CheckOnboardingStatusRequest,CheckOnboardingStatusResponse> checkOnboardingStatusSettings()Returns the object with the settings used for calls to checkOnboardingStatus. -
listEntitlementsSettings
public PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse, listEntitlementsSettings()PrivilegedAccessManagerClient.ListEntitlementsPagedResponse> Returns the object with the settings used for calls to listEntitlements. -
searchEntitlementsSettings
public PagedCallSettings<SearchEntitlementsRequest,SearchEntitlementsResponse, searchEntitlementsSettings()PrivilegedAccessManagerClient.SearchEntitlementsPagedResponse> Returns the object with the settings used for calls to searchEntitlements. -
getEntitlementSettings
Returns the object with the settings used for calls to getEntitlement. -
createEntitlementSettings
Returns the object with the settings used for calls to createEntitlement. -
createEntitlementOperationSettings
public OperationCallSettings<CreateEntitlementRequest,Entitlement, createEntitlementOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createEntitlement. -
deleteEntitlementSettings
Returns the object with the settings used for calls to deleteEntitlement. -
deleteEntitlementOperationSettings
public OperationCallSettings<DeleteEntitlementRequest,Entitlement, deleteEntitlementOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteEntitlement. -
updateEntitlementSettings
Returns the object with the settings used for calls to updateEntitlement. -
updateEntitlementOperationSettings
public OperationCallSettings<UpdateEntitlementRequest,Entitlement, updateEntitlementOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateEntitlement. -
listGrantsSettings
public PagedCallSettings<ListGrantsRequest,ListGrantsResponse, listGrantsSettings()PrivilegedAccessManagerClient.ListGrantsPagedResponse> Returns the object with the settings used for calls to listGrants. -
searchGrantsSettings
public PagedCallSettings<SearchGrantsRequest,SearchGrantsResponse, searchGrantsSettings()PrivilegedAccessManagerClient.SearchGrantsPagedResponse> Returns the object with the settings used for calls to searchGrants. -
getGrantSettings
Returns the object with the settings used for calls to getGrant. -
createGrantSettings
Returns the object with the settings used for calls to createGrant. -
approveGrantSettings
Returns the object with the settings used for calls to approveGrant. -
denyGrantSettings
Returns the object with the settings used for calls to denyGrant. -
revokeGrantSettings
Returns the object with the settings used for calls to revokeGrant. -
revokeGrantOperationSettings
public OperationCallSettings<RevokeGrantRequest,Grant, revokeGrantOperationSettings()OperationMetadata> Returns the object with the settings used for calls to revokeGrant. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()PrivilegedAccessManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
public static final PrivilegedAccessManagerSettings create(PrivilegedAccessManagerStubSettings 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<PrivilegedAccessManagerSettings>
-