Class KmsWrappedCryptoKey.Builder

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KmsWrappedCryptoKey.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KmsWrappedCryptoKey.Builder
Overrides

build()

public KmsWrappedCryptoKey build()
Returns
TypeDescription
KmsWrappedCryptoKey

buildPartial()

public KmsWrappedCryptoKey buildPartial()
Returns
TypeDescription
KmsWrappedCryptoKey

clear()

public KmsWrappedCryptoKey.Builder clear()
Returns
TypeDescription
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
TypeDescription
KmsWrappedCryptoKey.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public KmsWrappedCryptoKey.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
KmsWrappedCryptoKey.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public KmsWrappedCryptoKey.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
KmsWrappedCryptoKey.Builder
Overrides

clearWrappedKey()

public KmsWrappedCryptoKey.Builder clearWrappedKey()

Required. The wrapped data crypto key.

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

Returns
TypeDescription
KmsWrappedCryptoKey.Builder

This builder for chaining.

clone()

public KmsWrappedCryptoKey.Builder clone()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for cryptoKeyName.

getDefaultInstanceForType()

public KmsWrappedCryptoKey getDefaultInstanceForType()
Returns
TypeDescription
KmsWrappedCryptoKey

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getWrappedKey()

public ByteString getWrappedKey()

Required. The wrapped data crypto key.

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

Returns
TypeDescription
ByteString

The wrappedKey.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(KmsWrappedCryptoKey other)

public KmsWrappedCryptoKey.Builder mergeFrom(KmsWrappedCryptoKey other)
Parameter
NameDescription
otherKmsWrappedCryptoKey
Returns
TypeDescription
KmsWrappedCryptoKey.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KmsWrappedCryptoKey.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KmsWrappedCryptoKey.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public KmsWrappedCryptoKey.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
KmsWrappedCryptoKey.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KmsWrappedCryptoKey.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The cryptoKeyName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for cryptoKeyName to set.

Returns
TypeDescription
KmsWrappedCryptoKey.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public KmsWrappedCryptoKey.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KmsWrappedCryptoKey.Builder
Overrides

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

public KmsWrappedCryptoKey.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
KmsWrappedCryptoKey.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final KmsWrappedCryptoKey.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueByteString

The wrappedKey to set.

Returns
TypeDescription
KmsWrappedCryptoKey.Builder

This builder for chaining.