Class ImportCryptoKeyVersionRequest (2.24.0)

public final class ImportCryptoKeyVersionRequest extends GeneratedMessageV3 implements ImportCryptoKeyVersionRequestOrBuilder

Request message for KeyManagementService.ImportCryptoKeyVersion.

Protobuf type google.cloud.kms.v1.ImportCryptoKeyVersionRequest

Static Fields

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER
Field Value
TypeDescription
int

CRYPTO_KEY_VERSION_FIELD_NUMBER

public static final int CRYPTO_KEY_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

IMPORT_JOB_FIELD_NUMBER

public static final int IMPORT_JOB_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

RSA_AES_WRAPPED_KEY_FIELD_NUMBER

public static final int RSA_AES_WRAPPED_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

WRAPPED_KEY_FIELD_NUMBER

public static final int WRAPPED_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportCryptoKeyVersionRequest getDefaultInstance()
Returns
TypeDescription
ImportCryptoKeyVersionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImportCryptoKeyVersionRequest.Builder newBuilder()
Returns
TypeDescription
ImportCryptoKeyVersionRequest.Builder

newBuilder(ImportCryptoKeyVersionRequest prototype)

public static ImportCryptoKeyVersionRequest.Builder newBuilder(ImportCryptoKeyVersionRequest prototype)
Parameter
NameDescription
prototypeImportCryptoKeyVersionRequest
Returns
TypeDescription
ImportCryptoKeyVersionRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImportCryptoKeyVersionRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportCryptoKeyVersionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportCryptoKeyVersionRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportCryptoKeyVersionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImportCryptoKeyVersionRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportCryptoKeyVersionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportCryptoKeyVersionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImportCryptoKeyVersionRequest> parser()
Returns
TypeDescription
Parser<ImportCryptoKeyVersionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAlgorithm()

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

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

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

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for algorithm.

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.

string crypto_key_version = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The cryptoKeyVersion.

getCryptoKeyVersionBytes()

public ByteString getCryptoKeyVersionBytes()

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.

string crypto_key_version = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for cryptoKeyVersion.

getDefaultInstanceForType()

public ImportCryptoKeyVersionRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportCryptoKeyVersionRequest

getImportJob()

public String getImportJob()

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

string import_job = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The importJob.

getImportJobBytes()

public ByteString getImportJobBytes()

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

string import_job = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for importJob.

getParent()

public String getParent()

Required. The name of the CryptoKey to be imported into.

The create permission is only required on this key when creating a new CryptoKeyVersion.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the CryptoKey to be imported into.

The create permission is only required on this key when creating a new CryptoKeyVersion.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ImportCryptoKeyVersionRequest> getParserForType()
Returns
TypeDescription
Parser<ImportCryptoKeyVersionRequest>
Overrides

getRsaAesWrappedKey()

public ByteString 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.

bytes rsa_aes_wrapped_key = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The rsaAesWrappedKey.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getWrappedKey()

public ByteString 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: <ol> <li>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. </li> <li>The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). </li> </ol>

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.

bytes wrapped_key = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The wrappedKey.

getWrappedKeyMaterialCase()

public ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase getWrappedKeyMaterialCase()
Returns
TypeDescription
ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase

hasRsaAesWrappedKey()

public boolean hasRsaAesWrappedKey()

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.

bytes rsa_aes_wrapped_key = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the rsaAesWrappedKey field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ImportCryptoKeyVersionRequest.Builder newBuilderForType()
Returns
TypeDescription
ImportCryptoKeyVersionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportCryptoKeyVersionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImportCryptoKeyVersionRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ImportCryptoKeyVersionRequest.Builder toBuilder()
Returns
TypeDescription
ImportCryptoKeyVersionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException