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 |
|---|
| Type | Description |
int | |
CRYPTO_KEY_VERSION_FIELD_NUMBER
public static final int CRYPTO_KEY_VERSION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IMPORT_JOB_FIELD_NUMBER
public static final int IMPORT_JOB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RSA_AES_WRAPPED_KEY_FIELD_NUMBER
public static final int RSA_AES_WRAPPED_KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WRAPPED_KEY_FIELD_NUMBER
public static final int WRAPPED_KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ImportCryptoKeyVersionRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ImportCryptoKeyVersionRequest.Builder newBuilder()
newBuilder(ImportCryptoKeyVersionRequest prototype)
public static ImportCryptoKeyVersionRequest.Builder newBuilder(ImportCryptoKeyVersionRequest prototype)
public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input)
public static ImportCryptoKeyVersionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ImportCryptoKeyVersionRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ImportCryptoKeyVersionRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input)
public static ImportCryptoKeyVersionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(InputStream input)
public static ImportCryptoKeyVersionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ImportCryptoKeyVersionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ImportCryptoKeyVersionRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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];
| Returns |
|---|
| 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) = { ... }
| Returns |
|---|
| 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for cryptoKeyVersion.
|
getDefaultInstanceForType()
public ImportCryptoKeyVersionRequest getDefaultInstanceForType()
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 |
|---|
| 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];
| Returns |
|---|
| Type | Description |
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 |
|---|
| 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for parent.
|
getParserForType()
public Parser<ImportCryptoKeyVersionRequest> getParserForType()
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 |
|---|
| Type | Description |
ByteString | The rsaAesWrappedKey.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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];
getWrappedKeyMaterialCase()
public ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase getWrappedKeyMaterialCase()
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 |
|---|
| Type | Description |
boolean | Whether the rsaAesWrappedKey field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ImportCryptoKeyVersionRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ImportCryptoKeyVersionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ImportCryptoKeyVersionRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
