Class KmsWrappedCryptoKey.Builder (3.48.0)

public static final class KmsWrappedCryptoKey.Builder extends GeneratedMessageV3.Builder<KmsWrappedCryptoKey.Builder> implements KmsWrappedCryptoKeyOrBuilder

Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt

For more information, see Creating a wrapped key.

Note: When you use Cloud KMS for cryptographic operations, charges apply.

Protobuf type google.privacy.dlp.v2.KmsWrappedCryptoKey

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KmsWrappedCryptoKey.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

build()

public KmsWrappedCryptoKey build()
Returns
Type Description
KmsWrappedCryptoKey

buildPartial()

public KmsWrappedCryptoKey buildPartial()
Returns
Type Description
KmsWrappedCryptoKey

clear()

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

clearCryptoKeyName()

public KmsWrappedCryptoKey.Builder clearCryptoKeyName()

Required. The resource name of the KMS CryptoKey to use for unwrapping.

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

Returns
Type Description
KmsWrappedCryptoKey.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public KmsWrappedCryptoKey.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public KmsWrappedCryptoKey.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

clearWrappedKey()

public KmsWrappedCryptoKey.Builder clearWrappedKey()

Required. The wrapped data crypto key.

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

Returns
Type Description
KmsWrappedCryptoKey.Builder

This builder for chaining.

clone()

public KmsWrappedCryptoKey.Builder clone()
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

getCryptoKeyName()

public String getCryptoKeyName()

Required. The resource name of the KMS CryptoKey to use for unwrapping.

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

Returns
Type Description
String

The cryptoKeyName.

getCryptoKeyNameBytes()

public ByteString getCryptoKeyNameBytes()

Required. The resource name of the KMS CryptoKey to use for unwrapping.

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

Returns
Type Description
ByteString

The bytes for cryptoKeyName.

getDefaultInstanceForType()

public KmsWrappedCryptoKey getDefaultInstanceForType()
Returns
Type Description
KmsWrappedCryptoKey

getDescriptorForType()

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

getWrappedKey()

public ByteString getWrappedKey()

Required. The wrapped data crypto key.

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

Returns
Type Description
ByteString

The wrappedKey.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(KmsWrappedCryptoKey other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KmsWrappedCryptoKey.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

setCryptoKeyName(String value)

public KmsWrappedCryptoKey.Builder setCryptoKeyName(String value)

Required. The resource name of the KMS CryptoKey to use for unwrapping.

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

Parameter
Name Description
value String

The cryptoKeyName to set.

Returns
Type Description
KmsWrappedCryptoKey.Builder

This builder for chaining.

setCryptoKeyNameBytes(ByteString value)

public KmsWrappedCryptoKey.Builder setCryptoKeyNameBytes(ByteString value)

Required. The resource name of the KMS CryptoKey to use for unwrapping.

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

Parameter
Name Description
value ByteString

The bytes for cryptoKeyName to set.

Returns
Type Description
KmsWrappedCryptoKey.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public KmsWrappedCryptoKey.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public KmsWrappedCryptoKey.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final KmsWrappedCryptoKey.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KmsWrappedCryptoKey.Builder
Overrides

setWrappedKey(ByteString value)

public KmsWrappedCryptoKey.Builder setWrappedKey(ByteString value)

Required. The wrapped data crypto key.

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

Parameter
Name Description
value ByteString

The wrappedKey to set.

Returns
Type Description
KmsWrappedCryptoKey.Builder

This builder for chaining.