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

Class ImportCryptoKeyVersionRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ImportCryptoKeyVersionRequest
extends com.google.api.client.json.GenericJson

Request message for KeyManagementService.ImportCryptoKeyVersion.

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

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

Method Summary

Modifier and Type	Method and Description
ImportCryptoKeyVersionRequest	clone()
byte[]	decodeRsaAesWrappedKey() Optional.
byte[]	decodeWrappedKey() Optional.
ImportCryptoKeyVersionRequest	encodeRsaAesWrappedKey(byte[] rsaAesWrappedKey) Optional.
ImportCryptoKeyVersionRequest	encodeWrappedKey(byte[] wrappedKey) Optional.
String	getAlgorithm() Required.
String	getCryptoKeyVersion() Optional.
String	getImportJob() Required.
String	getRsaAesWrappedKey() Optional.
Boolean	getTrustedWrappingEnabled() Optional.
String	getWrappedKey() Optional.
ImportCryptoKeyVersionRequest	set(String fieldName, Object value)
ImportCryptoKeyVersionRequest	setAlgorithm(String algorithm) Required.
ImportCryptoKeyVersionRequest	setCryptoKeyVersion(String cryptoKeyVersion) Optional.
ImportCryptoKeyVersionRequest	setImportJob(String importJob) Required.
ImportCryptoKeyVersionRequest	setRsaAesWrappedKey(String rsaAesWrappedKey) Optional.
ImportCryptoKeyVersionRequest	setTrustedWrappingEnabled(Boolean trustedWrappingEnabled) Optional.
ImportCryptoKeyVersionRequest	setWrappedKey(String wrappedKey) Optional.

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

ImportCryptoKeyVersionRequest

public ImportCryptoKeyVersionRequest()

Method Detail

getAlgorithm

public String getAlgorithm()

Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.

Returns:

value or null for none

setAlgorithm

public ImportCryptoKeyVersionRequest setAlgorithm(String algorithm)

Required. The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.

Parameters:

algorithm - algorithm or null for none

getCryptoKeyVersion

public String getCryptoKeyVersion()

Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.

Returns:

value or null for none

setCryptoKeyVersion

public ImportCryptoKeyVersionRequest setCryptoKeyVersion(String cryptoKeyVersion)

Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material.

Parameters:

cryptoKeyVersion - cryptoKeyVersion or null for none

getImportJob

public String getImportJob()

Required. The name of the ImportJob that was used to wrap this key material.

Returns:

value or null for none

setImportJob

public ImportCryptoKeyVersionRequest setImportJob(String importJob)

Required. The name of the ImportJob that was used to wrap this key material.

Parameters:

importJob - importJob or null for none

getRsaAesWrappedKey

public String getRsaAesWrappedKey()

Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.

Returns:

value or null for none

See Also:

decodeRsaAesWrappedKey()

decodeRsaAesWrappedKey

public byte[] decodeRsaAesWrappedKey()

Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getRsaAesWrappedKey()

setRsaAesWrappedKey

public ImportCryptoKeyVersionRequest setRsaAesWrappedKey(String rsaAesWrappedKey)

Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.

Parameters:

rsaAesWrappedKey - rsaAesWrappedKey or null for none

See Also:

#encodeRsaAesWrappedKey()

encodeRsaAesWrappedKey

public ImportCryptoKeyVersionRequest encodeRsaAesWrappedKey(byte[] rsaAesWrappedKey)

Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getTrustedWrappingEnabled

public Boolean getTrustedWrappingEnabled()

Optional. Whether trusted wrapping will be enabled on the imported [CryptoKeyVersion]. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes besides ENCRYPT_DECRYPT.

Returns:

value or null for none

setTrustedWrappingEnabled

public ImportCryptoKeyVersionRequest setTrustedWrappingEnabled(Boolean trustedWrappingEnabled)

Optional. Whether trusted wrapping will be enabled on the imported [CryptoKeyVersion]. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes besides ENCRYPT_DECRYPT.

Parameters:

trustedWrappingEnabled - trustedWrappingEnabled or null for none

getWrappedKey

public String getWrappedKey()

Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.

Returns:

value or null for none

See Also:

decodeWrappedKey()

decodeWrappedKey

public byte[] decodeWrappedKey()

Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getWrappedKey()

setWrappedKey

public ImportCryptoKeyVersionRequest setWrappedKey(String wrappedKey)

Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.

Parameters:

wrappedKey - wrappedKey or null for none

See Also:

#encodeWrappedKey()

encodeWrappedKey

public ImportCryptoKeyVersionRequest encodeWrappedKey(byte[] wrappedKey)

Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

set

public ImportCryptoKeyVersionRequest set(String fieldName,
                                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ImportCryptoKeyVersionRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson