Google Cloud Key Management Service v1 API - Class KeyManagementServiceClientImpl (3.4.0)

public sealed class KeyManagementServiceClientImpl : KeyManagementServiceClient

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

KeyManagementService client wrapper implementation, for convenient use.

Inheritance

object > KeyManagementServiceClient > KeyManagementServiceClientImpl

Inherited Members

KeyManagementServiceClient.DefaultEndpoint

KeyManagementServiceClient.DefaultScopes

KeyManagementServiceClient.ServiceMetadata

KeyManagementServiceClient.CreateAsync(CancellationToken)

KeyManagementServiceClient.Create()

KeyManagementServiceClient.ShutdownDefaultChannelsAsync()

KeyManagementServiceClient.ListKeyRings(string, string, int?, CallSettings)

KeyManagementServiceClient.ListKeyRingsAsync(string, string, int?, CallSettings)

KeyManagementServiceClient.ListKeyRings(LocationName, string, int?, CallSettings)

KeyManagementServiceClient.ListKeyRingsAsync(LocationName, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeys(string, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeysAsync(string, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeys(KeyRingName, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeysAsync(KeyRingName, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersions(string, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersionsAsync(string, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersions(CryptoKeyName, string, int?, CallSettings)

KeyManagementServiceClient.ListCryptoKeyVersionsAsync(CryptoKeyName, string, int?, CallSettings)

KeyManagementServiceClient.ListImportJobs(string, string, int?, CallSettings)

KeyManagementServiceClient.ListImportJobsAsync(string, string, int?, CallSettings)

KeyManagementServiceClient.ListImportJobs(KeyRingName, string, int?, CallSettings)

KeyManagementServiceClient.ListImportJobsAsync(KeyRingName, string, int?, 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, int, ProtectionLevel, CallSettings)

KeyManagementServiceClient.GenerateRandomBytesAsync(string, int, ProtectionLevel, CallSettings)

KeyManagementServiceClient.GenerateRandomBytesAsync(string, int, ProtectionLevel, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.KmsV1

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(KeyManagementServiceClient, KeyManagementServiceSettings, ILogger)

public KeyManagementServiceClientImpl(KeyManagementService.KeyManagementServiceClient grpcClient, KeyManagementServiceSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`KeyManagementServiceKeyManagementServiceClient` The underlying gRPC client.
`settings`	`KeyManagementServiceSettings` The base KeyManagementServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override KeyManagementService.KeyManagementServiceClient GrpcClient { get; }

The underlying gRPC KeyManagementService client

Property Value
Type	Description
`KeyManagementServiceKeyManagementServiceClient`

Overrides

KeyManagementServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
`IAMPolicyClient`

Overrides

KeyManagementServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

KeyManagementServiceClient.LocationsClient

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)

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
`TaskAsymmetricDecryptResponse`	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)

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
`TaskAsymmetricSignResponse`	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
`TaskCryptoKey`	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].

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
`TaskCryptoKeyVersion`	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
`TaskImportJob`	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
`TaskKeyRing`	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)

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
`TaskDecryptResponse`	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.

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
`TaskCryptoKeyVersion`	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)

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
`TaskEncryptResponse`	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
`TaskGenerateRandomBytesResponse`	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
`TaskCryptoKey`	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
`TaskCryptoKeyVersion`	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.GetCryptoKeyVersionAsync(GetCryptoKeyVersionRequest, 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
`TaskImportJob`	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
`TaskKeyRing`	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)

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
`TaskPublicKey`	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].

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
`TaskCryptoKeyVersion`	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
`PagedEnumerableListCryptoKeysResponseCryptoKey`	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
`PagedAsyncEnumerableListCryptoKeysResponseCryptoKey`	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
`PagedEnumerableListCryptoKeyVersionsResponseCryptoKeyVersion`	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
`PagedAsyncEnumerableListCryptoKeyVersionsResponseCryptoKeyVersion`	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
`PagedEnumerableListImportJobsResponseImportJob`	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
`PagedAsyncEnumerableListImportJobsResponseImportJob`	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
`PagedEnumerableListKeyRingsResponseKeyRing`	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
`PagedAsyncEnumerableListKeyRingsResponseKeyRing`	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)

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
`TaskMacSignResponse`	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)

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
`TaskMacVerifyResponse`	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.

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
`TaskCryptoKeyVersion`	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.RestoreCryptoKeyVersionAsync(RestoreCryptoKeyVersionRequest, 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
`TaskCryptoKey`	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
`TaskCryptoKey`	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.

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
`TaskCryptoKeyVersion`	A Task containing the RPC response.

Overrides

KeyManagementServiceClient.UpdateCryptoKeyVersionAsync(UpdateCryptoKeyVersionRequest, CallSettings)