Package com.google.cloud.kms.v1

Class KeyManagementServiceSettings

  • @Generated("by gapic-generator-java")
public class KeyManagementServiceSettings
extends com.google.api.gax.rpc.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();

    • Method Detail

      • 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.

      • 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.

      • 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.

      • defaultExecutorProviderBuilder

        public static com.google.api.gax.core.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 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()

      • defaultApiClientHeaderProviderBuilder

        @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()