Class ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource

The "cryptoKeyVersions" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudKMS.v1

Assembly: Google.Apis.CloudKMS.v1.dll

Syntax

public class ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource

Constructors

CryptoKeyVersionsResource(IClientService)

Constructs a new resource.

Declaration

public CryptoKeyVersionsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AsymmetricDecrypt(AsymmetricDecryptRequest, string)

Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.AsymmetricDecryptRequest AsymmetricDecrypt(AsymmetricDecryptRequest body, string name)

Parameters

Type	Name	Description
AsymmetricDecryptRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to use for decryption.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.AsymmetricDecryptRequest

AsymmetricSign(AsymmetricSignRequest, string)

Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.AsymmetricSignRequest AsymmetricSign(AsymmetricSignRequest body, string name)

Parameters

Type	Name	Description
AsymmetricSignRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to use for signing.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.AsymmetricSignRequest

Create(CryptoKeyVersion, string)

Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.CreateRequest Create(CryptoKeyVersion body, string parent)

Parameters

Type	Name	Description
CryptoKeyVersion	body	The body of the request.
string	parent	Required. The name of the CryptoKey associated with the CryptoKeyVersions.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.CreateRequest

Decapsulate(DecapsulateRequest, string)

Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.DecapsulateRequest Decapsulate(DecapsulateRequest body, string name)

Parameters

Type	Name	Description
DecapsulateRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to use for decapsulation.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.DecapsulateRequest

Delete(string)

Permanently deletes the given CryptoKeyVersion. Only possible if the version has not been previously imported and if its state is one of DESTROYED, IMPORT_FAILED, or GENERATION_FAILED. Successfully imported CryptoKeyVersions cannot be deleted at this time. The specified version will be immediately and permanently deleted upon calling this method. This action cannot be undone.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the CryptoKeyVersion to delete.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.DeleteRequest

Destroy(DestroyCryptoKeyVersionRequest, string)

Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.DestroyRequest Destroy(DestroyCryptoKeyVersionRequest body, string name)

Parameters

Type	Name	Description
DestroyCryptoKeyVersionRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to destroy.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.DestroyRequest

Get(string)

Returns metadata for a given CryptoKeyVersion.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the CryptoKeyVersion to get.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.GetRequest

GetPublicKey(string)

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.GetPublicKeyRequest GetPublicKey(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the CryptoKeyVersion public key to get.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.GetPublicKeyRequest

Import(ImportCryptoKeyVersionRequest, string)

Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a 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.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.ImportRequest Import(ImportCryptoKeyVersionRequest body, string parent)

Parameters

Type	Name	Description
ImportCryptoKeyVersionRequest	body	The body of the request.
string	parent	Required. The name of the CryptoKey to be imported into. The create permission is only required on this key when creating a new CryptoKeyVersion.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.ImportRequest

List(string)

Lists CryptoKeyVersions.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The resource name of the CryptoKey to list, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.ListRequest

MacSign(MacSignRequest, string)

Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.MacSignRequest MacSign(MacSignRequest body, string name)

Parameters

Type	Name	Description
MacSignRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to use for signing.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.MacSignRequest

MacVerify(MacVerifyRequest, string)

Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.MacVerifyRequest MacVerify(MacVerifyRequest body, string name)

Parameters

Type	Name	Description
MacVerifyRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to use for verification.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.MacVerifyRequest

Patch(CryptoKeyVersion, string)

Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.PatchRequest Patch(CryptoKeyVersion body, string name)

Parameters

Type	Name	Description
CryptoKeyVersion	body	The body of the request.
string	name	Output only. The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.PatchRequest

RawDecrypt(RawDecryptRequest, string)

Decrypts data that was originally encrypted using a raw cryptographic mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.RawDecryptRequest RawDecrypt(RawDecryptRequest body, string name)

Parameters

Type	Name	Description
RawDecryptRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to use for decryption.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.RawDecryptRequest

RawEncrypt(RawEncryptRequest, string)

Encrypts data using portable cryptographic primitives. Most users should choose Encrypt and Decrypt rather than their raw counterparts. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.RawEncryptRequest RawEncrypt(RawEncryptRequest body, string name)

Parameters

Type	Name	Description
RawEncryptRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to use for encryption.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.RawEncryptRequest

Restore(RestoreCryptoKeyVersionRequest, string)

Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.

Declaration

public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.RestoreRequest Restore(RestoreCryptoKeyVersionRequest body, string name)

Parameters

Type	Name	Description
RestoreCryptoKeyVersionRequest	body	The body of the request.
string	name	Required. The resource name of the CryptoKeyVersion to restore.

Returns

Type	Description
ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource.CryptoKeyVersionsResource.RestoreRequest