Class KeyManagementServiceSettings (2.38.0)

Version 2.38.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.8
• 2.5.3
• 2.4.4
• 2.3.1

public class KeyManagementServiceSettings extends ClientSettings<KeyManagementServiceSettings>

Settings class to configure an instance of KeyManagementServiceClient.

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 total timeout of getKeyRing 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
 KeyManagementServiceSettings.Builder keyManagementServiceSettingsBuilder =
     KeyManagementServiceSettings.newBuilder();
 keyManagementServiceSettingsBuilder
     .getKeyRingSettings()
     .setRetrySettings(
         keyManagementServiceSettingsBuilder
             .getKeyRingSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 KeyManagementServiceSettings keyManagementServiceSettings =
     keyManagementServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > KeyManagementServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(KeyManagementServiceStubSettings stub)

public static final KeyManagementServiceSettings create(KeyManagementServiceStubSettings stub)

Parameter
Name	Description
stub	KeyManagementServiceStubSettings

Returns
Type	Description
KeyManagementServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Beta

The surface for customizing headers is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 KeyManagementServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
KeyManagementServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static KeyManagementServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
KeyManagementServiceSettings.Builder

newHttpJsonBuilder()

public static KeyManagementServiceSettings.Builder newHttpJsonBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a new REST builder for this class.

Returns
Type	Description
KeyManagementServiceSettings.Builder

Constructors

KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)

protected KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	KeyManagementServiceSettings.Builder

Methods

asymmetricDecryptSettings()

public UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse> asymmetricDecryptSettings()

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

Returns
Type	Description
UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse>

asymmetricSignSettings()

public UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse> asymmetricSignSettings()

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

Returns
Type	Description
UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse>

createCryptoKeySettings()

public UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey> createCryptoKeySettings()

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

Returns
Type	Description
UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey>

createCryptoKeyVersionSettings()

public UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion> createCryptoKeyVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion>

createImportJobSettings()

public UnaryCallSettings<CreateImportJobRequest,ImportJob> createImportJobSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateImportJobRequest,ImportJob>

createKeyRingSettings()

public UnaryCallSettings<CreateKeyRingRequest,KeyRing> createKeyRingSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateKeyRingRequest,KeyRing>

decryptSettings()

public UnaryCallSettings<DecryptRequest,DecryptResponse> decryptSettings()

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

Returns
Type	Description
UnaryCallSettings<DecryptRequest,DecryptResponse>

destroyCryptoKeyVersionSettings()

public UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion> destroyCryptoKeyVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion>

encryptSettings()

public UnaryCallSettings<EncryptRequest,EncryptResponse> encryptSettings()

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

Returns
Type	Description
UnaryCallSettings<EncryptRequest,EncryptResponse>

generateRandomBytesSettings()

public UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse> generateRandomBytesSettings()

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

Returns
Type	Description
UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse>

getCryptoKeySettings()

public UnaryCallSettings<GetCryptoKeyRequest,CryptoKey> getCryptoKeySettings()

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

Returns
Type	Description
UnaryCallSettings<GetCryptoKeyRequest,CryptoKey>

getCryptoKeyVersionSettings()

public UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion> getCryptoKeyVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion>

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>

getImportJobSettings()

public UnaryCallSettings<GetImportJobRequest,ImportJob> getImportJobSettings()

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

Returns
Type	Description
UnaryCallSettings<GetImportJobRequest,ImportJob>

getKeyRingSettings()

public UnaryCallSettings<GetKeyRingRequest,KeyRing> getKeyRingSettings()

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

Returns
Type	Description
UnaryCallSettings<GetKeyRingRequest,KeyRing>

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>

getPublicKeySettings()

public UnaryCallSettings<GetPublicKeyRequest,PublicKey> getPublicKeySettings()

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

Returns
Type	Description
UnaryCallSettings<GetPublicKeyRequest,PublicKey>

importCryptoKeyVersionSettings()

public UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion> importCryptoKeyVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion>

listCryptoKeyVersionsSettings()

public PagedCallSettings<ListCryptoKeyVersionsRequest,ListCryptoKeyVersionsResponse,KeyManagementServiceClient.ListCryptoKeyVersionsPagedResponse> listCryptoKeyVersionsSettings()

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

Returns
Type	Description
PagedCallSettings<ListCryptoKeyVersionsRequest,ListCryptoKeyVersionsResponse,ListCryptoKeyVersionsPagedResponse>

listCryptoKeysSettings()

public PagedCallSettings<ListCryptoKeysRequest,ListCryptoKeysResponse,KeyManagementServiceClient.ListCryptoKeysPagedResponse> listCryptoKeysSettings()

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

Returns
Type	Description
PagedCallSettings<ListCryptoKeysRequest,ListCryptoKeysResponse,ListCryptoKeysPagedResponse>

listImportJobsSettings()

public PagedCallSettings<ListImportJobsRequest,ListImportJobsResponse,KeyManagementServiceClient.ListImportJobsPagedResponse> listImportJobsSettings()

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

Returns
Type	Description
PagedCallSettings<ListImportJobsRequest,ListImportJobsResponse,ListImportJobsPagedResponse>

listKeyRingsSettings()

public PagedCallSettings<ListKeyRingsRequest,ListKeyRingsResponse,KeyManagementServiceClient.ListKeyRingsPagedResponse> listKeyRingsSettings()

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

Returns
Type	Description
PagedCallSettings<ListKeyRingsRequest,ListKeyRingsResponse,ListKeyRingsPagedResponse>

listLocationsSettings()

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

macSignSettings()

public UnaryCallSettings<MacSignRequest,MacSignResponse> macSignSettings()

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

Returns
Type	Description
UnaryCallSettings<MacSignRequest,MacSignResponse>

macVerifySettings()

public UnaryCallSettings<MacVerifyRequest,MacVerifyResponse> macVerifySettings()

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

Returns
Type	Description
UnaryCallSettings<MacVerifyRequest,MacVerifyResponse>

rawDecryptSettings()

public UnaryCallSettings<RawDecryptRequest,RawDecryptResponse> rawDecryptSettings()

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

Returns
Type	Description
UnaryCallSettings<RawDecryptRequest,RawDecryptResponse>

rawEncryptSettings()

public UnaryCallSettings<RawEncryptRequest,RawEncryptResponse> rawEncryptSettings()

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

Returns
Type	Description
UnaryCallSettings<RawEncryptRequest,RawEncryptResponse>

restoreCryptoKeyVersionSettings()

public UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion> restoreCryptoKeyVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion>

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

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

Returns
Type	Description
KeyManagementServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateCryptoKeyPrimaryVersionSettings()

public UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey> updateCryptoKeyPrimaryVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey>

updateCryptoKeySettings()

public UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey> updateCryptoKeySettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey>

updateCryptoKeyVersionSettings()

public UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion> updateCryptoKeyVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion>