com.google.cloud.kms.v1

Class KeyManagementServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<KeyManagementServiceSettings>

com.google.cloud.kms.v1.KeyManagementServiceSettings

@Generated(value="by gapic-generator")
 @BetaApi
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:

 
 KeyManagementServiceSettings.Builder keyManagementServiceSettingsBuilder =
     KeyManagementServiceSettings.newBuilder();
 keyManagementServiceSettingsBuilder.getKeyRingSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 KeyManagementServiceSettings keyManagementServiceSettings = keyManagementServiceSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyManagementServiceSettings.Builder Builder for KeyManagementServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<com.google.cloud.kms.v1.AsymmetricDecryptRequest,com.google.cloud.kms.v1.AsymmetricDecryptResponse>	asymmetricDecryptSettings() Returns the object with the settings used for calls to asymmetricDecrypt.
UnaryCallSettings<com.google.cloud.kms.v1.AsymmetricSignRequest,com.google.cloud.kms.v1.AsymmetricSignResponse>	asymmetricSignSettings() Returns the object with the settings used for calls to asymmetricSign.
static KeyManagementServiceSettings	create(KeyManagementServiceStubSettings stub)
UnaryCallSettings<com.google.cloud.kms.v1.CreateCryptoKeyRequest,com.google.cloud.kms.v1.CryptoKey>	createCryptoKeySettings() Returns the object with the settings used for calls to createCryptoKey.
UnaryCallSettings<com.google.cloud.kms.v1.CreateCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion>	createCryptoKeyVersionSettings() Returns the object with the settings used for calls to createCryptoKeyVersion.
UnaryCallSettings<com.google.cloud.kms.v1.CreateKeyRingRequest,com.google.cloud.kms.v1.KeyRing>	createKeyRingSettings() Returns the object with the settings used for calls to createKeyRing.
UnaryCallSettings<com.google.cloud.kms.v1.DecryptRequest,com.google.cloud.kms.v1.DecryptResponse>	decryptSettings() Returns the object with the settings used for calls to decrypt.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.cloud.kms.v1.DestroyCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion>	destroyCryptoKeyVersionSettings() Returns the object with the settings used for calls to destroyCryptoKeyVersion.
UnaryCallSettings<com.google.cloud.kms.v1.EncryptRequest,com.google.cloud.kms.v1.EncryptResponse>	encryptSettings() Returns the object with the settings used for calls to encrypt.
UnaryCallSettings<com.google.cloud.kms.v1.GetCryptoKeyRequest,com.google.cloud.kms.v1.CryptoKey>	getCryptoKeySettings() Returns the object with the settings used for calls to getCryptoKey.
UnaryCallSettings<com.google.cloud.kms.v1.GetCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion>	getCryptoKeyVersionSettings() Returns the object with the settings used for calls to getCryptoKeyVersion.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<com.google.cloud.kms.v1.GetKeyRingRequest,com.google.cloud.kms.v1.KeyRing>	getKeyRingSettings() Returns the object with the settings used for calls to getKeyRing.
UnaryCallSettings<com.google.cloud.kms.v1.GetPublicKeyRequest,com.google.cloud.kms.v1.PublicKey>	getPublicKeySettings() Returns the object with the settings used for calls to getPublicKey.
PagedCallSettings<com.google.cloud.kms.v1.ListCryptoKeysRequest,com.google.cloud.kms.v1.ListCryptoKeysResponse,KeyManagementServiceClient.ListCryptoKeysPagedResponse>	listCryptoKeysSettings() Returns the object with the settings used for calls to listCryptoKeys.
PagedCallSettings<com.google.cloud.kms.v1.ListCryptoKeyVersionsRequest,com.google.cloud.kms.v1.ListCryptoKeyVersionsResponse,KeyManagementServiceClient.ListCryptoKeyVersionsPagedResponse>	listCryptoKeyVersionsSettings() Returns the object with the settings used for calls to listCryptoKeyVersions.
PagedCallSettings<com.google.cloud.kms.v1.ListKeyRingsRequest,com.google.cloud.kms.v1.ListKeyRingsResponse,KeyManagementServiceClient.ListKeyRingsPagedResponse>	listKeyRingsSettings() Returns the object with the settings used for calls to listKeyRings.
static KeyManagementServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static KeyManagementServiceSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<com.google.cloud.kms.v1.RestoreCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion>	restoreCryptoKeyVersionSettings() Returns the object with the settings used for calls to restoreCryptoKeyVersion.
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
KeyManagementServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.cloud.kms.v1.UpdateCryptoKeyPrimaryVersionRequest,com.google.cloud.kms.v1.CryptoKey>	updateCryptoKeyPrimaryVersionSettings() Returns the object with the settings used for calls to updateCryptoKeyPrimaryVersion.
UnaryCallSettings<com.google.cloud.kms.v1.UpdateCryptoKeyRequest,com.google.cloud.kms.v1.CryptoKey>	updateCryptoKeySettings() Returns the object with the settings used for calls to updateCryptoKey.
UnaryCallSettings<com.google.cloud.kms.v1.UpdateCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion>	updateCryptoKeyVersionSettings() Returns the object with the settings used for calls to updateCryptoKeyVersion.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KeyManagementServiceSettings

protected KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)
                                throws IOException

Throws:

IOException

Method Detail

listKeyRingsSettings

public PagedCallSettings<com.google.cloud.kms.v1.ListKeyRingsRequest,com.google.cloud.kms.v1.ListKeyRingsResponse,KeyManagementServiceClient.ListKeyRingsPagedResponse> listKeyRingsSettings()

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

listCryptoKeysSettings

public PagedCallSettings<com.google.cloud.kms.v1.ListCryptoKeysRequest,com.google.cloud.kms.v1.ListCryptoKeysResponse,KeyManagementServiceClient.ListCryptoKeysPagedResponse> listCryptoKeysSettings()

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

listCryptoKeyVersionsSettings

public PagedCallSettings<com.google.cloud.kms.v1.ListCryptoKeyVersionsRequest,com.google.cloud.kms.v1.ListCryptoKeyVersionsResponse,KeyManagementServiceClient.ListCryptoKeyVersionsPagedResponse> listCryptoKeyVersionsSettings()

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

getKeyRingSettings

public UnaryCallSettings<com.google.cloud.kms.v1.GetKeyRingRequest,com.google.cloud.kms.v1.KeyRing> getKeyRingSettings()

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

getCryptoKeySettings

public UnaryCallSettings<com.google.cloud.kms.v1.GetCryptoKeyRequest,com.google.cloud.kms.v1.CryptoKey> getCryptoKeySettings()

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

getCryptoKeyVersionSettings

public UnaryCallSettings<com.google.cloud.kms.v1.GetCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion> getCryptoKeyVersionSettings()

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

createKeyRingSettings

public UnaryCallSettings<com.google.cloud.kms.v1.CreateKeyRingRequest,com.google.cloud.kms.v1.KeyRing> createKeyRingSettings()

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

createCryptoKeySettings

public UnaryCallSettings<com.google.cloud.kms.v1.CreateCryptoKeyRequest,com.google.cloud.kms.v1.CryptoKey> createCryptoKeySettings()

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

createCryptoKeyVersionSettings

public UnaryCallSettings<com.google.cloud.kms.v1.CreateCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion> createCryptoKeyVersionSettings()

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

updateCryptoKeySettings

public UnaryCallSettings<com.google.cloud.kms.v1.UpdateCryptoKeyRequest,com.google.cloud.kms.v1.CryptoKey> updateCryptoKeySettings()

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

updateCryptoKeyVersionSettings

public UnaryCallSettings<com.google.cloud.kms.v1.UpdateCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion> updateCryptoKeyVersionSettings()

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

encryptSettings

public UnaryCallSettings<com.google.cloud.kms.v1.EncryptRequest,com.google.cloud.kms.v1.EncryptResponse> encryptSettings()

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

decryptSettings

public UnaryCallSettings<com.google.cloud.kms.v1.DecryptRequest,com.google.cloud.kms.v1.DecryptResponse> decryptSettings()

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

updateCryptoKeyPrimaryVersionSettings

public UnaryCallSettings<com.google.cloud.kms.v1.UpdateCryptoKeyPrimaryVersionRequest,com.google.cloud.kms.v1.CryptoKey> updateCryptoKeyPrimaryVersionSettings()

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

destroyCryptoKeyVersionSettings

public UnaryCallSettings<com.google.cloud.kms.v1.DestroyCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion> destroyCryptoKeyVersionSettings()

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

restoreCryptoKeyVersionSettings

public UnaryCallSettings<com.google.cloud.kms.v1.RestoreCryptoKeyVersionRequest,com.google.cloud.kms.v1.CryptoKeyVersion> restoreCryptoKeyVersionSettings()

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

getPublicKeySettings

public UnaryCallSettings<com.google.cloud.kms.v1.GetPublicKeyRequest,com.google.cloud.kms.v1.PublicKey> getPublicKeySettings()

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

asymmetricDecryptSettings

public UnaryCallSettings<com.google.cloud.kms.v1.AsymmetricDecryptRequest,com.google.cloud.kms.v1.AsymmetricDecryptResponse> asymmetricDecryptSettings()

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

asymmetricSignSettings

public UnaryCallSettings<com.google.cloud.kms.v1.AsymmetricSignRequest,com.google.cloud.kms.v1.AsymmetricSignResponse> asymmetricSignSettings()

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

setIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final KeyManagementServiceSettings create(KeyManagementServiceStubSettings stub)
                                                 throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static KeyManagementServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static KeyManagementServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public KeyManagementServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<KeyManagementServiceSettings>