com.google.api.services.cloudkms.v1.model

Class CryptoKey

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudkms.v1.model.CryptoKey

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CryptoKey
extends GenericJson

A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Key Management Service (KMS) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CryptoKey()

Method Summary

Modifier and Type	Method and Description
CryptoKey	clone()
String	getCreateTime() Output only.
Map<String,String>	getLabels() Labels with user-defined metadata.
String	getName() Output only.
String	getNextRotationTime() At next_rotation_time, the Key Management Service will automatically: 1.
CryptoKeyVersion	getPrimary() Output only.
String	getPurpose() Immutable.
String	getRotationPeriod() next_rotation_time will be advanced by this period when the service automatically rotates a key.
CryptoKeyVersionTemplate	getVersionTemplate() A template describing settings for new CryptoKeyVersion instances.
CryptoKey	set(String fieldName, Object value)
CryptoKey	setCreateTime(String createTime) Output only.
CryptoKey	setLabels(Map<String,String> labels) Labels with user-defined metadata.
CryptoKey	setName(String name) Output only.
CryptoKey	setNextRotationTime(String nextRotationTime) At next_rotation_time, the Key Management Service will automatically: 1.
CryptoKey	setPrimary(CryptoKeyVersion primary) Output only.
CryptoKey	setPurpose(String purpose) Immutable.
CryptoKey	setRotationPeriod(String rotationPeriod) next_rotation_time will be advanced by this period when the service automatically rotates a key.
CryptoKey	setVersionTemplate(CryptoKeyVersionTemplate versionTemplate) A template describing settings for new CryptoKeyVersion instances.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CryptoKey

public CryptoKey()

Method Detail

getCreateTime

public String getCreateTime()

Output only. The time at which this CryptoKey was created.

Returns:

value or null for none

setCreateTime

public CryptoKey setCreateTime(String createTime)

Output only. The time at which this CryptoKey was created.

Parameters:

createTime - createTime or null for none

getLabels

public Map<String,String> getLabels()

Labels with user-defined metadata. For more information, see [Labeling Keys](/kms/docs /labeling-keys).

Returns:

value or null for none

setLabels

public CryptoKey setLabels(Map<String,String> labels)

Labels with user-defined metadata. For more information, see [Labeling Keys](/kms/docs /labeling-keys).

Parameters:

labels - labels or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public CryptoKey setName(String name)

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

Parameters:

name - name or null for none

getNextRotationTime

public String getNextRotationTime()

At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.

Returns:

value or null for none

setNextRotationTime

public CryptoKey setNextRotationTime(String nextRotationTime)

At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.

Parameters:

nextRotationTime - nextRotationTime or null for none

getPrimary

public CryptoKeyVersion getPrimary()

Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.

Returns:

value or null for none

setPrimary

public CryptoKey setPrimary(CryptoKeyVersion primary)

Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.

Parameters:

primary - primary or null for none

getPurpose

public String getPurpose()

Immutable. The immutable purpose of this CryptoKey.

Returns:

value or null for none

setPurpose

public CryptoKey setPurpose(String purpose)

Immutable. The immutable purpose of this CryptoKey.

Parameters:

purpose - purpose or null for none

getRotationPeriod

public String getRotationPeriod()

next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.

Returns:

value or null for none

setRotationPeriod

public CryptoKey setRotationPeriod(String rotationPeriod)

next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.

Parameters:

rotationPeriod - rotationPeriod or null for none

getVersionTemplate

public CryptoKeyVersionTemplate getVersionTemplate()

A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.

Returns:

value or null for none

setVersionTemplate

public CryptoKey setVersionTemplate(CryptoKeyVersionTemplate versionTemplate)

A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.

Parameters:

versionTemplate - versionTemplate or null for none

set

public CryptoKey set(String fieldName,
                     Object value)

Overrides:

set in class GenericJson

clone

public CryptoKey clone()

Overrides:

clone in class GenericJson