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 java.lang.Object

The "cryptoKeyVersions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Create
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Destroy
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Get
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.List
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch
class	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Restore

Constructor Summary

Constructors

Constructor and Description
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions()

Method Summary

Methods

Modifier and Type	Method and Description
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Create	create(java.lang.String parent, CryptoKeyVersion content) Create a new CryptoKeyVersion in a CryptoKey.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Destroy	destroy(java.lang.String name, DestroyCryptoKeyVersionRequest content) Schedule a CryptoKeyVersion for destruction.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Get	get(java.lang.String name) Returns metadata for a given CryptoKeyVersion.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.List	list(java.lang.String parent) Lists CryptoKeyVersions.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch	patch(java.lang.String name, CryptoKeyVersion content) Update a CryptoKeyVersion's metadata.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Restore	restore(java.lang.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

CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions()

Method Detail

create

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Create create(java.lang.String parent,
                                                                              CryptoKeyVersion content)
                                                                                throws java.io.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:

java.io.IOException

destroy

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Destroy destroy(java.lang.String name,
                                                                                DestroyCryptoKeyVersionRequest content)
                                                                                  throws java.io.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 a time 24 hours in the future, at which point the state will be changed 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 - The resource name of the CryptoKeyVersion to destroy.

content - the DestroyCryptoKeyVersionRequest

Returns:

the request

Throws:

java.io.IOException

get

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Get get(java.lang.String name)
                                                                          throws java.io.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 - The name of the CryptoKeyVersion to get.

Returns:

the request

Throws:

java.io.IOException

list

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.List list(java.lang.String parent)
                                                                            throws java.io.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:

java.io.IOException

patch

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch patch(java.lang.String name,
                                                                            CryptoKeyVersion content)
                                                                              throws java.io.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:

java.io.IOException

restore

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Restore restore(java.lang.String name,
                                                                                RestoreCryptoKeyVersionRequest content)
                                                                                  throws java.io.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 - The resource name of the CryptoKeyVersion to restore.

content - the RestoreCryptoKeyVersionRequest

Returns:

the request

Throws:

java.io.IOException