Class Cluster.EncryptionConfig.Builder (2.17.1)

public static final class Cluster.EncryptionConfig.Builder extends GeneratedMessageV3.Builder<Cluster.EncryptionConfig.Builder> implements Cluster.EncryptionConfigOrBuilder

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

Protobuf type google.bigtable.admin.v2.Cluster.EncryptionConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Cluster.EncryptionConfig build()
Returns
TypeDescription
Cluster.EncryptionConfig

buildPartial()

public Cluster.EncryptionConfig buildPartial()
Returns
TypeDescription
Cluster.EncryptionConfig

clear()

public Cluster.EncryptionConfig.Builder clear()
Returns
TypeDescription
Cluster.EncryptionConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearKmsKeyName()

public Cluster.EncryptionConfig.Builder clearKmsKeyName()

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

string kms_key_name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
Cluster.EncryptionConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public Cluster.EncryptionConfig.Builder clone()
Returns
TypeDescription
Cluster.EncryptionConfig.Builder
Overrides

getDefaultInstanceForType()

public Cluster.EncryptionConfig getDefaultInstanceForType()
Returns
TypeDescription
Cluster.EncryptionConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getKmsKeyName()

public String getKmsKeyName()

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

string kms_key_name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

string kms_key_name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for kmsKeyName.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Cluster.EncryptionConfig other)

public Cluster.EncryptionConfig.Builder mergeFrom(Cluster.EncryptionConfig other)
Parameter
NameDescription
otherCluster.EncryptionConfig
Returns
TypeDescription
Cluster.EncryptionConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.EncryptionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Cluster.EncryptionConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setKmsKeyName(String value)

public Cluster.EncryptionConfig.Builder setKmsKeyName(String value)

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

string kms_key_name = 1 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The kmsKeyName to set.

Returns
TypeDescription
Cluster.EncryptionConfig.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public Cluster.EncryptionConfig.Builder setKmsKeyNameBytes(ByteString value)

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}

string kms_key_name = 1 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for kmsKeyName to set.

Returns
TypeDescription
Cluster.EncryptionConfig.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.EncryptionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Cluster.EncryptionConfig.Builder
Overrides