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

Class ImportJob

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ImportJob
extends GenericJson

An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS. When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material. Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key. An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key. For more information, see [Importing a key](https://cloud.google.com/kms/docs/importing-a-key).

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
ImportJob()

Method Summary

Modifier and Type	Method and Description
ImportJob	clone()
KeyOperationAttestation	getAttestation() Output only.
String	getCreateTime() Output only.
String	getExpireEventTime() Output only.
String	getExpireTime() Output only.
String	getGenerateTime() Output only.
String	getImportMethod() Required.
String	getName() Output only.
String	getProtectionLevel() Required.
WrappingPublicKey	getPublicKey() Output only.
String	getState() Output only.
ImportJob	set(String fieldName, Object value)
ImportJob	setAttestation(KeyOperationAttestation attestation) Output only.
ImportJob	setCreateTime(String createTime) Output only.
ImportJob	setExpireEventTime(String expireEventTime) Output only.
ImportJob	setExpireTime(String expireTime) Output only.
ImportJob	setGenerateTime(String generateTime) Output only.
ImportJob	setImportMethod(String importMethod) Required.
ImportJob	setName(String name) Output only.
ImportJob	setProtectionLevel(String protectionLevel) Required.
ImportJob	setPublicKey(WrappingPublicKey publicKey) Output only.
ImportJob	setState(String state) Output only.

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

ImportJob

public ImportJob()

Method Detail

getAttestation

public KeyOperationAttestation getAttestation()

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.

Returns:

value or null for none

setAttestation

public ImportJob setAttestation(KeyOperationAttestation attestation)

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.

Parameters:

attestation - attestation or null for none

getCreateTime

public String getCreateTime()

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

Returns:

value or null for none

setCreateTime

public ImportJob setCreateTime(String createTime)

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

Parameters:

createTime - createTime or null for none

getExpireEventTime

public String getExpireEventTime()

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

Returns:

value or null for none

setExpireEventTime

public ImportJob setExpireEventTime(String expireEventTime)

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

Parameters:

expireEventTime - expireEventTime or null for none

getExpireTime

public String getExpireTime()

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

Returns:

value or null for none

setExpireTime

public ImportJob setExpireTime(String expireTime)

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

Parameters:

expireTime - expireTime or null for none

getGenerateTime

public String getGenerateTime()

Output only. The time this ImportJob's key material was generated.

Returns:

value or null for none

setGenerateTime

public ImportJob setGenerateTime(String generateTime)

Output only. The time this ImportJob's key material was generated.

Parameters:

generateTime - generateTime or null for none

getImportMethod

public String getImportMethod()

Required. Immutable. The wrapping method to be used for incoming key material.

Returns:

value or null for none

setImportMethod

public ImportJob setImportMethod(String importMethod)

Required. Immutable. The wrapping method to be used for incoming key material.

Parameters:

importMethod - importMethod or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public ImportJob setName(String name)

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

Parameters:

name - name or null for none

getProtectionLevel

public String getProtectionLevel()

Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.

Returns:

value or null for none

setProtectionLevel

public ImportJob setProtectionLevel(String protectionLevel)

Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.

Parameters:

protectionLevel - protectionLevel or null for none

getPublicKey

public WrappingPublicKey getPublicKey()

Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.

Returns:

value or null for none

setPublicKey

public ImportJob setPublicKey(WrappingPublicKey publicKey)

Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.

Parameters:

publicKey - publicKey or null for none

getState

public String getState()

Output only. The current state of the ImportJob, indicating if it can be used.

Returns:

value or null for none

setState

public ImportJob setState(String state)

Output only. The current state of the ImportJob, indicating if it can be used.

Parameters:

state - state or null for none

set

public ImportJob set(String fieldName,
                     Object value)

Overrides:

set in class GenericJson

clone

public ImportJob clone()

Overrides:

clone in class GenericJson