public static final class ImportCryptoKeyVersionRequest.Builder extends GeneratedMessageV3.Builder<ImportCryptoKeyVersionRequest.Builder> implements ImportCryptoKeyVersionRequestOrBuilderRequest message for KeyManagementService.ImportCryptoKeyVersion.
Protobuf type google.cloud.kms.v1.ImportCryptoKeyVersionRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ImportCryptoKeyVersionRequest.BuilderImplements
ImportCryptoKeyVersionRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ImportCryptoKeyVersionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
build()
public ImportCryptoKeyVersionRequest build()| Type | Description |
| ImportCryptoKeyVersionRequest |
buildPartial()
public ImportCryptoKeyVersionRequest buildPartial()| Type | Description |
| ImportCryptoKeyVersionRequest |
clear()
public ImportCryptoKeyVersionRequest.Builder clear()| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
clearAlgorithm()
public ImportCryptoKeyVersionRequest.Builder clearAlgorithm()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 |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
clearCryptoKeyVersion()
public ImportCryptoKeyVersionRequest.Builder clearCryptoKeyVersion()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 |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ImportCryptoKeyVersionRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
clearImportJob()
public ImportCryptoKeyVersionRequest.Builder clearImportJob()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 |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ImportCryptoKeyVersionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
clearParent()
public ImportCryptoKeyVersionRequest.Builder clearParent()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 |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
clearRsaAesWrappedKey()
public ImportCryptoKeyVersionRequest.Builder clearRsaAesWrappedKey()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/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;
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
clearWrappedKeyMaterial()
public ImportCryptoKeyVersionRequest.Builder clearWrappedKeyMaterial()| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
clone()
public ImportCryptoKeyVersionRequest.Builder clone()| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
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];
| Type | Description |
| 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];
| 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. |
getDefaultInstanceForType()
public ImportCryptoKeyVersionRequest getDefaultInstanceForType()| Type | Description |
| ImportCryptoKeyVersionRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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];
| 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) = { ... }
| 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) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
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/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;
| Type | Description |
| ByteString | The rsaAesWrappedKey. |
getWrappedKeyMaterialCase()
public ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase getWrappedKeyMaterialCase()| Type | Description |
| ImportCryptoKeyVersionRequest.WrappedKeyMaterialCase |
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/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;
| Type | Description |
| boolean | Whether the rsaAesWrappedKey field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(ImportCryptoKeyVersionRequest other)
public ImportCryptoKeyVersionRequest.Builder mergeFrom(ImportCryptoKeyVersionRequest other)| Name | Description |
| other | ImportCryptoKeyVersionRequest |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ImportCryptoKeyVersionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ImportCryptoKeyVersionRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ImportCryptoKeyVersionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)
public ImportCryptoKeyVersionRequest.Builder setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)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];
| Name | Description |
| value | CryptoKeyVersion.CryptoKeyVersionAlgorithmThe algorithm to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setAlgorithmValue(int value)
public ImportCryptoKeyVersionRequest.Builder setAlgorithmValue(int value)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];
| Name | Description |
| value | intThe enum numeric value on the wire for algorithm to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setCryptoKeyVersion(String value)
public ImportCryptoKeyVersionRequest.Builder setCryptoKeyVersion(String value)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) = { ... }
| Name | Description |
| value | StringThe cryptoKeyVersion to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setCryptoKeyVersionBytes(ByteString value)
public ImportCryptoKeyVersionRequest.Builder setCryptoKeyVersionBytes(ByteString value)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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for cryptoKeyVersion to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ImportCryptoKeyVersionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
setImportJob(String value)
public ImportCryptoKeyVersionRequest.Builder setImportJob(String value)Required. The name of the ImportJob that was used to wrap this key material.
string import_job = 4 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | StringThe importJob to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setImportJobBytes(ByteString value)
public ImportCryptoKeyVersionRequest.Builder setImportJobBytes(ByteString value)Required. The name of the ImportJob that was used to wrap this key material.
string import_job = 4 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | ByteStringThe bytes for importJob to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setParent(String value)
public ImportCryptoKeyVersionRequest.Builder setParent(String value)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) = { ... }
| Name | Description |
| value | StringThe parent to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ImportCryptoKeyVersionRequest.Builder setParentBytes(ByteString value)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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for parent to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ImportCryptoKeyVersionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |
setRsaAesWrappedKey(ByteString value)
public ImportCryptoKeyVersionRequest.Builder setRsaAesWrappedKey(ByteString value)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/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;
| Name | Description |
| value | ByteStringThe rsaAesWrappedKey to set. |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ImportCryptoKeyVersionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ImportCryptoKeyVersionRequest.Builder |