Class KeyManagementServiceClientImpl (2.9.0)

Version 2.9.0

• 3.15.0 (latest)
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public sealed class KeyManagementServiceClientImpl : KeyManagementServiceClient

KeyManagementService client wrapper implementation, for convenient use.

Inheritance

Object > KeyManagementServiceClient > KeyManagementServiceClientImpl

Inherited Members

KeyManagementServiceClient.SetIamPolicyAsync(IResourceName, Policy, CallSettings)

KeyManagementServiceClient.SetIamPolicyAsync(IResourceName, Policy, CancellationToken)

KeyManagementServiceClient.SetIamPolicy(IResourceName, Policy, CallSettings)

KeyManagementServiceClient.SetIamPolicyAsync(String, Policy, CallSettings)

KeyManagementServiceClient.SetIamPolicyAsync(String, Policy, CancellationToken)

KeyManagementServiceClient.SetIamPolicy(String, Policy, CallSettings)

KeyManagementServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

KeyManagementServiceClient.GetIamPolicyAsync(IResourceName, CallSettings)

KeyManagementServiceClient.GetIamPolicyAsync(IResourceName, CancellationToken)

KeyManagementServiceClient.GetIamPolicy(IResourceName, CallSettings)

KeyManagementServiceClient.GetIamPolicyAsync(String, CallSettings)

KeyManagementServiceClient.GetIamPolicyAsync(String, CancellationToken)

KeyManagementServiceClient.GetIamPolicy(String, CallSettings)

KeyManagementServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

KeyManagementServiceClient.TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CallSettings)

KeyManagementServiceClient.TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CancellationToken)

KeyManagementServiceClient.TestIamPermissions(IResourceName, IEnumerable<String>, CallSettings)

KeyManagementServiceClient.TestIamPermissionsAsync(String, IEnumerable<String>, CallSettings)

KeyManagementServiceClient.TestIamPermissionsAsync(String, IEnumerable<String>, CancellationToken)

KeyManagementServiceClient.TestIamPermissions(String, IEnumerable<String>, CallSettings)

KeyManagementServiceClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

KeyManagementServiceClient.DefaultEndpoint

KeyManagementServiceClient.DefaultScopes

KeyManagementServiceClient.CreateAsync(CancellationToken)

KeyManagementServiceClient.Create()

KeyManagementServiceClient.ShutdownDefaultChannelsAsync()

KeyManagementServiceClient.ListKeyRings(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListKeyRingsAsync(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListKeyRings(LocationName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListKeyRingsAsync(LocationName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeys(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeysAsync(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeys(KeyRingName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeysAsync(KeyRingName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersions(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersionsAsync(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersions(CryptoKeyName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersionsAsync(CryptoKeyName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListImportJobs(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListImportJobsAsync(String, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListImportJobs(KeyRingName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.ListImportJobsAsync(KeyRingName, String, Nullable<Int32>, CallSettings)

KeyManagementServiceClient.GetKeyRingAsync(GetKeyRingRequest, CancellationToken)

KeyManagementServiceClient.GetKeyRing(String, CallSettings)

KeyManagementServiceClient.GetKeyRingAsync(String, CallSettings)

KeyManagementServiceClient.GetKeyRingAsync(String, CancellationToken)

KeyManagementServiceClient.GetKeyRing(KeyRingName, CallSettings)

KeyManagementServiceClient.GetKeyRingAsync(KeyRingName, CallSettings)

KeyManagementServiceClient.GetKeyRingAsync(KeyRingName, CancellationToken)

KeyManagementServiceClient.GetCryptoKeyAsync(GetCryptoKeyRequest, CancellationToken)

KeyManagementServiceClient.GetCryptoKey(String, CallSettings)

KeyManagementServiceClient.GetCryptoKeyAsync(String, CallSettings)

KeyManagementServiceClient.GetCryptoKeyAsync(String, CancellationToken)

KeyManagementServiceClient.GetCryptoKey(CryptoKeyName, CallSettings)

KeyManagementServiceClient.GetCryptoKeyAsync(CryptoKeyName, CallSettings)

KeyManagementServiceClient.GetCryptoKeyAsync(CryptoKeyName, CancellationToken)

KeyManagementServiceClient.GetCryptoKeyVersionAsync(GetCryptoKeyVersionRequest, CancellationToken)

KeyManagementServiceClient.GetCryptoKeyVersion(String, CallSettings)

KeyManagementServiceClient.GetCryptoKeyVersionAsync(String, CallSettings)

KeyManagementServiceClient.GetCryptoKeyVersionAsync(String, CancellationToken)

KeyManagementServiceClient.GetCryptoKeyVersion(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.GetCryptoKeyVersionAsync(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.GetCryptoKeyVersionAsync(CryptoKeyVersionName, CancellationToken)

KeyManagementServiceClient.GetPublicKeyAsync(GetPublicKeyRequest, CancellationToken)

KeyManagementServiceClient.GetPublicKey(String, CallSettings)

KeyManagementServiceClient.GetPublicKeyAsync(String, CallSettings)

KeyManagementServiceClient.GetPublicKeyAsync(String, CancellationToken)

KeyManagementServiceClient.GetPublicKey(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.GetPublicKeyAsync(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.GetPublicKeyAsync(CryptoKeyVersionName, CancellationToken)

KeyManagementServiceClient.GetImportJobAsync(GetImportJobRequest, CancellationToken)

KeyManagementServiceClient.GetImportJob(String, CallSettings)

KeyManagementServiceClient.GetImportJobAsync(String, CallSettings)

KeyManagementServiceClient.GetImportJobAsync(String, CancellationToken)

KeyManagementServiceClient.GetImportJob(ImportJobName, CallSettings)

KeyManagementServiceClient.GetImportJobAsync(ImportJobName, CallSettings)

KeyManagementServiceClient.GetImportJobAsync(ImportJobName, CancellationToken)

KeyManagementServiceClient.CreateKeyRingAsync(CreateKeyRingRequest, CancellationToken)

KeyManagementServiceClient.CreateKeyRing(String, String, KeyRing, CallSettings)

KeyManagementServiceClient.CreateKeyRingAsync(String, String, KeyRing, CallSettings)

KeyManagementServiceClient.CreateKeyRingAsync(String, String, KeyRing, CancellationToken)

KeyManagementServiceClient.CreateKeyRing(LocationName, String, KeyRing, CallSettings)

KeyManagementServiceClient.CreateKeyRingAsync(LocationName, String, KeyRing, CallSettings)

KeyManagementServiceClient.CreateKeyRingAsync(LocationName, String, KeyRing, CancellationToken)

KeyManagementServiceClient.CreateCryptoKeyAsync(CreateCryptoKeyRequest, CancellationToken)

KeyManagementServiceClient.CreateCryptoKey(String, String, CryptoKey, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyAsync(String, String, CryptoKey, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyAsync(String, String, CryptoKey, CancellationToken)

KeyManagementServiceClient.CreateCryptoKey(KeyRingName, String, CryptoKey, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyAsync(KeyRingName, String, CryptoKey, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyAsync(KeyRingName, String, CryptoKey, CancellationToken)

KeyManagementServiceClient.CreateCryptoKeyVersionAsync(CreateCryptoKeyVersionRequest, CancellationToken)

KeyManagementServiceClient.CreateCryptoKeyVersion(String, CryptoKeyVersion, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyVersionAsync(String, CryptoKeyVersion, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyVersionAsync(String, CryptoKeyVersion, CancellationToken)

KeyManagementServiceClient.CreateCryptoKeyVersion(CryptoKeyName, CryptoKeyVersion, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyVersionAsync(CryptoKeyName, CryptoKeyVersion, CallSettings)

KeyManagementServiceClient.CreateCryptoKeyVersionAsync(CryptoKeyName, CryptoKeyVersion, CancellationToken)

KeyManagementServiceClient.ImportCryptoKeyVersionAsync(ImportCryptoKeyVersionRequest, CancellationToken)

KeyManagementServiceClient.CreateImportJobAsync(CreateImportJobRequest, CancellationToken)

KeyManagementServiceClient.CreateImportJob(String, String, ImportJob, CallSettings)

KeyManagementServiceClient.CreateImportJobAsync(String, String, ImportJob, CallSettings)

KeyManagementServiceClient.CreateImportJobAsync(String, String, ImportJob, CancellationToken)

KeyManagementServiceClient.CreateImportJob(KeyRingName, String, ImportJob, CallSettings)

KeyManagementServiceClient.CreateImportJobAsync(KeyRingName, String, ImportJob, CallSettings)

KeyManagementServiceClient.CreateImportJobAsync(KeyRingName, String, ImportJob, CancellationToken)

KeyManagementServiceClient.UpdateCryptoKeyAsync(UpdateCryptoKeyRequest, CancellationToken)

KeyManagementServiceClient.UpdateCryptoKey(CryptoKey, FieldMask, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyAsync(CryptoKey, FieldMask, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyAsync(CryptoKey, FieldMask, CancellationToken)

KeyManagementServiceClient.UpdateCryptoKeyVersionAsync(UpdateCryptoKeyVersionRequest, CancellationToken)

KeyManagementServiceClient.UpdateCryptoKeyVersion(CryptoKeyVersion, FieldMask, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyVersionAsync(CryptoKeyVersion, FieldMask, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyVersionAsync(CryptoKeyVersion, FieldMask, CancellationToken)

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersionAsync(UpdateCryptoKeyPrimaryVersionRequest, CancellationToken)

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersion(String, String, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersionAsync(String, String, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersionAsync(String, String, CancellationToken)

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersion(CryptoKeyName, String, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersionAsync(CryptoKeyName, String, CallSettings)

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersionAsync(CryptoKeyName, String, CancellationToken)

KeyManagementServiceClient.DestroyCryptoKeyVersionAsync(DestroyCryptoKeyVersionRequest, CancellationToken)

KeyManagementServiceClient.DestroyCryptoKeyVersion(String, CallSettings)

KeyManagementServiceClient.DestroyCryptoKeyVersionAsync(String, CallSettings)

KeyManagementServiceClient.DestroyCryptoKeyVersionAsync(String, CancellationToken)

KeyManagementServiceClient.DestroyCryptoKeyVersion(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.DestroyCryptoKeyVersionAsync(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.DestroyCryptoKeyVersionAsync(CryptoKeyVersionName, CancellationToken)

KeyManagementServiceClient.RestoreCryptoKeyVersionAsync(RestoreCryptoKeyVersionRequest, CancellationToken)

KeyManagementServiceClient.RestoreCryptoKeyVersion(String, CallSettings)

KeyManagementServiceClient.RestoreCryptoKeyVersionAsync(String, CallSettings)

KeyManagementServiceClient.RestoreCryptoKeyVersionAsync(String, CancellationToken)

KeyManagementServiceClient.RestoreCryptoKeyVersion(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.RestoreCryptoKeyVersionAsync(CryptoKeyVersionName, CallSettings)

KeyManagementServiceClient.RestoreCryptoKeyVersionAsync(CryptoKeyVersionName, CancellationToken)

KeyManagementServiceClient.EncryptAsync(EncryptRequest, CancellationToken)

KeyManagementServiceClient.Encrypt(String, ByteString, CallSettings)

KeyManagementServiceClient.EncryptAsync(String, ByteString, CallSettings)

KeyManagementServiceClient.EncryptAsync(String, ByteString, CancellationToken)

KeyManagementServiceClient.Encrypt(IResourceName, ByteString, CallSettings)

KeyManagementServiceClient.EncryptAsync(IResourceName, ByteString, CallSettings)

KeyManagementServiceClient.EncryptAsync(IResourceName, ByteString, CancellationToken)

KeyManagementServiceClient.DecryptAsync(DecryptRequest, CancellationToken)

KeyManagementServiceClient.Decrypt(String, ByteString, CallSettings)

KeyManagementServiceClient.DecryptAsync(String, ByteString, CallSettings)

KeyManagementServiceClient.DecryptAsync(String, ByteString, CancellationToken)

KeyManagementServiceClient.Decrypt(CryptoKeyName, ByteString, CallSettings)

KeyManagementServiceClient.DecryptAsync(CryptoKeyName, ByteString, CallSettings)

KeyManagementServiceClient.DecryptAsync(CryptoKeyName, ByteString, CancellationToken)

KeyManagementServiceClient.AsymmetricSignAsync(AsymmetricSignRequest, CancellationToken)

KeyManagementServiceClient.AsymmetricSign(String, Digest, CallSettings)

KeyManagementServiceClient.AsymmetricSignAsync(String, Digest, CallSettings)

KeyManagementServiceClient.AsymmetricSignAsync(String, Digest, CancellationToken)

KeyManagementServiceClient.AsymmetricSign(CryptoKeyVersionName, Digest, CallSettings)

KeyManagementServiceClient.AsymmetricSignAsync(CryptoKeyVersionName, Digest, CallSettings)

KeyManagementServiceClient.AsymmetricSignAsync(CryptoKeyVersionName, Digest, CancellationToken)

KeyManagementServiceClient.AsymmetricDecryptAsync(AsymmetricDecryptRequest, CancellationToken)

KeyManagementServiceClient.AsymmetricDecrypt(String, ByteString, CallSettings)

KeyManagementServiceClient.AsymmetricDecryptAsync(String, ByteString, CallSettings)

KeyManagementServiceClient.AsymmetricDecryptAsync(String, ByteString, CancellationToken)

KeyManagementServiceClient.AsymmetricDecrypt(CryptoKeyVersionName, ByteString, CallSettings)

KeyManagementServiceClient.AsymmetricDecryptAsync(CryptoKeyVersionName, ByteString, CallSettings)

KeyManagementServiceClient.AsymmetricDecryptAsync(CryptoKeyVersionName, ByteString, CancellationToken)

KeyManagementServiceClient.MacSignAsync(MacSignRequest, CancellationToken)

KeyManagementServiceClient.MacSign(String, ByteString, CallSettings)

KeyManagementServiceClient.MacSignAsync(String, ByteString, CallSettings)

KeyManagementServiceClient.MacSignAsync(String, ByteString, CancellationToken)

KeyManagementServiceClient.MacSign(CryptoKeyVersionName, ByteString, CallSettings)

KeyManagementServiceClient.MacSignAsync(CryptoKeyVersionName, ByteString, CallSettings)

KeyManagementServiceClient.MacSignAsync(CryptoKeyVersionName, ByteString, CancellationToken)

KeyManagementServiceClient.MacVerifyAsync(MacVerifyRequest, CancellationToken)

KeyManagementServiceClient.MacVerify(String, ByteString, ByteString, CallSettings)

KeyManagementServiceClient.MacVerifyAsync(String, ByteString, ByteString, CallSettings)

KeyManagementServiceClient.MacVerifyAsync(String, ByteString, ByteString, CancellationToken)

KeyManagementServiceClient.MacVerify(CryptoKeyVersionName, ByteString, ByteString, CallSettings)

KeyManagementServiceClient.MacVerifyAsync(CryptoKeyVersionName, ByteString, ByteString, CallSettings)

KeyManagementServiceClient.MacVerifyAsync(CryptoKeyVersionName, ByteString, ByteString, CancellationToken)

KeyManagementServiceClient.GenerateRandomBytesAsync(GenerateRandomBytesRequest, CancellationToken)

KeyManagementServiceClient.GenerateRandomBytes(String, Int32, ProtectionLevel, CallSettings)

KeyManagementServiceClient.GenerateRandomBytesAsync(String, Int32, ProtectionLevel, CallSettings)

KeyManagementServiceClient.GenerateRandomBytesAsync(String, Int32, ProtectionLevel, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Remarks

Google Cloud Key Management Service

Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects:

• [KeyRing][google.cloud.kms.v1.KeyRing]
• [CryptoKey][google.cloud.kms.v1.CryptoKey]
• [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
• [ImportJob][google.cloud.kms.v1.ImportJob]

If you are using manual gRPC libraries, see Using gRPC with Cloud KMS.

Constructors

KeyManagementServiceClientImpl(KeyManagementService.KeyManagementServiceClient, KeyManagementServiceSettings)

public KeyManagementServiceClientImpl(KeyManagementService.KeyManagementServiceClient grpcClient, KeyManagementServiceSettings settings)

Constructs a client wrapper for the KeyManagementService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	KeyManagementService.KeyManagementServiceClient The underlying gRPC client.
settings	KeyManagementServiceSettings The base KeyManagementServiceSettings used within this client.

Properties

GrpcClient

public override KeyManagementService.KeyManagementServiceClient GrpcClient { get; }

The underlying gRPC KeyManagementService client

Property Value
Type	Description
KeyManagementService.KeyManagementServiceClient

Overrides

KeyManagementServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

KeyManagementServiceClient.IAMPolicyClient

Methods

AsymmetricDecrypt(AsymmetricDecryptRequest, CallSettings)

public override AsymmetricDecryptResponse AsymmetricDecrypt(AsymmetricDecryptRequest request, CallSettings callSettings = null)

Decrypts data that was encrypted with a public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_DECRYPT.

Parameters
Name	Description
request	AsymmetricDecryptRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AsymmetricDecryptResponse	The RPC response.

Overrides

KeyManagementServiceClient.AsymmetricDecrypt(AsymmetricDecryptRequest, CallSettings)

AsymmetricDecryptAsync(AsymmetricDecryptRequest, CallSettings)

public override Task<AsymmetricDecryptResponse> AsymmetricDecryptAsync(AsymmetricDecryptRequest request, CallSettings callSettings = null)

Decrypts data that was encrypted with a public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_DECRYPT.

Parameters
Name	Description
request	AsymmetricDecryptRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<AsymmetricDecryptResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.AsymmetricDecryptAsync(AsymmetricDecryptRequest, CallSettings)

AsymmetricSign(AsymmetricSignRequest, CallSettings)

public override AsymmetricSignResponse AsymmetricSign(AsymmetricSignRequest request, CallSettings callSettings = null)

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].

Parameters
Name	Description
request	AsymmetricSignRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AsymmetricSignResponse	The RPC response.

Overrides

KeyManagementServiceClient.AsymmetricSign(AsymmetricSignRequest, CallSettings)

AsymmetricSignAsync(AsymmetricSignRequest, CallSettings)

public override Task<AsymmetricSignResponse> AsymmetricSignAsync(AsymmetricSignRequest request, CallSettings callSettings = null)

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].

Parameters
Name	Description
request	AsymmetricSignRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<AsymmetricSignResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.AsymmetricSignAsync(AsymmetricSignRequest, CallSettings)

CreateCryptoKey(CreateCryptoKeyRequest, CallSettings)

public override CryptoKey CreateCryptoKey(CreateCryptoKeyRequest request, CallSettings callSettings = null)

Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a [KeyRing][google.cloud.kms.v1.KeyRing].

[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] and [CryptoKey.version_template.algorithm][google.cloud.kms.v1.CryptoKeyVersionTemplate.algorithm] are required.

Parameters
Name	Description
request	CreateCryptoKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKey	The RPC response.

Overrides

KeyManagementServiceClient.CreateCryptoKey(CreateCryptoKeyRequest, CallSettings)

CreateCryptoKeyAsync(CreateCryptoKeyRequest, CallSettings)

public override Task<CryptoKey> CreateCryptoKeyAsync(CreateCryptoKeyRequest request, CallSettings callSettings = null)

Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a [KeyRing][google.cloud.kms.v1.KeyRing].

[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] and [CryptoKey.version_template.algorithm][google.cloud.kms.v1.CryptoKeyVersionTemplate.algorithm] are required.

Parameters
Name	Description
request	CreateCryptoKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKey>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.CreateCryptoKeyAsync(CreateCryptoKeyRequest, CallSettings)

CreateCryptoKeyVersion(CreateCryptoKeyVersionRequest, CallSettings)

public override CryptoKeyVersion CreateCryptoKeyVersion(CreateCryptoKeyVersionRequest request, CallSettings callSettings = null)

Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a [CryptoKey][google.cloud.kms.v1.CryptoKey].

The server will assign the next sequential id. If unset, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED].

Parameters
Name	Description
request	CreateCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKeyVersion	The RPC response.

Overrides

KeyManagementServiceClient.CreateCryptoKeyVersion(CreateCryptoKeyVersionRequest, CallSettings)

CreateCryptoKeyVersionAsync(CreateCryptoKeyVersionRequest, CallSettings)

public override Task<CryptoKeyVersion> CreateCryptoKeyVersionAsync(CreateCryptoKeyVersionRequest request, CallSettings callSettings = null)

Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a [CryptoKey][google.cloud.kms.v1.CryptoKey].

The server will assign the next sequential id. If unset, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED].

Parameters
Name	Description
request	CreateCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKeyVersion>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.CreateCryptoKeyVersionAsync(CreateCryptoKeyVersionRequest, CallSettings)

CreateImportJob(CreateImportJobRequest, CallSettings)

public override ImportJob CreateImportJob(CreateImportJobRequest request, CallSettings callSettings = null)

Create a new [ImportJob][google.cloud.kms.v1.ImportJob] within a [KeyRing][google.cloud.kms.v1.KeyRing].

[ImportJob.import_method][google.cloud.kms.v1.ImportJob.import_method] is required.

Parameters
Name	Description
request	CreateImportJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ImportJob	The RPC response.

Overrides

KeyManagementServiceClient.CreateImportJob(CreateImportJobRequest, CallSettings)

CreateImportJobAsync(CreateImportJobRequest, CallSettings)

public override Task<ImportJob> CreateImportJobAsync(CreateImportJobRequest request, CallSettings callSettings = null)

Create a new [ImportJob][google.cloud.kms.v1.ImportJob] within a [KeyRing][google.cloud.kms.v1.KeyRing].

[ImportJob.import_method][google.cloud.kms.v1.ImportJob.import_method] is required.

Parameters
Name	Description
request	CreateImportJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<ImportJob>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.CreateImportJobAsync(CreateImportJobRequest, CallSettings)

CreateKeyRing(CreateKeyRingRequest, CallSettings)

public override KeyRing CreateKeyRing(CreateKeyRingRequest request, CallSettings callSettings = null)

Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and Location.

Parameters
Name	Description
request	CreateKeyRingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
KeyRing	The RPC response.

Overrides

KeyManagementServiceClient.CreateKeyRing(CreateKeyRingRequest, CallSettings)

CreateKeyRingAsync(CreateKeyRingRequest, CallSettings)

public override Task<KeyRing> CreateKeyRingAsync(CreateKeyRingRequest request, CallSettings callSettings = null)

Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and Location.

Parameters
Name	Description
request	CreateKeyRingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<KeyRing>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.CreateKeyRingAsync(CreateKeyRingRequest, CallSettings)

Decrypt(DecryptRequest, CallSettings)

public override DecryptResponse Decrypt(DecryptRequest request, CallSettings callSettings = null)

Decrypts data that was protected by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Parameters
Name	Description
request	DecryptRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
DecryptResponse	The RPC response.

Overrides

KeyManagementServiceClient.Decrypt(DecryptRequest, CallSettings)

DecryptAsync(DecryptRequest, CallSettings)

public override Task<DecryptResponse> DecryptAsync(DecryptRequest request, CallSettings callSettings = null)

Decrypts data that was protected by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Parameters
Name	Description
request	DecryptRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<DecryptResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.DecryptAsync(DecryptRequest, CallSettings)

DestroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest, CallSettings)

public override CryptoKeyVersion DestroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest request, CallSettings callSettings = null)

Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for destruction.

Upon calling this method, [CryptoKeyVersion.state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED], and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be set to the time [destroy_scheduled_duration][google.cloud.kms.v1.CryptoKey.destroy_scheduled_duration] in the future. At that time, the [state][google.cloud.kms.v1.CryptoKeyVersion.state] will automatically change to [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED], and the key material will be irrevocably destroyed.

Before the [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] is reached, [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] may be called to reverse the process.

Parameters
Name	Description
request	DestroyCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKeyVersion	The RPC response.

Overrides

KeyManagementServiceClient.DestroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest, CallSettings)

DestroyCryptoKeyVersionAsync(DestroyCryptoKeyVersionRequest, CallSettings)

public override Task<CryptoKeyVersion> DestroyCryptoKeyVersionAsync(DestroyCryptoKeyVersionRequest request, CallSettings callSettings = null)

Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for destruction.

Upon calling this method, [CryptoKeyVersion.state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED], and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be set to the time [destroy_scheduled_duration][google.cloud.kms.v1.CryptoKey.destroy_scheduled_duration] in the future. At that time, the [state][google.cloud.kms.v1.CryptoKeyVersion.state] will automatically change to [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED], and the key material will be irrevocably destroyed.

Before the [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] is reached, [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] may be called to reverse the process.

Parameters
Name	Description
request	DestroyCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKeyVersion>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.DestroyCryptoKeyVersionAsync(DestroyCryptoKeyVersionRequest, CallSettings)

Encrypt(EncryptRequest, CallSettings)

public override EncryptResponse Encrypt(EncryptRequest request, CallSettings callSettings = null)

Encrypts data, so that it can only be recovered by a call to [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Parameters
Name	Description
request	EncryptRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
EncryptResponse	The RPC response.

Overrides

KeyManagementServiceClient.Encrypt(EncryptRequest, CallSettings)

EncryptAsync(EncryptRequest, CallSettings)

public override Task<EncryptResponse> EncryptAsync(EncryptRequest request, CallSettings callSettings = null)

Encrypts data, so that it can only be recovered by a call to [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Parameters
Name	Description
request	EncryptRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<EncryptResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.EncryptAsync(EncryptRequest, CallSettings)

GenerateRandomBytes(GenerateRandomBytesRequest, CallSettings)

public override GenerateRandomBytesResponse GenerateRandomBytes(GenerateRandomBytesRequest request, CallSettings callSettings = null)

Generate random bytes using the Cloud KMS randomness source in the provided location.

Parameters
Name	Description
request	GenerateRandomBytesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
GenerateRandomBytesResponse	The RPC response.

Overrides

KeyManagementServiceClient.GenerateRandomBytes(GenerateRandomBytesRequest, CallSettings)

GenerateRandomBytesAsync(GenerateRandomBytesRequest, CallSettings)

public override Task<GenerateRandomBytesResponse> GenerateRandomBytesAsync(GenerateRandomBytesRequest request, CallSettings callSettings = null)

Generate random bytes using the Cloud KMS randomness source in the provided location.

Parameters
Name	Description
request	GenerateRandomBytesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<GenerateRandomBytesResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GenerateRandomBytesAsync(GenerateRandomBytesRequest, CallSettings)

GetCryptoKey(GetCryptoKeyRequest, CallSettings)

public override CryptoKey GetCryptoKey(GetCryptoKeyRequest request, CallSettings callSettings = null)

Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as well as its [primary][google.cloud.kms.v1.CryptoKey.primary] [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Parameters
Name	Description
request	GetCryptoKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKey	The RPC response.

Overrides

KeyManagementServiceClient.GetCryptoKey(GetCryptoKeyRequest, CallSettings)

GetCryptoKeyAsync(GetCryptoKeyRequest, CallSettings)

public override Task<CryptoKey> GetCryptoKeyAsync(GetCryptoKeyRequest request, CallSettings callSettings = null)

Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as well as its [primary][google.cloud.kms.v1.CryptoKey.primary] [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Parameters
Name	Description
request	GetCryptoKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKey>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GetCryptoKeyAsync(GetCryptoKeyRequest, CallSettings)

GetCryptoKeyVersion(GetCryptoKeyVersionRequest, CallSettings)

public override CryptoKeyVersion GetCryptoKeyVersion(GetCryptoKeyVersionRequest request, CallSettings callSettings = null)

Returns metadata for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Parameters
Name	Description
request	GetCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKeyVersion	The RPC response.

Overrides

KeyManagementServiceClient.GetCryptoKeyVersion(GetCryptoKeyVersionRequest, CallSettings)

GetCryptoKeyVersionAsync(GetCryptoKeyVersionRequest, CallSettings)

public override Task<CryptoKeyVersion> GetCryptoKeyVersionAsync(GetCryptoKeyVersionRequest request, CallSettings callSettings = null)

Returns metadata for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Parameters
Name	Description
request	GetCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKeyVersion>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GetCryptoKeyVersionAsync(GetCryptoKeyVersionRequest, CallSettings)

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Policy	The RPC response.

Overrides

KeyManagementServiceClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Policy>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

GetImportJob(GetImportJobRequest, CallSettings)

public override ImportJob GetImportJob(GetImportJobRequest request, CallSettings callSettings = null)

Returns metadata for a given [ImportJob][google.cloud.kms.v1.ImportJob].

Parameters
Name	Description
request	GetImportJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ImportJob	The RPC response.

Overrides

KeyManagementServiceClient.GetImportJob(GetImportJobRequest, CallSettings)

GetImportJobAsync(GetImportJobRequest, CallSettings)

public override Task<ImportJob> GetImportJobAsync(GetImportJobRequest request, CallSettings callSettings = null)

Returns metadata for a given [ImportJob][google.cloud.kms.v1.ImportJob].

Parameters
Name	Description
request	GetImportJobRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<ImportJob>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GetImportJobAsync(GetImportJobRequest, CallSettings)

GetKeyRing(GetKeyRingRequest, CallSettings)

public override KeyRing GetKeyRing(GetKeyRingRequest request, CallSettings callSettings = null)

Returns metadata for a given [KeyRing][google.cloud.kms.v1.KeyRing].

Parameters
Name	Description
request	GetKeyRingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
KeyRing	The RPC response.

Overrides

KeyManagementServiceClient.GetKeyRing(GetKeyRingRequest, CallSettings)

GetKeyRingAsync(GetKeyRingRequest, CallSettings)

public override Task<KeyRing> GetKeyRingAsync(GetKeyRingRequest request, CallSettings callSettings = null)

Returns metadata for a given [KeyRing][google.cloud.kms.v1.KeyRing].

Parameters
Name	Description
request	GetKeyRingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<KeyRing>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GetKeyRingAsync(GetKeyRingRequest, CallSettings)

GetPublicKey(GetPublicKeyRequest, CallSettings)

public override PublicKey GetPublicKey(GetPublicKeyRequest request, CallSettings callSettings = null)

Returns the public key for the given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] or [ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT].

Parameters
Name	Description
request	GetPublicKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PublicKey	The RPC response.

Overrides

KeyManagementServiceClient.GetPublicKey(GetPublicKeyRequest, CallSettings)

GetPublicKeyAsync(GetPublicKeyRequest, CallSettings)

public override Task<PublicKey> GetPublicKeyAsync(GetPublicKeyRequest request, CallSettings callSettings = null)

Returns the public key for the given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] or [ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT].

Parameters
Name	Description
request	GetPublicKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<PublicKey>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GetPublicKeyAsync(GetPublicKeyRequest, CallSettings)

ImportCryptoKeyVersion(ImportCryptoKeyVersionRequest, CallSettings)

public override CryptoKeyVersion ImportCryptoKeyVersion(ImportCryptoKeyVersionRequest request, CallSettings callSettings = null)

Import wrapped key material into a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

All requests must specify a [CryptoKey][google.cloud.kms.v1.CryptoKey]. If a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	ImportCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKeyVersion	The RPC response.

Overrides

KeyManagementServiceClient.ImportCryptoKeyVersion(ImportCryptoKeyVersionRequest, CallSettings)

ImportCryptoKeyVersionAsync(ImportCryptoKeyVersionRequest, CallSettings)

public override Task<CryptoKeyVersion> ImportCryptoKeyVersionAsync(ImportCryptoKeyVersionRequest request, CallSettings callSettings = null)

Import wrapped key material into a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

All requests must specify a [CryptoKey][google.cloud.kms.v1.CryptoKey]. If a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	ImportCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKeyVersion>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.ImportCryptoKeyVersionAsync(ImportCryptoKeyVersionRequest, CallSettings)

ListCryptoKeys(ListCryptoKeysRequest, CallSettings)

public override PagedEnumerable<ListCryptoKeysResponse, CryptoKey> ListCryptoKeys(ListCryptoKeysRequest request, CallSettings callSettings = null)

Lists [CryptoKeys][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	ListCryptoKeysRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListCryptoKeysResponse, CryptoKey>	A pageable sequence of CryptoKey resources.

Overrides

KeyManagementServiceClient.ListCryptoKeys(ListCryptoKeysRequest, CallSettings)

ListCryptoKeysAsync(ListCryptoKeysRequest, CallSettings)

public override PagedAsyncEnumerable<ListCryptoKeysResponse, CryptoKey> ListCryptoKeysAsync(ListCryptoKeysRequest request, CallSettings callSettings = null)

Lists [CryptoKeys][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	ListCryptoKeysRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListCryptoKeysResponse, CryptoKey>	A pageable asynchronous sequence of CryptoKey resources.

Overrides

KeyManagementServiceClient.ListCryptoKeysAsync(ListCryptoKeysRequest, CallSettings)

ListCryptoKeyVersions(ListCryptoKeyVersionsRequest, CallSettings)

public override PagedEnumerable<ListCryptoKeyVersionsResponse, CryptoKeyVersion> ListCryptoKeyVersions(ListCryptoKeyVersionsRequest request, CallSettings callSettings = null)

Lists [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion].

Parameters
Name	Description
request	ListCryptoKeyVersionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListCryptoKeyVersionsResponse, CryptoKeyVersion>	A pageable sequence of CryptoKeyVersion resources.

Overrides

KeyManagementServiceClient.ListCryptoKeyVersions(ListCryptoKeyVersionsRequest, CallSettings)

ListCryptoKeyVersionsAsync(ListCryptoKeyVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCryptoKeyVersionsResponse, CryptoKeyVersion> ListCryptoKeyVersionsAsync(ListCryptoKeyVersionsRequest request, CallSettings callSettings = null)

Lists [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion].

Parameters
Name	Description
request	ListCryptoKeyVersionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListCryptoKeyVersionsResponse, CryptoKeyVersion>	A pageable asynchronous sequence of CryptoKeyVersion resources.

Overrides

KeyManagementServiceClient.ListCryptoKeyVersionsAsync(ListCryptoKeyVersionsRequest, CallSettings)

ListImportJobs(ListImportJobsRequest, CallSettings)

public override PagedEnumerable<ListImportJobsResponse, ImportJob> ListImportJobs(ListImportJobsRequest request, CallSettings callSettings = null)

Lists [ImportJobs][google.cloud.kms.v1.ImportJob].

Parameters
Name	Description
request	ListImportJobsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListImportJobsResponse, ImportJob>	A pageable sequence of ImportJob resources.

Overrides

KeyManagementServiceClient.ListImportJobs(ListImportJobsRequest, CallSettings)

ListImportJobsAsync(ListImportJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListImportJobsResponse, ImportJob> ListImportJobsAsync(ListImportJobsRequest request, CallSettings callSettings = null)

Lists [ImportJobs][google.cloud.kms.v1.ImportJob].

Parameters
Name	Description
request	ListImportJobsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListImportJobsResponse, ImportJob>	A pageable asynchronous sequence of ImportJob resources.

Overrides

KeyManagementServiceClient.ListImportJobsAsync(ListImportJobsRequest, CallSettings)

ListKeyRings(ListKeyRingsRequest, CallSettings)

public override PagedEnumerable<ListKeyRingsResponse, KeyRing> ListKeyRings(ListKeyRingsRequest request, CallSettings callSettings = null)

Lists [KeyRings][google.cloud.kms.v1.KeyRing].

Parameters
Name	Description
request	ListKeyRingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListKeyRingsResponse, KeyRing>	A pageable sequence of KeyRing resources.

Overrides

KeyManagementServiceClient.ListKeyRings(ListKeyRingsRequest, CallSettings)

ListKeyRingsAsync(ListKeyRingsRequest, CallSettings)

public override PagedAsyncEnumerable<ListKeyRingsResponse, KeyRing> ListKeyRingsAsync(ListKeyRingsRequest request, CallSettings callSettings = null)

Lists [KeyRings][google.cloud.kms.v1.KeyRing].

Parameters
Name	Description
request	ListKeyRingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListKeyRingsResponse, KeyRing>	A pageable asynchronous sequence of KeyRing resources.

Overrides

KeyManagementServiceClient.ListKeyRingsAsync(ListKeyRingsRequest, CallSettings)

MacSign(MacSignRequest, CallSettings)

public override MacSignResponse MacSign(MacSignRequest request, CallSettings callSettings = null)

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, producing a tag that can be verified by another source with the same key.

Parameters
Name	Description
request	MacSignRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
MacSignResponse	The RPC response.

Overrides

KeyManagementServiceClient.MacSign(MacSignRequest, CallSettings)

MacSignAsync(MacSignRequest, CallSettings)

public override Task<MacSignResponse> MacSignAsync(MacSignRequest request, CallSettings callSettings = null)

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, producing a tag that can be verified by another source with the same key.

Parameters
Name	Description
request	MacSignRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<MacSignResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.MacSignAsync(MacSignRequest, CallSettings)

MacVerify(MacVerifyRequest, CallSettings)

public override MacVerifyResponse MacVerify(MacVerifyRequest request, CallSettings callSettings = null)

Verifies MAC tag using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, and returns a response that indicates whether or not the verification was successful.

Parameters
Name	Description
request	MacVerifyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
MacVerifyResponse	The RPC response.

Overrides

KeyManagementServiceClient.MacVerify(MacVerifyRequest, CallSettings)

MacVerifyAsync(MacVerifyRequest, CallSettings)

public override Task<MacVerifyResponse> MacVerifyAsync(MacVerifyRequest request, CallSettings callSettings = null)

Verifies MAC tag using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] MAC, and returns a response that indicates whether or not the verification was successful.

Parameters
Name	Description
request	MacVerifyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<MacVerifyResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.MacVerifyAsync(MacVerifyRequest, CallSettings)

RestoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest, CallSettings)

public override CryptoKeyVersion RestoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest request, CallSettings callSettings = null)

Restore a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] state.

Upon restoration of the CryptoKeyVersion, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED], and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be cleared.

Parameters
Name	Description
request	RestoreCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKeyVersion	The RPC response.

Overrides

KeyManagementServiceClient.RestoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest, CallSettings)

RestoreCryptoKeyVersionAsync(RestoreCryptoKeyVersionRequest, CallSettings)

public override Task<CryptoKeyVersion> RestoreCryptoKeyVersionAsync(RestoreCryptoKeyVersionRequest request, CallSettings callSettings = null)

Restore a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] state.

Upon restoration of the CryptoKeyVersion, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED], and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be cleared.

Parameters
Name	Description
request	RestoreCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKeyVersion>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.RestoreCryptoKeyVersionAsync(RestoreCryptoKeyVersionRequest, CallSettings)

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Parameters
Name	Description
request	SetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Policy	The RPC response.

Overrides

KeyManagementServiceClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Parameters
Name	Description
request	SetIamPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Policy>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	TestIamPermissionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TestIamPermissionsResponse	The RPC response.

Overrides

KeyManagementServiceClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	TestIamPermissionsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<TestIamPermissionsResponse>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

UpdateCryptoKey(UpdateCryptoKeyRequest, CallSettings)

public override CryptoKey UpdateCryptoKey(UpdateCryptoKeyRequest request, CallSettings callSettings = null)

Update a [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	UpdateCryptoKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKey	The RPC response.

Overrides

KeyManagementServiceClient.UpdateCryptoKey(UpdateCryptoKeyRequest, CallSettings)

UpdateCryptoKeyAsync(UpdateCryptoKeyRequest, CallSettings)

public override Task<CryptoKey> UpdateCryptoKeyAsync(UpdateCryptoKeyRequest request, CallSettings callSettings = null)

Update a [CryptoKey][google.cloud.kms.v1.CryptoKey].

Parameters
Name	Description
request	UpdateCryptoKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKey>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.UpdateCryptoKeyAsync(UpdateCryptoKeyRequest, CallSettings)

UpdateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest, CallSettings)

public override CryptoKey UpdateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest request, CallSettings callSettings = null)

Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that will be used in [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].

Returns an error if called on a key whose purpose is not [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Parameters
Name	Description
request	UpdateCryptoKeyPrimaryVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKey	The RPC response.

Overrides

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest, CallSettings)

UpdateCryptoKeyPrimaryVersionAsync(UpdateCryptoKeyPrimaryVersionRequest, CallSettings)

public override Task<CryptoKey> UpdateCryptoKeyPrimaryVersionAsync(UpdateCryptoKeyPrimaryVersionRequest request, CallSettings callSettings = null)

Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that will be used in [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].

Returns an error if called on a key whose purpose is not [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

Parameters
Name	Description
request	UpdateCryptoKeyPrimaryVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKey>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.UpdateCryptoKeyPrimaryVersionAsync(UpdateCryptoKeyPrimaryVersionRequest, CallSettings)

UpdateCryptoKeyVersion(UpdateCryptoKeyVersionRequest, CallSettings)

public override CryptoKeyVersion UpdateCryptoKeyVersion(UpdateCryptoKeyVersionRequest request, CallSettings callSettings = null)

Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s metadata.

[state][google.cloud.kms.v1.CryptoKeyVersion.state] may be changed between [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED] and [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED] using this method. See [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion] and [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] to move between other states.

Parameters
Name	Description
request	UpdateCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CryptoKeyVersion	The RPC response.

Overrides

KeyManagementServiceClient.UpdateCryptoKeyVersion(UpdateCryptoKeyVersionRequest, CallSettings)

UpdateCryptoKeyVersionAsync(UpdateCryptoKeyVersionRequest, CallSettings)

public override Task<CryptoKeyVersion> UpdateCryptoKeyVersionAsync(UpdateCryptoKeyVersionRequest request, CallSettings callSettings = null)

Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s metadata.

[state][google.cloud.kms.v1.CryptoKeyVersion.state] may be changed between [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED] and [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED] using this method. See [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion] and [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] to move between other states.

Parameters
Name	Description
request	UpdateCryptoKeyVersionRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CryptoKeyVersion>	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.UpdateCryptoKeyVersionAsync(UpdateCryptoKeyVersionRequest, CallSettings)