Class HsmManagementSettings (2.86.0) 

public class HsmManagementSettings extends ClientSettings<HsmManagementSettings>

Settings class to configure an instance of HsmManagementClient.

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 getSingleTenantHsmInstance:


 // 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
 HsmManagementSettings.Builder hsmManagementSettingsBuilder = HsmManagementSettings.newBuilder();
 hsmManagementSettingsBuilder
     .getSingleTenantHsmInstanceSettings()
     .setRetrySettings(
         hsmManagementSettingsBuilder
             .getSingleTenantHsmInstanceSettings()
             .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());
 HsmManagementSettings hsmManagementSettings = hsmManagementSettingsBuilder.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 createSingleTenantHsmInstance:


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

Inheritance

java.lang.Object > ClientSettings > HsmManagementSettings

Static Methods

create(HsmManagementStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
HsmManagementSettings.Builder

newBuilder(ClientContext clientContext)

public static HsmManagementSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
HsmManagementSettings.Builder

newHttpJsonBuilder()

public static HsmManagementSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
HsmManagementSettings.Builder

Constructors

HsmManagementSettings(HsmManagementSettings.Builder settingsBuilder)

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

Methods

approveSingleTenantHsmInstanceProposalSettings()

public UnaryCallSettings<ApproveSingleTenantHsmInstanceProposalRequest,ApproveSingleTenantHsmInstanceProposalResponse> approveSingleTenantHsmInstanceProposalSettings()

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

Returns
Type Description
UnaryCallSettings<ApproveSingleTenantHsmInstanceProposalRequest,ApproveSingleTenantHsmInstanceProposalResponse>

createSingleTenantHsmInstanceOperationSettings()

public OperationCallSettings<CreateSingleTenantHsmInstanceRequest,SingleTenantHsmInstance,CreateSingleTenantHsmInstanceMetadata> createSingleTenantHsmInstanceOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateSingleTenantHsmInstanceRequest,SingleTenantHsmInstance,CreateSingleTenantHsmInstanceMetadata>

createSingleTenantHsmInstanceProposalOperationSettings()

public OperationCallSettings<CreateSingleTenantHsmInstanceProposalRequest,SingleTenantHsmInstanceProposal,CreateSingleTenantHsmInstanceProposalMetadata> createSingleTenantHsmInstanceProposalOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateSingleTenantHsmInstanceProposalRequest,SingleTenantHsmInstanceProposal,CreateSingleTenantHsmInstanceProposalMetadata>

createSingleTenantHsmInstanceProposalSettings()

public UnaryCallSettings<CreateSingleTenantHsmInstanceProposalRequest,Operation> createSingleTenantHsmInstanceProposalSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSingleTenantHsmInstanceProposalRequest,Operation>

createSingleTenantHsmInstanceSettings()

public UnaryCallSettings<CreateSingleTenantHsmInstanceRequest,Operation> createSingleTenantHsmInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSingleTenantHsmInstanceRequest,Operation>

deleteSingleTenantHsmInstanceProposalSettings()

public UnaryCallSettings<DeleteSingleTenantHsmInstanceProposalRequest,Empty> deleteSingleTenantHsmInstanceProposalSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteSingleTenantHsmInstanceProposalRequest,Empty>

executeSingleTenantHsmInstanceProposalOperationSettings()

public OperationCallSettings<ExecuteSingleTenantHsmInstanceProposalRequest,ExecuteSingleTenantHsmInstanceProposalResponse,ExecuteSingleTenantHsmInstanceProposalMetadata> executeSingleTenantHsmInstanceProposalOperationSettings()

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

Returns
Type Description
OperationCallSettings<ExecuteSingleTenantHsmInstanceProposalRequest,ExecuteSingleTenantHsmInstanceProposalResponse,ExecuteSingleTenantHsmInstanceProposalMetadata>

executeSingleTenantHsmInstanceProposalSettings()

public UnaryCallSettings<ExecuteSingleTenantHsmInstanceProposalRequest,Operation> executeSingleTenantHsmInstanceProposalSettings()

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

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

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>

getSingleTenantHsmInstanceProposalSettings()

public UnaryCallSettings<GetSingleTenantHsmInstanceProposalRequest,SingleTenantHsmInstanceProposal> getSingleTenantHsmInstanceProposalSettings()

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

Returns
Type Description
UnaryCallSettings<GetSingleTenantHsmInstanceProposalRequest,SingleTenantHsmInstanceProposal>

getSingleTenantHsmInstanceSettings()

public UnaryCallSettings<GetSingleTenantHsmInstanceRequest,SingleTenantHsmInstance> getSingleTenantHsmInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<GetSingleTenantHsmInstanceRequest,SingleTenantHsmInstance>

listLocationsSettings()

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

listSingleTenantHsmInstanceProposalsSettings()

public PagedCallSettings<ListSingleTenantHsmInstanceProposalsRequest,ListSingleTenantHsmInstanceProposalsResponse,HsmManagementClient.ListSingleTenantHsmInstanceProposalsPagedResponse> listSingleTenantHsmInstanceProposalsSettings()

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

Returns
Type Description
PagedCallSettings<ListSingleTenantHsmInstanceProposalsRequest,ListSingleTenantHsmInstanceProposalsResponse,ListSingleTenantHsmInstanceProposalsPagedResponse>

listSingleTenantHsmInstancesSettings()

public PagedCallSettings<ListSingleTenantHsmInstancesRequest,ListSingleTenantHsmInstancesResponse,HsmManagementClient.ListSingleTenantHsmInstancesPagedResponse> listSingleTenantHsmInstancesSettings()

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

Returns
Type Description
PagedCallSettings<ListSingleTenantHsmInstancesRequest,ListSingleTenantHsmInstancesResponse,ListSingleTenantHsmInstancesPagedResponse>

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

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

Returns
Type Description
HsmManagementSettings.Builder
Overrides