com.google.cloud.kms.v1

Interface ImportCryptoKeyVersionRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ImportCryptoKeyVersionRequest, ImportCryptoKeyVersionRequest.Builder

public interface ImportCryptoKeyVersionRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CryptoKeyVersion.CryptoKeyVersionAlgorithm	getAlgorithm() Required.
int	getAlgorithmValue() Required.
String	getCryptoKeyVersion() Optional.
com.google.protobuf.ByteString	getCryptoKeyVersionBytes() Optional.
String	getImportJob() Required.
com.google.protobuf.ByteString	getImportJobBytes() Required.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.ByteString	getRsaAesWrappedKey() Optional.
com.google.protobuf.ByteString	getWrappedKey() Optional.
ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase	getWrappedKeyMaterialCase()
boolean	hasRsaAesWrappedKey() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.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) = { ... }

Returns:

The bytes for parent.

getCryptoKeyVersion

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) = { ... }

Returns:

The cryptoKeyVersion.

getCryptoKeyVersionBytes

com.google.protobuf.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) = { ... }

Returns:

The bytes for cryptoKeyVersion.

getAlgorithmValue

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

Returns:

The enum numeric value on the wire for algorithm.

getAlgorithm

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

Returns:

The algorithm.

getImportJob

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

Returns:

The importJob.

getImportJobBytes

com.google.protobuf.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];

Returns:

The bytes for importJob.

getWrappedKey

com.google.protobuf.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][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]
 or
 [RSA_OAEP_3072_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256_AES_256]
 or
 [RSA_OAEP_4096_SHA256_AES_256][google.cloud.kms.v1.ImportJob.ImportMethod.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][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 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][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_3072_SHA256]
 or
 [RSA_OAEP_4096_SHA256][google.cloud.kms.v1.ImportJob.ImportMethod.RSA_OAEP_4096_SHA256]),

 this field must contain the formatted key to be imported, wrapped with the
 [public_key][google.cloud.kms.v1.ImportJob.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:

The wrappedKey.

hasRsaAesWrappedKey

boolean hasRsaAesWrappedKey()

 Optional. This field has the same meaning as
 [wrapped_key][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.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:

Whether the rsaAesWrappedKey field is set.

getRsaAesWrappedKey

com.google.protobuf.ByteString getRsaAesWrappedKey()

 Optional. This field has the same meaning as
 [wrapped_key][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.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:

The rsaAesWrappedKey.

getWrappedKeyMaterialCase

ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase getWrappedKeyMaterialCase()