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

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() Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256.
ImportCryptoKeyVersionRequest	encodeRsaAesWrappedKey(byte[] rsaAesWrappedKey) Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256.
String	getAlgorithm() Required.
String	getImportJob() Required.
String	getRsaAesWrappedKey() Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256.
ImportCryptoKeyVersionRequest	set(String fieldName, Object value)
ImportCryptoKeyVersionRequest	setAlgorithm(String algorithm) Required.
ImportCryptoKeyVersionRequest	setImportJob(String importJob) Required.
ImportCryptoKeyVersionRequest	setRsaAesWrappedKey(String rsaAesWrappedKey) Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256.

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

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

Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.

Returns:

value or null for none

See Also:

decodeRsaAesWrappedKey()

decodeRsaAesWrappedKey

public byte[] decodeRsaAesWrappedKey()

Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getRsaAesWrappedKey()

setRsaAesWrappedKey

public ImportCryptoKeyVersionRequest setRsaAesWrappedKey(String rsaAesWrappedKey)

Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.

Parameters:

rsaAesWrappedKey - rsaAesWrappedKey or null for none

See Also:

#encodeRsaAesWrappedKey()

encodeRsaAesWrappedKey

public ImportCryptoKeyVersionRequest encodeRsaAesWrappedKey(byte[] rsaAesWrappedKey)

Wrapped key material produced with RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256. This field contains the concatenation of two wrapped keys: An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1, MGF1 with SHA-1, and an empty label. The key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). If importing symmetric key material, it is expected that the unwrapped key contains plain bytes. If importing asymmetric key material, it is expected that the unwrapped key is in PKCS#8-encoded DER format (the PrivateKeyInfo structure from RFC 5208). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP.

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 GenericJson

clone

public ImportCryptoKeyVersionRequest clone()

Overrides:

clone in class GenericJson