CryptoKeyVersion (Cloud Key Management Service (KMS) API v1-rev20190626-1.30.1)

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.CryptoKeyVersion

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class CryptoKeyVersion
extends GenericJson
```
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
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

CryptoKeyVersion()

Constructors
Constructor and Description
`CryptoKeyVersion()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CryptoKeyVersion`	`clone()`
`String`	`getAlgorithm()` Output only.
`KeyOperationAttestation`	`getAttestation()` Output only.
`String`	`getCreateTime()` Output only.
`String`	`getDestroyEventTime()` Output only.
`String`	`getDestroyTime()` Output only.
`String`	`getGenerateTime()` Output only.
`String`	`getImportFailureReason()` Output only.
`String`	`getImportJob()` Output only.
`String`	`getImportTime()` Output only.
`String`	`getName()` Output only.
`String`	`getProtectionLevel()` Output only.
`String`	`getState()` The current state of the CryptoKeyVersion.
`CryptoKeyVersion`	`set(String fieldName, Object value)`
`CryptoKeyVersion`	`setAlgorithm(String algorithm)` Output only.
`CryptoKeyVersion`	`setAttestation(KeyOperationAttestation attestation)` Output only.
`CryptoKeyVersion`	`setCreateTime(String createTime)` Output only.
`CryptoKeyVersion`	`setDestroyEventTime(String destroyEventTime)` Output only.
`CryptoKeyVersion`	`setDestroyTime(String destroyTime)` Output only.
`CryptoKeyVersion`	`setGenerateTime(String generateTime)` Output only.
`CryptoKeyVersion`	`setImportFailureReason(String importFailureReason)` Output only.
`CryptoKeyVersion`	`setImportJob(String importJob)` Output only.
`CryptoKeyVersion`	`setImportTime(String importTime)` Output only.
`CryptoKeyVersion`	`setName(String name)` Output only.
`CryptoKeyVersion`	`setProtectionLevel(String protectionLevel)` Output only.
`CryptoKeyVersion`	`setState(String state)` The current state of the CryptoKeyVersion.

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
  - CryptoKeyVersion
```
public CryptoKeyVersion()
```
- Method Detail
  - getAlgorithm
```
public String getAlgorithm()
```
    Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
    
    Returns:
    
    value or null for none
  - setAlgorithm
```
public CryptoKeyVersion setAlgorithm(String algorithm)
```
    Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
    
    Parameters:
    
    algorithm - algorithm or null for none
  - getAttestation
```
public KeyOperationAttestation getAttestation()
```
    Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
    
    Returns:
    
    value or null for none
  - setAttestation
```
public CryptoKeyVersion setAttestation(KeyOperationAttestation attestation)
```
    Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
    
    Parameters:
    
    attestation - attestation or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time at which this CryptoKeyVersion was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public CryptoKeyVersion setCreateTime(String createTime)
```
    Output only. The time at which this CryptoKeyVersion was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDestroyEventTime
```
public String getDestroyEventTime()
```
    Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
    
    Returns:
    
    value or null for none
  - setDestroyEventTime
```
public CryptoKeyVersion setDestroyEventTime(String destroyEventTime)
```
    Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
    
    Parameters:
    
    destroyEventTime - destroyEventTime or null for none
  - getDestroyTime
```
public String getDestroyTime()
```
    Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
    
    Returns:
    
    value or null for none
  - setDestroyTime
```
public CryptoKeyVersion setDestroyTime(String destroyTime)
```
    Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
    
    Parameters:
    
    destroyTime - destroyTime or null for none
  - getGenerateTime
```
public String getGenerateTime()
```
    Output only. The time this CryptoKeyVersion's key material was generated.
    
    Returns:
    
    value or null for none
  - setGenerateTime
```
public CryptoKeyVersion setGenerateTime(String generateTime)
```
    Output only. The time this CryptoKeyVersion's key material was generated.
    
    Parameters:
    
    generateTime - generateTime or null for none
  - getImportFailureReason
```
public String getImportFailureReason()
```
    Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
    
    Returns:
    
    value or null for none
  - setImportFailureReason
```
public CryptoKeyVersion setImportFailureReason(String importFailureReason)
```
    Output only. The root cause of an import failure. Only present if state is IMPORT_FAILED.
    
    Parameters:
    
    importFailureReason - importFailureReason or null for none
  - getImportJob
```
public String getImportJob()
```
    Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
    
    Returns:
    
    value or null for none
  - setImportJob
```
public CryptoKeyVersion setImportJob(String importJob)
```
    Output only. The name of the ImportJob used to import this CryptoKeyVersion. Only present if the underlying key material was imported.
    
    Parameters:
    
    importJob - importJob or null for none
  - getImportTime
```
public String getImportTime()
```
    Output only. The time at which this CryptoKeyVersion's key material was imported.
    
    Returns:
    
    value or null for none
  - setImportTime
```
public CryptoKeyVersion setImportTime(String importTime)
```
    Output only. The time at which this CryptoKeyVersion's key material was imported.
    
    Parameters:
    
    importTime - importTime or null for none
  - getName
```
public String getName()
```
    Output only. The resource name for this CryptoKeyVersion in the format `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`.
    
    Returns:
    
    value or null for none
  - setName
```
public CryptoKeyVersion setName(String name)
```
    Output only. The resource name for this CryptoKeyVersion in the format `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`.
    
    Parameters:
    
    name - name or null for none
  - getProtectionLevel
```
public String getProtectionLevel()
```
    Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
    
    Returns:
    
    value or null for none
  - setProtectionLevel
```
public CryptoKeyVersion setProtectionLevel(String protectionLevel)
```
    Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
    
    Parameters:
    
    protectionLevel - protectionLevel or null for none
  - getState
```
public String getState()
```
    The current state of the CryptoKeyVersion.
    
    Returns:
    
    value or null for none
  - setState
```
public CryptoKeyVersion setState(String state)
```
    The current state of the CryptoKeyVersion.
    
    Parameters:
    
    state - state or null for none
  - set
```
public CryptoKeyVersion set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public CryptoKeyVersion clone()
```
    Overrides:
    
    clone in class GenericJson

Class CryptoKeyVersion

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

CryptoKeyVersion

Method Detail

getAlgorithm

setAlgorithm

getAttestation

setAttestation

getCreateTime

setCreateTime

getDestroyEventTime

setDestroyEventTime

getDestroyTime

setDestroyTime

getGenerateTime

setGenerateTime

getImportFailureReason

setImportFailureReason

getImportJob

setImportJob

getImportTime

setImportTime

getName

setName

getProtectionLevel

setProtectionLevel

getState

setState

set

clone