com.google.api.services.cloudkms.v1

Class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions

java.lang.Object

com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions

Enclosing class:

CloudKMS.Projects.Locations.KeyRings.CryptoKeys

public class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions
extends Object

The "cryptoKeyVersions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.AsymmetricDecrypt
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.AsymmetricSign
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.CloudKMSImport
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Create
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Decapsulate
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Delete
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Destroy
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.ExportTrustedKeyWrappedCryptoKeyVersion
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Get
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.GetPublicKey
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.ImportTrustedKeyWrappedCryptoKeyVersion
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.List
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.MacSign
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.MacVerify
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.RawDecrypt
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.RawEncrypt
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Restore

Constructor Summary

Constructors

Constructor and Description
CryptoKeyVersions()

Method Summary

Modifier and Type	Method and Description
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.AsymmetricDecrypt	asymmetricDecrypt(String name, AsymmetricDecryptRequest content) Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.AsymmetricSign	asymmetricSign(String name, AsymmetricSignRequest content) Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.CloudKMSImport	cloudkmsImport(String parent, ImportCryptoKeyVersionRequest content) Import wrapped key material into a CryptoKeyVersion.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Create	create(String parent, CryptoKeyVersion content) Create a new CryptoKeyVersion in a CryptoKey.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Decapsulate	decapsulate(String name, DecapsulateRequest content) Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Delete	delete(String name) Permanently deletes the given CryptoKeyVersion.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Destroy	destroy(String name, DestroyCryptoKeyVersionRequest content) Schedule a CryptoKeyVersion for destruction.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.ExportTrustedKeyWrappedCryptoKeyVersion	exportTrustedKeyWrappedCryptoKeyVersion(String name) Exports a CryptoKeyVersion with a trusted key.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Get	get(String name) Returns metadata for a given CryptoKeyVersion.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.GetPublicKey	getPublicKey(String name) Returns the public key for the given CryptoKeyVersion.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.ImportTrustedKeyWrappedCryptoKeyVersion	importTrustedKeyWrappedCryptoKeyVersion(String parent, ImportTrustedKeyWrappedCryptoKeyVersionRequest content) Import wrapped key material into a CryptoKeyVersion with a trusted key.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.List	list(String parent) Lists CryptoKeyVersions.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.MacSign	macSign(String name, MacSignRequest content) Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.MacVerify	macVerify(String name, MacVerifyRequest content) Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch	patch(String name, CryptoKeyVersion content) Update a CryptoKeyVersion's metadata.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.RawDecrypt	rawDecrypt(String name, RawDecryptRequest content) Decrypts data that was originally encrypted using a raw cryptographic mechanism.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.RawEncrypt	rawEncrypt(String name, RawEncryptRequest content) Encrypts data using portable cryptographic primitives.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Restore	restore(String name, RestoreCryptoKeyVersionRequest content) Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CryptoKeyVersions

public CryptoKeyVersions()

Method Detail

asymmetricDecrypt

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.AsymmetricDecrypt asymmetricDecrypt(String name,
                                                                                                             AsymmetricDecryptRequest content)
                                                                                                      throws IOException

Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT. Create a request for the method "cryptoKeyVersions.asymmetricDecrypt". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to use for decryption.

content - the AsymmetricDecryptRequest

Returns:

the request

Throws:

IOException

asymmetricSign

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.AsymmetricSign asymmetricSign(String name,
                                                                                                       AsymmetricSignRequest content)
                                                                                                throws IOException

Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey. Create a request for the method "cryptoKeyVersions.asymmetricSign". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to use for signing.

content - the AsymmetricSignRequest

Returns:

the request

Throws:

IOException

create

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Create create(String parent,
                                                                                       CryptoKeyVersion content)
                                                                                throws IOException

Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED. Create a request for the method "cryptoKeyVersions.create". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the CryptoKey associated with the CryptoKeyVersions.

content - the CryptoKeyVersion

Returns:

the request

Throws:

IOException

decapsulate

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Decapsulate decapsulate(String name,
                                                                                                 DecapsulateRequest content)
                                                                                          throws IOException

Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION. Create a request for the method "cryptoKeyVersions.decapsulate". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to use for decapsulation.

content - the DecapsulateRequest

Returns:

the request

Throws:

IOException

delete

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Delete delete(String name)
                                                                                throws IOException

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. Create a request for the method "cryptoKeyVersions.delete". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the CryptoKeyVersion to delete.

Returns:

the request

Throws:

IOException

destroy

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Destroy destroy(String name,
                                                                                         DestroyCryptoKeyVersionRequest content)
                                                                                  throws IOException

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. Create a request for the method "cryptoKeyVersions.destroy". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to destroy.

content - the DestroyCryptoKeyVersionRequest

Returns:

the request

Throws:

IOException

exportTrustedKeyWrappedCryptoKeyVersion

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.ExportTrustedKeyWrappedCryptoKeyVersion exportTrustedKeyWrappedCryptoKeyVersion(String name)
                                                                                                                                                  throws IOException

Exports a CryptoKeyVersion with a trusted key. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. The CryptoKeyVersion of the [wrapping_key] must have the AES_WRAPPING purpose. The [wrapping_key] must have the AES_256_KWP algorithm. Create a request for the method "cryptoKeyVersions.exportTrustedKeyWrappedCryptoKeyVersion". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the CryptoKeyVersion to export. The CryptoKeyVersion must have trusted_wrapping_enabled set to true.

Returns:

the request

Throws:

IOException

get

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Get get(String name)
                                                                          throws IOException

Returns metadata for a given CryptoKeyVersion. Create a request for the method "cryptoKeyVersions.get". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the CryptoKeyVersion to get.

Returns:

the request

Throws:

IOException

getPublicKey

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.GetPublicKey getPublicKey(String name)
                                                                                            throws IOException

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT. Create a request for the method "cryptoKeyVersions.getPublicKey". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the CryptoKeyVersion public key to get.

Returns:

the request

Throws:

IOException

cloudkmsImport

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.CloudKMSImport cloudkmsImport(String parent,
                                                                                                       ImportCryptoKeyVersionRequest content)
                                                                                                throws IOException

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. Create a request for the method "cryptoKeyVersions.import". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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.

content - the ImportCryptoKeyVersionRequest

Returns:

the request

Throws:

IOException

importTrustedKeyWrappedCryptoKeyVersion

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.ImportTrustedKeyWrappedCryptoKeyVersion importTrustedKeyWrappedCryptoKeyVersion(String parent,
                                                                                                                                                         ImportTrustedKeyWrappedCryptoKeyVersionRequest content)
                                                                                                                                                  throws IOException

Import wrapped key material into a CryptoKeyVersion with a trusted key. 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. The CryptoKeyVersion will have trusted_wrapping_enabled set to true. Create a request for the method "cryptoKeyVersions.importTrustedKeyWrappedCryptoKeyVersion". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the CryptoKey to be imported into.

content - the ImportTrustedKeyWrappedCryptoKeyVersionRequest

Returns:

the request

Throws:

IOException

list

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.List list(String parent)
                                                                            throws IOException

Lists CryptoKeyVersions. Create a request for the method "cryptoKeyVersions.list". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The resource name of the CryptoKey to list, in the format `projects/locations/keyRings/cryptoKeys`.

Returns:

the request

Throws:

IOException

macSign

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.MacSign macSign(String name,
                                                                                         MacSignRequest content)
                                                                                  throws IOException

Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key. Create a request for the method "cryptoKeyVersions.macSign". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to use for signing.

content - the MacSignRequest

Returns:

the request

Throws:

IOException

macVerify

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.MacVerify macVerify(String name,
                                                                                             MacVerifyRequest content)
                                                                                      throws IOException

Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful. Create a request for the method "cryptoKeyVersions.macVerify". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to use for verification.

content - the MacVerifyRequest

Returns:

the request

Throws:

IOException

patch

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch patch(String name,
                                                                                     CryptoKeyVersion content)
                                                                              throws IOException

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. Create a request for the method "cryptoKeyVersions.patch". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Output only. The resource name for this CryptoKeyVersion in the format `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`.

content - the CryptoKeyVersion

Returns:

the request

Throws:

IOException

rawDecrypt

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.RawDecrypt rawDecrypt(String name,
                                                                                               RawDecryptRequest content)
                                                                                        throws IOException

Decrypts data that was originally encrypted using a raw cryptographic mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT. Create a request for the method "cryptoKeyVersions.rawDecrypt". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to use for decryption.

content - the RawDecryptRequest

Returns:

the request

Throws:

IOException

rawEncrypt

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.RawEncrypt rawEncrypt(String name,
                                                                                               RawEncryptRequest content)
                                                                                        throws IOException

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. Create a request for the method "cryptoKeyVersions.rawEncrypt". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to use for encryption.

content - the RawEncryptRequest

Returns:

the request

Throws:

IOException

restore

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Restore restore(String name,
                                                                                         RestoreCryptoKeyVersionRequest content)
                                                                                  throws IOException

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. Create a request for the method "cryptoKeyVersions.restore". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the CryptoKeyVersion to restore.

content - the RestoreCryptoKeyVersionRequest

Returns:

the request

Throws:

IOException