Class PrivilegedAccessManagerSettings (0.1.0)

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 total timeout of checkOnboardingStatus to 30 seconds:


 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PrivilegedAccessManagerSettings privilegedAccessManagerSettings =
     privilegedAccessManagerSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > PrivilegedAccessManagerSettings

Static Methods

create(PrivilegedAccessManagerStubSettings stub)

public static final PrivilegedAccessManagerSettings create(PrivilegedAccessManagerStubSettings stub)
Parameter
Name Description
stub PrivilegedAccessManagerStubSettings
Returns
Type Description
PrivilegedAccessManagerSettings
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 PrivilegedAccessManagerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
PrivilegedAccessManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static PrivilegedAccessManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
PrivilegedAccessManagerSettings.Builder

newHttpJsonBuilder()

public static PrivilegedAccessManagerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
PrivilegedAccessManagerSettings.Builder

Constructors

PrivilegedAccessManagerSettings(PrivilegedAccessManagerSettings.Builder settingsBuilder)

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

Methods

approveGrantSettings()

public UnaryCallSettings<ApproveGrantRequest,Grant> approveGrantSettings()

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

Returns
Type Description
UnaryCallSettings<ApproveGrantRequest,Grant>

checkOnboardingStatusSettings()

public UnaryCallSettings<CheckOnboardingStatusRequest,CheckOnboardingStatusResponse> checkOnboardingStatusSettings()

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

Returns
Type Description
UnaryCallSettings<CheckOnboardingStatusRequest,CheckOnboardingStatusResponse>

createEntitlementOperationSettings()

public OperationCallSettings<CreateEntitlementRequest,Entitlement,OperationMetadata> createEntitlementOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateEntitlementRequest,Entitlement,OperationMetadata>

createEntitlementSettings()

public UnaryCallSettings<CreateEntitlementRequest,Operation> createEntitlementSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEntitlementRequest,Operation>

createGrantSettings()

public UnaryCallSettings<CreateGrantRequest,Grant> createGrantSettings()

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

Returns
Type Description
UnaryCallSettings<CreateGrantRequest,Grant>

deleteEntitlementOperationSettings()

public OperationCallSettings<DeleteEntitlementRequest,Entitlement,OperationMetadata> deleteEntitlementOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteEntitlementRequest,Entitlement,OperationMetadata>

deleteEntitlementSettings()

public UnaryCallSettings<DeleteEntitlementRequest,Operation> deleteEntitlementSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEntitlementRequest,Operation>

denyGrantSettings()

public UnaryCallSettings<DenyGrantRequest,Grant> denyGrantSettings()

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

Returns
Type Description
UnaryCallSettings<DenyGrantRequest,Grant>

getEntitlementSettings()

public UnaryCallSettings<GetEntitlementRequest,Entitlement> getEntitlementSettings()

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

Returns
Type Description
UnaryCallSettings<GetEntitlementRequest,Entitlement>

getGrantSettings()

public UnaryCallSettings<GetGrantRequest,Grant> getGrantSettings()

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

Returns
Type Description
UnaryCallSettings<GetGrantRequest,Grant>

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>

listEntitlementsSettings()

public PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse,PrivilegedAccessManagerClient.ListEntitlementsPagedResponse> listEntitlementsSettings()

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

Returns
Type Description
PagedCallSettings<ListEntitlementsRequest,ListEntitlementsResponse,ListEntitlementsPagedResponse>

listGrantsSettings()

public PagedCallSettings<ListGrantsRequest,ListGrantsResponse,PrivilegedAccessManagerClient.ListGrantsPagedResponse> listGrantsSettings()

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

Returns
Type Description
PagedCallSettings<ListGrantsRequest,ListGrantsResponse,ListGrantsPagedResponse>

listLocationsSettings()

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

revokeGrantOperationSettings()

public OperationCallSettings<RevokeGrantRequest,Grant,OperationMetadata> revokeGrantOperationSettings()

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

Returns
Type Description
OperationCallSettings<RevokeGrantRequest,Grant,OperationMetadata>

revokeGrantSettings()

public UnaryCallSettings<RevokeGrantRequest,Operation> revokeGrantSettings()

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

Returns
Type Description
UnaryCallSettings<RevokeGrantRequest,Operation>

searchEntitlementsSettings()

public PagedCallSettings<SearchEntitlementsRequest,SearchEntitlementsResponse,PrivilegedAccessManagerClient.SearchEntitlementsPagedResponse> searchEntitlementsSettings()

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

Returns
Type Description
PagedCallSettings<SearchEntitlementsRequest,SearchEntitlementsResponse,SearchEntitlementsPagedResponse>

searchGrantsSettings()

public PagedCallSettings<SearchGrantsRequest,SearchGrantsResponse,PrivilegedAccessManagerClient.SearchGrantsPagedResponse> searchGrantsSettings()

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

Returns
Type Description
PagedCallSettings<SearchGrantsRequest,SearchGrantsResponse,SearchGrantsPagedResponse>

toBuilder()

public PrivilegedAccessManagerSettings.Builder toBuilder()

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

Returns
Type Description
PrivilegedAccessManagerSettings.Builder
Overrides

updateEntitlementOperationSettings()

public OperationCallSettings<UpdateEntitlementRequest,Entitlement,OperationMetadata> updateEntitlementOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateEntitlementRequest,Entitlement,OperationMetadata>

updateEntitlementSettings()

public UnaryCallSettings<UpdateEntitlementRequest,Operation> updateEntitlementSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEntitlementRequest,Operation>