Class KmsWrappedCryptoKey.Builder (3.59.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > KmsWrappedCryptoKey.Builder

Implements

KmsWrappedCryptoKeyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public KmsWrappedCryptoKey.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`KmsWrappedCryptoKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public KmsWrappedCryptoKey.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`KmsWrappedCryptoKey.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KmsWrappedCryptoKey.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`KmsWrappedCryptoKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final KmsWrappedCryptoKey.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`KmsWrappedCryptoKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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.