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 for illustrative purposes only.
// It may require modifications to work in your environment.
KeyManagementServiceSettings.Builder keyManagementServiceSettingsBuilder =
KeyManagementServiceSettings.newBuilder();
keyManagementServiceSettingsBuilder
.getKeyRingSettings()
.setRetrySettings(
keyManagementServiceSettingsBuilder
.getKeyRingSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
KeyManagementServiceSettings keyManagementServiceSettings =
keyManagementServiceSettingsBuilder.build();
Static Methods
create(KeyManagementServiceStubSettings stub)
public static final KeyManagementServiceSettings create(KeyManagementServiceStubSettings stub)| Name | Description |
| stub | KeyManagementServiceStubSettings |
| Type | Description |
| KeyManagementServiceSettings |
| Type | Description |
| IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static KeyManagementServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| KeyManagementServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static KeyManagementServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| KeyManagementServiceSettings.Builder |
Constructors
KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)
protected KeyManagementServiceSettings(KeyManagementServiceSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | KeyManagementServiceSettings.Builder |
Methods
asymmetricDecryptSettings()
public UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse> asymmetricDecryptSettings()Returns the object with the settings used for calls to asymmetricDecrypt.
| Type | Description |
| UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse> |
asymmetricSignSettings()
public UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse> asymmetricSignSettings()Returns the object with the settings used for calls to asymmetricSign.
| Type | Description |
| UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse> |
createCryptoKeySettings()
public UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey> createCryptoKeySettings()Returns the object with the settings used for calls to createCryptoKey.
| Type | Description |
| UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey> |
createCryptoKeyVersionSettings()
public UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion> createCryptoKeyVersionSettings()Returns the object with the settings used for calls to createCryptoKeyVersion.
| Type | Description |
| UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion> |
createImportJobSettings()
public UnaryCallSettings<CreateImportJobRequest,ImportJob> createImportJobSettings()Returns the object with the settings used for calls to createImportJob.
| Type | Description |
| UnaryCallSettings<CreateImportJobRequest,ImportJob> |
createKeyRingSettings()
public UnaryCallSettings<CreateKeyRingRequest,KeyRing> createKeyRingSettings()Returns the object with the settings used for calls to createKeyRing.
| Type | Description |
| UnaryCallSettings<CreateKeyRingRequest,KeyRing> |
decryptSettings()
public UnaryCallSettings<DecryptRequest,DecryptResponse> decryptSettings()Returns the object with the settings used for calls to decrypt.
| Type | Description |
| UnaryCallSettings<DecryptRequest,DecryptResponse> |
destroyCryptoKeyVersionSettings()
public UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion> destroyCryptoKeyVersionSettings()Returns the object with the settings used for calls to destroyCryptoKeyVersion.
| Type | Description |
| UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion> |
encryptSettings()
public UnaryCallSettings<EncryptRequest,EncryptResponse> encryptSettings()Returns the object with the settings used for calls to encrypt.
| Type | Description |
| UnaryCallSettings<EncryptRequest,EncryptResponse> |
generateRandomBytesSettings()
public UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse> generateRandomBytesSettings()Returns the object with the settings used for calls to generateRandomBytes.
| Type | Description |
| UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse> |
getCryptoKeySettings()
public UnaryCallSettings<GetCryptoKeyRequest,CryptoKey> getCryptoKeySettings()Returns the object with the settings used for calls to getCryptoKey.
| Type | Description |
| UnaryCallSettings<GetCryptoKeyRequest,CryptoKey> |
getCryptoKeyVersionSettings()
public UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion> getCryptoKeyVersionSettings()Returns the object with the settings used for calls to getCryptoKeyVersion.
| Type | Description |
| UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion> |
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy.
| 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.
| Type | Description |
| UnaryCallSettings<GetImportJobRequest,ImportJob> |
getKeyRingSettings()
public UnaryCallSettings<GetKeyRingRequest,KeyRing> getKeyRingSettings()Returns the object with the settings used for calls to getKeyRing.
| Type | Description |
| UnaryCallSettings<GetKeyRingRequest,KeyRing> |
getPublicKeySettings()
public UnaryCallSettings<GetPublicKeyRequest,PublicKey> getPublicKeySettings()Returns the object with the settings used for calls to getPublicKey.
| Type | Description |
| UnaryCallSettings<GetPublicKeyRequest,PublicKey> |
importCryptoKeyVersionSettings()
public UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion> importCryptoKeyVersionSettings()Returns the object with the settings used for calls to importCryptoKeyVersion.
| Type | Description |
| UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion> |
listCryptoKeyVersionsSettings()
public PagedCallSettings<ListCryptoKeyVersionsRequest,ListCryptoKeyVersionsResponse,KeyManagementServiceClient.ListCryptoKeyVersionsPagedResponse> listCryptoKeyVersionsSettings()Returns the object with the settings used for calls to listCryptoKeyVersions.
| 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.
| 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.
| 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.
| Type | Description |
| PagedCallSettings<ListKeyRingsRequest,ListKeyRingsResponse,ListKeyRingsPagedResponse> |
macSignSettings()
public UnaryCallSettings<MacSignRequest,MacSignResponse> macSignSettings()Returns the object with the settings used for calls to macSign.
| Type | Description |
| UnaryCallSettings<MacSignRequest,MacSignResponse> |
macVerifySettings()
public UnaryCallSettings<MacVerifyRequest,MacVerifyResponse> macVerifySettings()Returns the object with the settings used for calls to macVerify.
| Type | Description |
| UnaryCallSettings<MacVerifyRequest,MacVerifyResponse> |
restoreCryptoKeyVersionSettings()
public UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion> restoreCryptoKeyVersionSettings()Returns the object with the settings used for calls to restoreCryptoKeyVersion.
| Type | Description |
| UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion> |
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy.
| 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.
| 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.
| Type | Description |
| KeyManagementServiceSettings.Builder |
updateCryptoKeyPrimaryVersionSettings()
public UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey> updateCryptoKeyPrimaryVersionSettings()Returns the object with the settings used for calls to updateCryptoKeyPrimaryVersion.
| Type | Description |
| UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey> |
updateCryptoKeySettings()
public UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey> updateCryptoKeySettings()Returns the object with the settings used for calls to updateCryptoKey.
| Type | Description |
| UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey> |
updateCryptoKeyVersionSettings()
public UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion> updateCryptoKeyVersionSettings()Returns the object with the settings used for calls to updateCryptoKeyVersion.
| Type | Description |
| UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion> |