Class KeyManagementServiceStubSettings (2.8.0)

public class KeyManagementServiceStubSettings extends 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 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
 KeyManagementServiceStubSettings.Builder keyManagementServiceSettingsBuilder =
     KeyManagementServiceStubSettings.newBuilder();
 keyManagementServiceSettingsBuilder
     .getKeyRingSettings()
     .setRetrySettings(
         keyManagementServiceSettingsBuilder.getKeyRingSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 KeyManagementServiceStubSettings keyManagementServiceSettings =
     keyManagementServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > KeyManagementServiceStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
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

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static KeyManagementServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static KeyManagementServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

newHttpJsonBuilder()

public static KeyManagementServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Constructors

KeyManagementServiceStubSettings(KeyManagementServiceStubSettings.Builder settingsBuilder)

protected KeyManagementServiceStubSettings(KeyManagementServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderKeyManagementServiceStubSettings.Builder

Methods

asymmetricDecryptSettings()

public UnaryCallSettings<AsymmetricDecryptRequest,AsymmetricDecryptResponse> asymmetricDecryptSettings()

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

Returns

asymmetricSignSettings()

public UnaryCallSettings<AsymmetricSignRequest,AsymmetricSignResponse> asymmetricSignSettings()

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

Returns

createCryptoKeySettings()

public UnaryCallSettings<CreateCryptoKeyRequest,CryptoKey> createCryptoKeySettings()

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

Returns

createCryptoKeyVersionSettings()

public UnaryCallSettings<CreateCryptoKeyVersionRequest,CryptoKeyVersion> createCryptoKeyVersionSettings()

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

Returns

createImportJobSettings()

public UnaryCallSettings<CreateImportJobRequest,ImportJob> createImportJobSettings()

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

Returns

createKeyRingSettings()

public UnaryCallSettings<CreateKeyRingRequest,KeyRing> createKeyRingSettings()

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

Returns

createStub()

public KeyManagementServiceStub createStub()
Returns Exceptions
TypeDescription
IOException

decryptSettings()

public UnaryCallSettings<DecryptRequest,DecryptResponse> decryptSettings()

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

Returns

destroyCryptoKeyVersionSettings()

public UnaryCallSettings<DestroyCryptoKeyVersionRequest,CryptoKeyVersion> destroyCryptoKeyVersionSettings()

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

Returns

encryptSettings()

public UnaryCallSettings<EncryptRequest,EncryptResponse> encryptSettings()

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

Returns

generateRandomBytesSettings()

public UnaryCallSettings<GenerateRandomBytesRequest,GenerateRandomBytesResponse> generateRandomBytesSettings()

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

Returns

getCryptoKeySettings()

public UnaryCallSettings<GetCryptoKeyRequest,CryptoKey> getCryptoKeySettings()

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

Returns

getCryptoKeyVersionSettings()

public UnaryCallSettings<GetCryptoKeyVersionRequest,CryptoKeyVersion> getCryptoKeyVersionSettings()

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

Returns

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

getKeyRingSettings()

public UnaryCallSettings<GetKeyRingRequest,KeyRing> getKeyRingSettings()

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

Returns

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

importCryptoKeyVersionSettings()

public UnaryCallSettings<ImportCryptoKeyVersionRequest,CryptoKeyVersion> importCryptoKeyVersionSettings()

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

Returns

listCryptoKeyVersionsSettings()

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

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

Returns

listCryptoKeysSettings()

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

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

Returns

listImportJobsSettings()

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

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

Returns

listKeyRingsSettings()

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

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

Returns

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

macVerifySettings()

public UnaryCallSettings<MacVerifyRequest,MacVerifyResponse> macVerifySettings()

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

Returns

restoreCryptoKeyVersionSettings()

public UnaryCallSettings<RestoreCryptoKeyVersionRequest,CryptoKeyVersion> restoreCryptoKeyVersionSettings()

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

Returns

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

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

Returns Overrides

updateCryptoKeyPrimaryVersionSettings()

public UnaryCallSettings<UpdateCryptoKeyPrimaryVersionRequest,CryptoKey> updateCryptoKeyPrimaryVersionSettings()

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

Returns

updateCryptoKeySettings()

public UnaryCallSettings<UpdateCryptoKeyRequest,CryptoKey> updateCryptoKeySettings()

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

Returns

updateCryptoKeyVersionSettings()

public UnaryCallSettings<UpdateCryptoKeyVersionRequest,CryptoKeyVersion> updateCryptoKeyVersionSettings()

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

Returns