Class Cluster.ControlPlaneEncryption (0.52.0)

public static final class Cluster.ControlPlaneEncryption extends GeneratedMessageV3 implements Cluster.ControlPlaneEncryptionOrBuilder

Configuration for Customer-managed KMS key support for control plane nodes.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Cluster.ControlPlaneEncryption

Static Fields

KMS_KEY_ACTIVE_VERSION_FIELD_NUMBER

public static final int KMS_KEY_ACTIVE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_STATE_FIELD_NUMBER

public static final int KMS_KEY_STATE_FIELD_NUMBER
Field Value
Type Description
int

KMS_STATUS_FIELD_NUMBER

public static final int KMS_STATUS_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_STATE_FIELD_NUMBER

public static final int RESOURCE_STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Cluster.ControlPlaneEncryption getDefaultInstance()
Returns
Type Description
Cluster.ControlPlaneEncryption

getDescriptor()

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

newBuilder()

public static Cluster.ControlPlaneEncryption.Builder newBuilder()
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

newBuilder(Cluster.ControlPlaneEncryption prototype)

public static Cluster.ControlPlaneEncryption.Builder newBuilder(Cluster.ControlPlaneEncryption prototype)
Parameter
Name Description
prototype Cluster.ControlPlaneEncryption
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

parseDelimitedFrom(InputStream input)

public static Cluster.ControlPlaneEncryption parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Cluster.ControlPlaneEncryption parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cluster.ControlPlaneEncryption parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cluster.ControlPlaneEncryption parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Cluster.ControlPlaneEncryption parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Cluster.ControlPlaneEncryption parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.ControlPlaneEncryption
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Cluster.ControlPlaneEncryption> parser()
Returns
Type Description
Parser<ControlPlaneEncryption>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

getKmsKey()

public String getKmsKey()

Optional. 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) = OPTIONAL, (.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()

Optional. 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) = OPTIONAL, (.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.

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

getParserForType()

public Parser<Cluster.ControlPlaneEncryption> getParserForType()
Returns
Type Description
Parser<ControlPlaneEncryption>
Overrides

getResourceState()

public ResourceState getResourceState()

Output only. The current resource state associated with the cmek.

.google.cloud.edgecontainer.v1.ResourceState resource_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ResourceState

The resourceState.

getResourceStateValue()

public int getResourceStateValue()

Output only. The current resource state associated with the cmek.

.google.cloud.edgecontainer.v1.ResourceState resource_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for resourceState.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Cluster.ControlPlaneEncryption.Builder newBuilderForType()
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cluster.ControlPlaneEncryption.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Cluster.ControlPlaneEncryption.Builder toBuilder()
Returns
Type Description
Cluster.ControlPlaneEncryption.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException