Class CustomerEncryptionKey.Builder (2.44.0)

public static final class CustomerEncryptionKey.Builder extends GeneratedMessageV3.Builder<CustomerEncryptionKey.Builder> implements CustomerEncryptionKeyOrBuilder

Customer's encryption key.

Protobuf type google.cloud.tpu.v2alpha1.CustomerEncryptionKey

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CustomerEncryptionKey build()
Returns
Type Description
CustomerEncryptionKey

buildPartial()

public CustomerEncryptionKey buildPartial()
Returns
Type Description
CustomerEncryptionKey

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearKey()

public CustomerEncryptionKey.Builder clearKey()
Returns
Type Description
CustomerEncryptionKey.Builder

clearKmsKeyName()

public CustomerEncryptionKey.Builder clearKmsKeyName()

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Returns
Type Description
CustomerEncryptionKey.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public CustomerEncryptionKey getDefaultInstanceForType()
Returns
Type Description
CustomerEncryptionKey

getDescriptorForType()

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

getKeyCase()

public CustomerEncryptionKey.KeyCase getKeyCase()
Returns
Type Description
CustomerEncryptionKey.KeyCase

getKmsKeyName()

public String getKmsKeyName()

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Returns
Type Description
ByteString

The bytes for kmsKeyName.

hasKmsKeyName()

public boolean hasKmsKeyName()

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Returns
Type Description
boolean

Whether the kmsKeyName field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CustomerEncryptionKey other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setKmsKeyName(String value)

public CustomerEncryptionKey.Builder setKmsKeyName(String value)

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Parameter
Name Description
value String

The kmsKeyName to set.
Returns
Type Description
CustomerEncryptionKey.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public CustomerEncryptionKey.Builder setKmsKeyNameBytes(ByteString value)

The name of the encryption key that is stored in Google Cloud KMS. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> </pre> The fully-qualifed key name may be returned for resource GET requests. For example: <pre class="lang-html">"kmsKeyName": "projects/ <var class="apiparam">kms_project_id</var>/locations/ <var class="apiparam">region</var>/keyRings/<var class="apiparam"> key_region</var>/cryptoKeys/<var class="apiparam">key</var> /cryptoKeyVersions/1</pre>

string kms_key_name = 7;

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.
Returns
Type Description
CustomerEncryptionKey.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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