com.google.cloud.kms.v1

Class ImportCryptoKeyVersionRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.kms.v1.ImportCryptoKeyVersionRequest

All Implemented Interfaces:

ImportCryptoKeyVersionRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class ImportCryptoKeyVersionRequest
extends GeneratedMessageV3
implements ImportCryptoKeyVersionRequestOrBuilder

 Request message for
 [KeyManagementService.ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion].
 

Protobuf type google.cloud.kms.v1.ImportCryptoKeyVersionRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportCryptoKeyVersionRequest.Builder Request message for [KeyManagementService.ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion].
static class	ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALGORITHM_FIELD_NUMBER
static int	CRYPTO_KEY_VERSION_FIELD_NUMBER
static int	IMPORT_JOB_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	RSA_AES_WRAPPED_KEY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CryptoKeyVersion.CryptoKeyVersionAlgorithm	getAlgorithm() Required.
int	getAlgorithmValue() Required.
String	getCryptoKeyVersion() Optional.
ByteString	getCryptoKeyVersionBytes() Optional.
static ImportCryptoKeyVersionRequest	getDefaultInstance()
ImportCryptoKeyVersionRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getImportJob() Required.
ByteString	getImportJobBytes() Required.
String	getParent() Required.
ByteString	getParentBytes() Required.
Parser<ImportCryptoKeyVersionRequest>	getParserForType()
ByteString	getRsaAesWrappedKey() Wrapped key material produced with [RSA_OAEP_3072_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256] or [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256].
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase	getWrappedKeyMaterialCase()
int	hashCode()
boolean	hasRsaAesWrappedKey() Wrapped key material produced with [RSA_OAEP_3072_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256] or [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256].
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ImportCryptoKeyVersionRequest.Builder	newBuilder()
static ImportCryptoKeyVersionRequest.Builder	newBuilder(ImportCryptoKeyVersionRequest prototype)
ImportCryptoKeyVersionRequest.Builder	newBuilderForType()
protected ImportCryptoKeyVersionRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ImportCryptoKeyVersionRequest	parseDelimitedFrom(InputStream input)
static ImportCryptoKeyVersionRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ImportCryptoKeyVersionRequest	parseFrom(byte[] data)
static ImportCryptoKeyVersionRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ImportCryptoKeyVersionRequest	parseFrom(ByteBuffer data)
static ImportCryptoKeyVersionRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ImportCryptoKeyVersionRequest	parseFrom(ByteString data)
static ImportCryptoKeyVersionRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ImportCryptoKeyVersionRequest	parseFrom(CodedInputStream input)
static ImportCryptoKeyVersionRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ImportCryptoKeyVersionRequest	parseFrom(InputStream input)
static ImportCryptoKeyVersionRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ImportCryptoKeyVersionRequest>	parser()
ImportCryptoKeyVersionRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

CRYPTO_KEY_VERSION_FIELD_NUMBER

public static final int CRYPTO_KEY_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER

See Also:

Constant Field Values

IMPORT_JOB_FIELD_NUMBER

public static final int IMPORT_JOB_FIELD_NUMBER

See Also:

Constant Field Values

RSA_AES_WRAPPED_KEY_FIELD_NUMBER

public static final int RSA_AES_WRAPPED_KEY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getWrappedKeyMaterialCase

public ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase getWrappedKeyMaterialCase()

Specified by:

getWrappedKeyMaterialCase in interface ImportCryptoKeyVersionRequestOrBuilder

getParent

public String getParent()

 Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] to be imported into.
 The create permission is only required on this key when creating a new
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
 

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

Specified by:

getParent in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The parent.

getParentBytes

public ByteString getParentBytes()

 Required. The [name][google.cloud.kms.v1.CryptoKey.name] of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] to be imported into.
 The create permission is only required on this key when creating a new
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
 

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

Specified by:

getParentBytes in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The bytes for parent.

getCryptoKeyVersion

public String getCryptoKeyVersion()

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

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

Specified by:

getCryptoKeyVersion in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The cryptoKeyVersion.

getCryptoKeyVersionBytes

public ByteString getCryptoKeyVersionBytes()

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

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

Specified by:

getCryptoKeyVersionBytes in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The bytes for cryptoKeyVersion.

getAlgorithmValue

public int getAlgorithmValue()

 Required. The
 [algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
 of the key being imported. This does not need to match the
 [version_template][google.cloud.kms.v1.CryptoKey.version_template] of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] this version imports into.
 

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

Specified by:

getAlgorithmValue in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The enum numeric value on the wire for algorithm.

getAlgorithm

public CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()

 Required. The
 [algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
 of the key being imported. This does not need to match the
 [version_template][google.cloud.kms.v1.CryptoKey.version_template] of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] this version imports into.
 

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

Specified by:

getAlgorithm in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The algorithm.

getImportJob

public String getImportJob()

 Required. The [name][google.cloud.kms.v1.ImportJob.name] of the
 [ImportJob][google.cloud.kms.v1.ImportJob] that was used to wrap this key
 material.
 

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

Specified by:

getImportJob in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The importJob.

getImportJobBytes

public ByteString getImportJobBytes()

 Required. The [name][google.cloud.kms.v1.ImportJob.name] of the
 [ImportJob][google.cloud.kms.v1.ImportJob] that was used to wrap this key
 material.
 

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

Specified by:

getImportJobBytes in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The bytes for importJob.

hasRsaAesWrappedKey

public boolean hasRsaAesWrappedKey()

 Wrapped key material produced with
 [RSA_OAEP_3072_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256]
 or
 [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256].
 This field contains the concatenation of two wrapped keys:
 <ol>
   <li>An ephemeral AES-256 wrapping key wrapped with the
       [public_key][google.cloud.kms.v1.ImportJob.public_key] using
       RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an
       empty label.
   </li>
   <li>The key to be imported, wrapped with the ephemeral AES-256 key
       using AES-KWP (RFC 5649).
   </li>
 </ol>
 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.
 

bytes rsa_aes_wrapped_key = 5;

Specified by:

hasRsaAesWrappedKey in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

Whether the rsaAesWrappedKey field is set.

getRsaAesWrappedKey

public ByteString getRsaAesWrappedKey()

 Wrapped key material produced with
 [RSA_OAEP_3072_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA1_AES_256]
 or
 [RSA_OAEP_4096_SHA1_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA1_AES_256].
 This field contains the concatenation of two wrapped keys:
 <ol>
   <li>An ephemeral AES-256 wrapping key wrapped with the
       [public_key][google.cloud.kms.v1.ImportJob.public_key] using
       RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an
       empty label.
   </li>
   <li>The key to be imported, wrapped with the ephemeral AES-256 key
       using AES-KWP (RFC 5649).
   </li>
 </ol>
 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.
 

bytes rsa_aes_wrapped_key = 5;

Specified by:

getRsaAesWrappedKey in interface ImportCryptoKeyVersionRequestOrBuilder

Returns:

The rsaAesWrappedKey.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data,
                                                      ExtensionRegistryLite extensionRegistry)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(ByteString data)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(ByteString data,
                                                      ExtensionRegistryLite extensionRegistry)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(byte[] data)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(byte[] data,
                                                      ExtensionRegistryLite extensionRegistry)
                                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(InputStream input,
                                                      ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input,
                                                               ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input,
                                                      ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public ImportCryptoKeyVersionRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ImportCryptoKeyVersionRequest.Builder newBuilder()

newBuilder

public static ImportCryptoKeyVersionRequest.Builder newBuilder(ImportCryptoKeyVersionRequest prototype)

toBuilder

public ImportCryptoKeyVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ImportCryptoKeyVersionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ImportCryptoKeyVersionRequest getDefaultInstance()

parser

public static Parser<ImportCryptoKeyVersionRequest> parser()

getParserForType

public Parser<ImportCryptoKeyVersionRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ImportCryptoKeyVersionRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder