public final class ImportCryptoKeyVersionRequest extends GeneratedMessageV3 implements ImportCryptoKeyVersionRequestOrBuilder
Request message for KeyManagementService.ImportCryptoKeyVersion.
Protobuf type google.cloud.kms.v1.ImportCryptoKeyVersionRequest
Fields
ALGORITHM_FIELD_NUMBER
public static final int ALGORITHM_FIELD_NUMBER
Field Value
CRYPTO_KEY_VERSION_FIELD_NUMBER
public static final int CRYPTO_KEY_VERSION_FIELD_NUMBER
Field Value
IMPORT_JOB_FIELD_NUMBER
public static final int IMPORT_JOB_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
RSA_AES_WRAPPED_KEY_FIELD_NUMBER
public static final int RSA_AES_WRAPPED_KEY_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
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];
| Type | Description |
| 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) = { ... }
| Type | Description |
| 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) = { ... }
| Type | Description |
| ByteString | The bytes for cryptoKeyVersion.
|
getDefaultInstance()
public static ImportCryptoKeyVersionRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public ImportCryptoKeyVersionRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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];
| Type | Description |
| 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];
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) = { ... }
| Type | Description |
| 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) = { ... }
getParserForType()
public Parser<ImportCryptoKeyVersionRequest> getParserForType()
Returns
Overrides
getRsaAesWrappedKey()
public ByteString 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:
<ol>
<li>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.
</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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getWrappedKeyMaterialCase()
public ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase getWrappedKeyMaterialCase()
Returns
hasRsaAesWrappedKey()
public boolean hasRsaAesWrappedKey()
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:
<ol>
<li>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.
</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;
| Type | Description |
| boolean | Whether the rsaAesWrappedKey field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ImportCryptoKeyVersionRequest.Builder newBuilder()
Returns
newBuilder(ImportCryptoKeyVersionRequest prototype)
public static ImportCryptoKeyVersionRequest.Builder newBuilder(ImportCryptoKeyVersionRequest prototype)
Parameter
Returns
newBuilderForType()
public ImportCryptoKeyVersionRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ImportCryptoKeyVersionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ImportCryptoKeyVersionRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ImportCryptoKeyVersionRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportCryptoKeyVersionRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ImportCryptoKeyVersionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ImportCryptoKeyVersionRequest> parser()
Returns
toBuilder()
public ImportCryptoKeyVersionRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
