Google Cloud Key Management Service v1 API - Class KeyManagementServiceSettings (3.20.0) 

public sealed class KeyManagementServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class KeyManagementServiceSettings.

Settings for KeyManagementServiceClient instances.

Inheritance

object > ServiceSettingsBase > KeyManagementServiceSettings

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

KeyManagementServiceSettings()

public KeyManagementServiceSettings()

Constructs a new KeyManagementServiceSettings object with default settings.

Properties

AsymmetricDecryptSettings

public CallSettings AsymmetricDecryptSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.AsymmetricDecrypt and KeyManagementServiceClient.AsymmetricDecryptAsync .

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

AsymmetricSignSettings

public CallSettings AsymmetricSignSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.AsymmetricSign and KeyManagementServiceClient.AsymmetricSignAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

CreateCryptoKeySettings

public CallSettings CreateCryptoKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.CreateCryptoKey and KeyManagementServiceClient.CreateCryptoKeyAsync .

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

CreateCryptoKeyVersionSettings

public CallSettings CreateCryptoKeyVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.CreateCryptoKeyVersion and KeyManagementServiceClient.CreateCryptoKeyVersionAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

CreateImportJobSettings

public CallSettings CreateImportJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.CreateImportJob and KeyManagementServiceClient.CreateImportJobAsync .

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

CreateKeyRingSettings

public CallSettings CreateKeyRingSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.CreateKeyRing and KeyManagementServiceClient.CreateKeyRingAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

DecapsulateSettings

public CallSettings DecapsulateSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.Decapsulate and KeyManagementServiceClient.DecapsulateAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

DecryptSettings

public CallSettings DecryptSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.Decrypt and KeyManagementServiceClient.DecryptAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

DestroyCryptoKeyVersionSettings

public CallSettings DestroyCryptoKeyVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.DestroyCryptoKeyVersion and KeyManagementServiceClient.DestroyCryptoKeyVersionAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

EncryptSettings

public CallSettings EncryptSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.Encrypt and KeyManagementServiceClient.EncryptAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

GenerateRandomBytesSettings

public CallSettings GenerateRandomBytesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.GenerateRandomBytes and KeyManagementServiceClient.GenerateRandomBytesAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

GetCryptoKeySettings

public CallSettings GetCryptoKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.GetCryptoKey and KeyManagementServiceClient.GetCryptoKeyAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

GetCryptoKeyVersionSettings

public CallSettings GetCryptoKeyVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.GetCryptoKeyVersion and KeyManagementServiceClient.GetCryptoKeyVersionAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

GetImportJobSettings

public CallSettings GetImportJobSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.GetImportJob and KeyManagementServiceClient.GetImportJobAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

GetKeyRingSettings

public CallSettings GetKeyRingSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.GetKeyRing and KeyManagementServiceClient.GetKeyRingAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

GetPublicKeySettings

public CallSettings GetPublicKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.GetPublicKey and KeyManagementServiceClient.GetPublicKeyAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

The settings to use for the IAMPolicyClient associated with the client.

Property Value
Type Description
IAMPolicySettings

ImportCryptoKeyVersionSettings

public CallSettings ImportCryptoKeyVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.ImportCryptoKeyVersion and KeyManagementServiceClient.ImportCryptoKeyVersionAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

ListCryptoKeyVersionsSettings

public CallSettings ListCryptoKeyVersionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.ListCryptoKeyVersions and KeyManagementServiceClient.ListCryptoKeyVersionsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

ListCryptoKeysSettings

public CallSettings ListCryptoKeysSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.ListCryptoKeys and KeyManagementServiceClient.ListCryptoKeysAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

ListImportJobsSettings

public CallSettings ListImportJobsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.ListImportJobs and KeyManagementServiceClient.ListImportJobsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

ListKeyRingsSettings

public CallSettings ListKeyRingsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.ListKeyRings and KeyManagementServiceClient.ListKeyRingsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type Description
LocationsSettings

MacSignSettings

public CallSettings MacSignSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.MacSign and KeyManagementServiceClient.MacSignAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

MacVerifySettings

public CallSettings MacVerifySettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.MacVerify and KeyManagementServiceClient.MacVerifyAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

RawDecryptSettings

public CallSettings RawDecryptSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.RawDecrypt and KeyManagementServiceClient.RawDecryptAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

RawEncryptSettings

public CallSettings RawEncryptSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.RawEncrypt and KeyManagementServiceClient.RawEncryptAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

RestoreCryptoKeyVersionSettings

public CallSettings RestoreCryptoKeyVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.RestoreCryptoKeyVersion and KeyManagementServiceClient.RestoreCryptoKeyVersionAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

UpdateCryptoKeyPrimaryVersionSettings

public CallSettings UpdateCryptoKeyPrimaryVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersion and KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersionAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

UpdateCryptoKeySettings

public CallSettings UpdateCryptoKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.UpdateCryptoKey and KeyManagementServiceClient.UpdateCryptoKeyAsync .

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

UpdateCryptoKeyVersionSettings

public CallSettings UpdateCryptoKeyVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to KeyManagementServiceClient.UpdateCryptoKeyVersion and KeyManagementServiceClient.UpdateCryptoKeyVersionAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 100 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: 5
  • Retriable status codes: Unavailable, DeadlineExceeded.
  • Timeout: 60 seconds.

Methods

Clone()

public KeyManagementServiceSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type Description
KeyManagementServiceSettings

A deep clone of this KeyManagementServiceSettings object.

GetDefault()

public static KeyManagementServiceSettings GetDefault()

Get a new instance of the default KeyManagementServiceSettings.

Returns
Type Description
KeyManagementServiceSettings

A new instance of the default KeyManagementServiceSettings.