CryptoKey (Cloud Key Management Service (KMS) API v1 (Rev. 108) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudkms.v1.model.CryptoKey

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class CryptoKey
extends com.google.api.client.json.GenericJson
```
A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of one 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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

CryptoKey()

Constructors
Constructor and Description
`CryptoKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CryptoKey`	`clone()`
`java.lang.String`	`getCreateTime()` Output only.
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` Labels with user-defined metadata.
`java.lang.String`	`getName()` Output only.
`java.lang.String`	`getNextRotationTime()` At next_rotation_time, the Key Management Service will automatically: 1.
`CryptoKeyVersion`	`getPrimary()` Output only.
`java.lang.String`	`getPurpose()` Immutable.
`java.lang.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(java.lang.String fieldName, java.lang.Object value)`
`CryptoKey`	`setCreateTime(java.lang.String createTime)` Output only.
`CryptoKey`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` Labels with user-defined metadata.
`CryptoKey`	`setName(java.lang.String name)` Output only.
`CryptoKey`	`setNextRotationTime(java.lang.String nextRotationTime)` At next_rotation_time, the Key Management Service will automatically: 1.
`CryptoKey`	`setPrimary(CryptoKeyVersion primary)` Output only.
`CryptoKey`	`setPurpose(java.lang.String purpose)` Immutable.
`CryptoKey`	`setRotationPeriod(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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 java.lang.String getCreateTime()
```
    Output only. The time at which this CryptoKey was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public CryptoKey setCreateTime(java.lang.String createTime)
```
    Output only. The time at which this CryptoKey was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getPurpose()
```
    Immutable. The immutable purpose of this CryptoKey.
    
    Returns:
    
    value or null for none
  - setPurpose
```
public CryptoKey setPurpose(java.lang.String purpose)
```
    Immutable. The immutable purpose of this CryptoKey.
    
    Parameters:
    
    purpose - purpose or null for none
  - getRotationPeriod
```
public java.lang.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(java.lang.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(java.lang.String fieldName,
                     java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CryptoKey clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Key Management Service (KMS) API v1 (revision 108)

Class CryptoKey

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

CryptoKey

Method Detail

getCreateTime

setCreateTime

getLabels

setLabels

getName

setName

getNextRotationTime

setNextRotationTime

getPrimary

setPrimary

getPurpose

setPurpose

getRotationPeriod

setRotationPeriod

getVersionTemplate

setVersionTemplate

set

clone