Class AutokeySettings (2.56.0) 

public class AutokeySettings extends ClientSettings<AutokeySettings>

Settings class to configure an instance of AutokeyClient.

The default instance has everything set to sensible defaults:

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


 // 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
 AutokeySettings.Builder autokeySettingsBuilder = AutokeySettings.newBuilder();
 autokeySettingsBuilder
     .getKeyHandleSettings()
     .setRetrySettings(
         autokeySettingsBuilder
             .getKeyHandleSettings()
             .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());
 AutokeySettings autokeySettings = autokeySettingsBuilder.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 createKeyHandle:


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

Inheritance

java.lang.Object > ClientSettings > AutokeySettings

Static Methods

create(AutokeyStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
AutokeySettings.Builder

newBuilder(ClientContext clientContext)

public static AutokeySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
AutokeySettings.Builder

newHttpJsonBuilder()

public static AutokeySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
AutokeySettings.Builder

Constructors

AutokeySettings(AutokeySettings.Builder settingsBuilder)

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

Methods

createKeyHandleOperationSettings()

public OperationCallSettings<CreateKeyHandleRequest,KeyHandle,CreateKeyHandleMetadata> createKeyHandleOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateKeyHandleRequest,KeyHandle,CreateKeyHandleMetadata>

createKeyHandleSettings()

public UnaryCallSettings<CreateKeyHandleRequest,Operation> createKeyHandleSettings()

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

Returns
Type Description
UnaryCallSettings<CreateKeyHandleRequest,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>

getKeyHandleSettings()

public UnaryCallSettings<GetKeyHandleRequest,KeyHandle> getKeyHandleSettings()

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

Returns
Type Description
UnaryCallSettings<GetKeyHandleRequest,KeyHandle>

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>

listKeyHandlesSettings()

public PagedCallSettings<ListKeyHandlesRequest,ListKeyHandlesResponse,AutokeyClient.ListKeyHandlesPagedResponse> listKeyHandlesSettings()

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

Returns
Type Description
PagedCallSettings<ListKeyHandlesRequest,ListKeyHandlesResponse,ListKeyHandlesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AutokeyClient.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 AutokeySettings.Builder toBuilder()

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

Returns
Type Description
AutokeySettings.Builder
Overrides