com.google.cloud.kms.v1.stub

Class KeyManagementServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<KeyManagementServiceStubSettings>

com.google.cloud.kms.v1.stub.KeyManagementServiceStubSettings

@Generated(value="by gapic-generator-java")
public class KeyManagementServiceStubSettings
extends com.google.api.gax.rpc.StubSettings<KeyManagementServiceStubSettings>

Settings class to configure an instance of KeyManagementServiceStub.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getKeyRing:

 // 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
 KeyManagementServiceStubSettings.Builder keyManagementServiceSettingsBuilder =
     KeyManagementServiceStubSettings.newBuilder();
 keyManagementServiceSettingsBuilder
     .getKeyRingSettings()
     .setRetrySettings(
         keyManagementServiceSettingsBuilder
             .getKeyRingSettings()
             .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());
 KeyManagementServiceStubSettings keyManagementServiceSettings =
     keyManagementServiceSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse>	asymmetricDecryptSettings() Returns the object with the settings used for calls to asymmetricDecrypt.
com.google.api.gax.rpc.UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse>	asymmetricSignSettings() Returns the object with the settings used for calls to asymmetricSign.
com.google.api.gax.rpc.UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey>	createCryptoKeySettings() Returns the object with the settings used for calls to createCryptoKey.
com.google.api.gax.rpc.UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion>	createCryptoKeyVersionSettings() Returns the object with the settings used for calls to createCryptoKeyVersion.
com.google.api.gax.rpc.UnaryCallSettings<CreateImportJobRequest,ImportJob>	createImportJobSettings() Returns the object with the settings used for calls to createImportJob.
com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRingRequest,KeyRing>	createKeyRingSettings() Returns the object with the settings used for calls to createKeyRing.
KeyManagementServiceStub	createStub()
com.google.api.gax.rpc.UnaryCallSettings<DecryptRequest,DecryptResponse>	decryptSettings() Returns the object with the settings used for calls to decrypt.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion>	destroyCryptoKeyVersionSettings() Returns the object with the settings used for calls to destroyCryptoKeyVersion.
com.google.api.gax.rpc.UnaryCallSettings<EncryptRequest,EncryptResponse>	encryptSettings() Returns the object with the settings used for calls to encrypt.
com.google.api.gax.rpc.UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse>	generateRandomBytesSettings() Returns the object with the settings used for calls to generateRandomBytes.
com.google.api.gax.rpc.UnaryCallSettings<GetCryptoKeyRequest,CryptoKey>	getCryptoKeySettings() Returns the object with the settings used for calls to getCryptoKey.
com.google.api.gax.rpc.UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion>	getCryptoKeyVersionSettings() Returns the object with the settings used for calls to getCryptoKeyVersion.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetImportJobRequest,ImportJob>	getImportJobSettings() Returns the object with the settings used for calls to getImportJob.
com.google.api.gax.rpc.UnaryCallSettings<GetKeyRingRequest,KeyRing>	getKeyRingSettings() Returns the object with the settings used for calls to getKeyRing.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
com.google.api.gax.rpc.UnaryCallSettings<GetPublicKeyRequest,PublicKey>	getPublicKeySettings() Returns the object with the settings used for calls to getPublicKey.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion>	importCryptoKeyVersionSettings() Returns the object with the settings used for calls to importCryptoKeyVersion.
com.google.api.gax.rpc.PagedCallSettings<ListCryptoKeysRequest,ListCryptoKeysResponse,KeyManagementServiceClient.ListCryptoKeysPagedResponse>	listCryptoKeysSettings() Returns the object with the settings used for calls to listCryptoKeys.
com.google.api.gax.rpc.PagedCallSettings<ListCryptoKeyVersionsRequest,ListCryptoKeyVersionsResponse,KeyManagementServiceClient.ListCryptoKeyVersionsPagedResponse>	listCryptoKeyVersionsSettings() Returns the object with the settings used for calls to listCryptoKeyVersions.
com.google.api.gax.rpc.PagedCallSettings<ListImportJobsRequest,ListImportJobsResponse,KeyManagementServiceClient.ListImportJobsPagedResponse>	listImportJobsSettings() Returns the object with the settings used for calls to listImportJobs.
com.google.api.gax.rpc.PagedCallSettings<ListKeyRingsRequest,ListKeyRingsResponse,KeyManagementServiceClient.ListKeyRingsPagedResponse>	listKeyRingsSettings() Returns the object with the settings used for calls to listKeyRings.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,KeyManagementServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.UnaryCallSettings<MacSignRequest,MacSignResponse>	macSignSettings() Returns the object with the settings used for calls to macSign.
com.google.api.gax.rpc.UnaryCallSettings<MacVerifyRequest,MacVerifyResponse>	macVerifySettings() Returns the object with the settings used for calls to macVerify.
static KeyManagementServiceStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static KeyManagementServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static KeyManagementServiceStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<RawDecryptRequest,RawDecryptResponse>	rawDecryptSettings() Returns the object with the settings used for calls to rawDecrypt.
com.google.api.gax.rpc.UnaryCallSettings<RawEncryptRequest,RawEncryptResponse>	rawEncryptSettings() Returns the object with the settings used for calls to rawEncrypt.
com.google.api.gax.rpc.UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion>	restoreCryptoKeyVersionSettings() Returns the object with the settings used for calls to restoreCryptoKeyVersion.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
KeyManagementServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey>	updateCryptoKeyPrimaryVersionSettings() Returns the object with the settings used for calls to updateCryptoKeyPrimaryVersion.
com.google.api.gax.rpc.UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey>	updateCryptoKeySettings() Returns the object with the settings used for calls to updateCryptoKey.
com.google.api.gax.rpc.UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion>	updateCryptoKeyVersionSettings() Returns the object with the settings used for calls to updateCryptoKeyVersion.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyManagementServiceStubSettings

protected KeyManagementServiceStubSettings(KeyManagementServiceStubSettings.Builder settingsBuilder)
                                    throws IOException

Throws:

IOException

Method Detail

listKeyRingsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListKeyRingsRequest,ListKeyRingsResponse,KeyManagementServiceClient.ListKeyRingsPagedResponse> listKeyRingsSettings()

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

listCryptoKeysSettings

public com.google.api.gax.rpc.PagedCallSettings<ListCryptoKeysRequest,ListCryptoKeysResponse,KeyManagementServiceClient.ListCryptoKeysPagedResponse> listCryptoKeysSettings()

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

listCryptoKeyVersionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListCryptoKeyVersionsRequest,ListCryptoKeyVersionsResponse,KeyManagementServiceClient.ListCryptoKeyVersionsPagedResponse> listCryptoKeyVersionsSettings()

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

listImportJobsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListImportJobsRequest,ListImportJobsResponse,KeyManagementServiceClient.ListImportJobsPagedResponse> listImportJobsSettings()

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

getKeyRingSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetKeyRingRequest,KeyRing> getKeyRingSettings()

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

getCryptoKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetCryptoKeyRequest,CryptoKey> getCryptoKeySettings()

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

getCryptoKeyVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion> getCryptoKeyVersionSettings()

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

getPublicKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetPublicKeyRequest,PublicKey> getPublicKeySettings()

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

getImportJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetImportJobRequest,ImportJob> getImportJobSettings()

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

createKeyRingSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRingRequest,KeyRing> createKeyRingSettings()

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

createCryptoKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey> createCryptoKeySettings()

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

createCryptoKeyVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion> createCryptoKeyVersionSettings()

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

importCryptoKeyVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion> importCryptoKeyVersionSettings()

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

createImportJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateImportJobRequest,ImportJob> createImportJobSettings()

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

updateCryptoKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey> updateCryptoKeySettings()

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

updateCryptoKeyVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion> updateCryptoKeyVersionSettings()

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

updateCryptoKeyPrimaryVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey> updateCryptoKeyPrimaryVersionSettings()

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

destroyCryptoKeyVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion> destroyCryptoKeyVersionSettings()

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

restoreCryptoKeyVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion> restoreCryptoKeyVersionSettings()

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

encryptSettings

public com.google.api.gax.rpc.UnaryCallSettings<EncryptRequest,EncryptResponse> encryptSettings()

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

decryptSettings

public com.google.api.gax.rpc.UnaryCallSettings<DecryptRequest,DecryptResponse> decryptSettings()

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

rawEncryptSettings

public com.google.api.gax.rpc.UnaryCallSettings<RawEncryptRequest,RawEncryptResponse> rawEncryptSettings()

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

rawDecryptSettings

public com.google.api.gax.rpc.UnaryCallSettings<RawDecryptRequest,RawDecryptResponse> rawDecryptSettings()

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

asymmetricSignSettings

public com.google.api.gax.rpc.UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse> asymmetricSignSettings()

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

asymmetricDecryptSettings

public com.google.api.gax.rpc.UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse> asymmetricDecryptSettings()

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

macSignSettings

public com.google.api.gax.rpc.UnaryCallSettings<MacSignRequest,MacSignResponse> macSignSettings()

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

macVerifySettings

public com.google.api.gax.rpc.UnaryCallSettings<MacVerifyRequest,MacVerifyResponse> macVerifySettings()

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

generateRandomBytesSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse> generateRandomBytesSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,KeyManagementServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.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 com.google.api.gax.rpc.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 com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

createStub

public KeyManagementServiceStub createStub()
                                    throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<KeyManagementServiceStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultGrpcApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

defaultHttpJsonApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static KeyManagementServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static KeyManagementServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static KeyManagementServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public KeyManagementServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<KeyManagementServiceStubSettings>