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
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Cluster.EncryptionConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public Cluster.EncryptionConfig build()
Returns
buildPartial()
public Cluster.EncryptionConfig buildPartial()
Returns
clear()
public Cluster.EncryptionConfig.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public Cluster.EncryptionConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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
clearOneof(Descriptors.OneofDescriptor oneof)
public Cluster.EncryptionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public Cluster.EncryptionConfig.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public Cluster.EncryptionConfig getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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
Type | Description |
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
Type | Description |
ByteString | The bytes for kmsKeyName.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Cluster.EncryptionConfig other)
public Cluster.EncryptionConfig.Builder mergeFrom(Cluster.EncryptionConfig other)
Parameter
Returns
public Cluster.EncryptionConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Cluster.EncryptionConfig.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Cluster.EncryptionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public Cluster.EncryptionConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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
Name | Description |
value | String
The kmsKeyName to set.
|
Returns
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
Name | Description |
value | ByteString
The bytes for kmsKeyName to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Cluster.EncryptionConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Cluster.EncryptionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides