Class KeyManagementServiceSettings (2.12.0)

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

Static Methods

create(KeyManagementServiceStubSettings stub)

public static final KeyManagementServiceSettings create(KeyManagementServiceStubSettings stub)
Parameter
NameDescription
stubKeyManagementServiceStubSettings
Returns
TypeDescription
KeyManagementServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static KeyManagementServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
KeyManagementServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static KeyManagementServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
KeyManagementServiceSettings.Builder

newHttpJsonBuilder()

public static KeyManagementServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
KeyManagementServiceSettings.Builder

Constructors

KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)

protected KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderKeyManagementServiceSettings.Builder

Methods

asymmetricDecryptSettings()

public UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse> asymmetricDecryptSettings()

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

Returns
TypeDescription
UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse>

asymmetricSignSettings()

public UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse> asymmetricSignSettings()

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

Returns
TypeDescription
UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse>

createCryptoKeySettings()

public UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey> createCryptoKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey>

createCryptoKeyVersionSettings()

public UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion> createCryptoKeyVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion>

createImportJobSettings()

public UnaryCallSettings<CreateImportJobRequest,ImportJob> createImportJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateImportJobRequest,ImportJob>

createKeyRingSettings()

public UnaryCallSettings<CreateKeyRingRequest,KeyRing> createKeyRingSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateKeyRingRequest,KeyRing>

decryptSettings()

public UnaryCallSettings<DecryptRequest,DecryptResponse> decryptSettings()

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

Returns
TypeDescription
UnaryCallSettings<DecryptRequest,DecryptResponse>

destroyCryptoKeyVersionSettings()

public UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion> destroyCryptoKeyVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion>

encryptSettings()

public UnaryCallSettings<EncryptRequest,EncryptResponse> encryptSettings()

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

Returns
TypeDescription
UnaryCallSettings<EncryptRequest,EncryptResponse>

generateRandomBytesSettings()

public UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse> generateRandomBytesSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse>

getCryptoKeySettings()

public UnaryCallSettings<GetCryptoKeyRequest,CryptoKey> getCryptoKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCryptoKeyRequest,CryptoKey>

getCryptoKeyVersionSettings()

public UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion> getCryptoKeyVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<GetImportJobRequest,ImportJob>

getKeyRingSettings()

public UnaryCallSettings<GetKeyRingRequest,KeyRing> getKeyRingSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetKeyRingRequest,KeyRing>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<GetPublicKeyRequest,PublicKey>

importCryptoKeyVersionSettings()

public UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion> importCryptoKeyVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion>

listCryptoKeyVersionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCryptoKeyVersionsRequest,ListCryptoKeyVersionsResponse,ListCryptoKeyVersionsPagedResponse>

listCryptoKeysSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListCryptoKeysRequest,ListCryptoKeysResponse,ListCryptoKeysPagedResponse>

listImportJobsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListImportJobsRequest,ListImportJobsResponse,ListImportJobsPagedResponse>

listKeyRingsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListKeyRingsRequest,ListKeyRingsResponse,ListKeyRingsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,KeyManagementServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<MacSignRequest,MacSignResponse>

macVerifySettings()

public UnaryCallSettings<MacVerifyRequest,MacVerifyResponse> macVerifySettings()

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

Returns
TypeDescription
UnaryCallSettings<MacVerifyRequest,MacVerifyResponse>

restoreCryptoKeyVersionSettings()

public UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion> restoreCryptoKeyVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
KeyManagementServiceSettings.Builder
Overrides

updateCryptoKeyPrimaryVersionSettings()

public UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey> updateCryptoKeyPrimaryVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey>

updateCryptoKeySettings()

public UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey> updateCryptoKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey>

updateCryptoKeyVersionSettings()

public UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion> updateCryptoKeyVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion>