Class ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder (2.98.0) 

public static final class ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder extends GeneratedMessage.Builder<ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder> implements ImportTrustedKeyWrappedCryptoKeyVersionRequestOrBuilder

Request message for KeyManagementService.ImportTrustedKeyWrappedCryptoKeyVersion.

Protobuf type google.cloud.kms.v1.ImportTrustedKeyWrappedCryptoKeyVersionRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest build()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest

buildPartial()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest buildPartial()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest

clear()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder clear()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder
Overrides

clearAlgorithm()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder clearAlgorithm()

Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

clearCryptoKeyVersion()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.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 ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

clearImportingKey()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder clearImportingKey()

Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.

string importing_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

clearParent()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder clearParent()

Required. The name of the CryptoKey to be imported into.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

clearWrappedKey()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder clearWrappedKey()

Required. The target key pre-wrapped on premises.

bytes wrapped_key = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

getAlgorithm()

public CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()

Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

Required. 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 = 5 [(.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 ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

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 ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cryptoKeyVersion.

getDefaultInstanceForType()

public ImportTrustedKeyWrappedCryptoKeyVersionRequest getDefaultInstanceForType()
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getImportingKey()

public String getImportingKey()

Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.

string importing_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The importingKey.

getImportingKeyBytes()

public ByteString getImportingKeyBytes()

Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.

string importing_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for importingKey.

getParent()

public String getParent()

Required. The name of the CryptoKey to be imported into.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the CryptoKey to be imported into.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getWrappedKey()

public ByteString getWrappedKey()

Required. The target key pre-wrapped on premises.

bytes wrapped_key = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The wrappedKey.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ImportTrustedKeyWrappedCryptoKeyVersionRequest other)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder mergeFrom(ImportTrustedKeyWrappedCryptoKeyVersionRequest other)
Parameter
Name Description
other ImportTrustedKeyWrappedCryptoKeyVersionRequest
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder
Overrides

setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setAlgorithmValue(int value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder setAlgorithmValue(int value)

Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for algorithm to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setCryptoKeyVersion(String value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.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 ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The cryptoKeyVersion to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setCryptoKeyVersionBytes(ByteString value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.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 ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, 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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for cryptoKeyVersion to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setImportingKey(String value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder setImportingKey(String value)

Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.

string importing_key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The importingKey to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setImportingKeyBytes(ByteString value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder setImportingKeyBytes(ByteString value)

Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.

string importing_key = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for importingKey to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setParent(String value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder setParent(String value)

Required. The name of the CryptoKey to be imported into.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder setParentBytes(ByteString value)

Required. The name of the CryptoKey to be imported into.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.

setWrappedKey(ByteString value)

public ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder setWrappedKey(ByteString value)

Required. The target key pre-wrapped on premises.

bytes wrapped_key = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The wrappedKey to set.
Returns
Type Description
ImportTrustedKeyWrappedCryptoKeyVersionRequest.Builder

This builder for chaining.