Class Cluster.ControlPlaneEncryption.Builder (0.39.0)

public static final class Cluster.ControlPlaneEncryption.Builder extends GeneratedMessageV3.Builder<Cluster.ControlPlaneEncryption.Builder> implements Cluster.ControlPlaneEncryptionOrBuilder

Configuration for Customer-managed KMS key support for remote control plane cluster disk encryption.

Protobuf type google.cloud.edgecontainer.v1.Cluster.ControlPlaneEncryption

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Cluster.ControlPlaneEncryption build()
Returns
Type Description
Cluster.ControlPlaneEncryption

buildPartial()

public Cluster.ControlPlaneEncryption buildPartial()
Returns
Type Description
Cluster.ControlPlaneEncryption

clear()

public Cluster.ControlPlaneEncryption.Builder clear()
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearKmsKey()

public Cluster.ControlPlaneEncryption.Builder clearKmsKey()

Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.

string kms_key = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

clearKmsKeyActiveVersion()

public Cluster.ControlPlaneEncryption.Builder clearKmsKeyActiveVersion()

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set.

string kms_key_active_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

clearKmsKeyState()

public Cluster.ControlPlaneEncryption.Builder clearKmsKeyState()

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.

.google.cloud.edgecontainer.v1.KmsKeyState kms_key_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

clearKmsStatus()

public Cluster.ControlPlaneEncryption.Builder clearKmsStatus()

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public Cluster.ControlPlaneEncryption.Builder clone()
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder
Overrides

getDefaultInstanceForType()

public Cluster.ControlPlaneEncryption getDefaultInstanceForType()
Returns
Type Description
Cluster.ControlPlaneEncryption

getDescriptorForType()

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

getKmsKey()

public String getKmsKey()

Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.

string kms_key = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyActiveVersion()

public String getKmsKeyActiveVersion()

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set.

string kms_key_active_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKeyActiveVersion.

getKmsKeyActiveVersionBytes()

public ByteString getKmsKeyActiveVersionBytes()

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set.

string kms_key_active_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKeyActiveVersion.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.

string kms_key = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getKmsKeyState()

public KmsKeyState getKmsKeyState()

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.

.google.cloud.edgecontainer.v1.KmsKeyState kms_key_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
KmsKeyState

The kmsKeyState.

getKmsKeyStateValue()

public int getKmsKeyStateValue()

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.

.google.cloud.edgecontainer.v1.KmsKeyState kms_key_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for kmsKeyState.

getKmsStatus()

public Status getKmsStatus()

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The kmsStatus.

getKmsStatusBuilder()

public Status.Builder getKmsStatusBuilder()

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status.Builder

getKmsStatusOrBuilder()

public StatusOrBuilder getKmsStatusOrBuilder()

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

hasKmsStatus()

public boolean hasKmsStatus()

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the kmsStatus field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Cluster.ControlPlaneEncryption other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeKmsStatus(Status value)

public Cluster.ControlPlaneEncryption.Builder mergeKmsStatus(Status value)

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setKmsKey(String value)

public Cluster.ControlPlaneEncryption.Builder setKmsKey(String value)

Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.

string kms_key = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKey to set.

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

setKmsKeyActiveVersion(String value)

public Cluster.ControlPlaneEncryption.Builder setKmsKeyActiveVersion(String value)

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set.

string kms_key_active_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKeyActiveVersion to set.

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

setKmsKeyActiveVersionBytes(ByteString value)

public Cluster.ControlPlaneEncryption.Builder setKmsKeyActiveVersionBytes(ByteString value)

Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set.

string kms_key_active_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKeyActiveVersion to set.

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public Cluster.ControlPlaneEncryption.Builder setKmsKeyBytes(ByteString value)

Immutable. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead.

string kms_key = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

setKmsKeyState(KmsKeyState value)

public Cluster.ControlPlaneEncryption.Builder setKmsKeyState(KmsKeyState value)

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.

.google.cloud.edgecontainer.v1.KmsKeyState kms_key_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value KmsKeyState

The kmsKeyState to set.

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

setKmsKeyStateValue(int value)

public Cluster.ControlPlaneEncryption.Builder setKmsKeyStateValue(int value)

Output only. Availability of the Cloud KMS CryptoKey. If not KEY_AVAILABLE, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted.

.google.cloud.edgecontainer.v1.KmsKeyState kms_key_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for kmsKeyState to set.

Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

This builder for chaining.

setKmsStatus(Status value)

public Cluster.ControlPlaneEncryption.Builder setKmsStatus(Status value)

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

setKmsStatus(Status.Builder builderForValue)

public Cluster.ControlPlaneEncryption.Builder setKmsStatus(Status.Builder builderForValue)

Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if kms_key_state is not KMS_KEY_STATE_KEY_AVAILABLE. If populated, this field contains the error status reported by Cloud KMS.

.google.rpc.Status kms_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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