Class Cluster.ControlPlaneEncryption (0.38.0)

public static final class Cluster.ControlPlaneEncryption extends GeneratedMessageV3 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

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
TypeDescription
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_STATE_FIELD_NUMBER

public static final int KMS_KEY_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_STATUS_FIELD_NUMBER

public static final int KMS_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Cluster.ControlPlaneEncryption getDefaultInstance()
Returns
TypeDescription
Cluster.ControlPlaneEncryption

getDescriptor()

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

newBuilder()

public static Cluster.ControlPlaneEncryption.Builder newBuilder()
Returns
TypeDescription
Cluster.ControlPlaneEncryption.Builder

newBuilder(Cluster.ControlPlaneEncryption prototype)

public static Cluster.ControlPlaneEncryption.Builder newBuilder(Cluster.ControlPlaneEncryption prototype)
Parameter
NameDescription
prototypeCluster.ControlPlaneEncryption
Returns
TypeDescription
Cluster.ControlPlaneEncryption.Builder

parseDelimitedFrom(InputStream input)

public static Cluster.ControlPlaneEncryption parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Cluster.ControlPlaneEncryption parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cluster.ControlPlaneEncryption parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cluster.ControlPlaneEncryption parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Cluster.ControlPlaneEncryption parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Cluster.ControlPlaneEncryption parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cluster.ControlPlaneEncryption parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster.ControlPlaneEncryption
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

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

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
com.google.rpc.StatusOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the kmsStatus field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Cluster.ControlPlaneEncryption.Builder newBuilderForType()
Returns
TypeDescription
Cluster.ControlPlaneEncryption.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cluster.ControlPlaneEncryption.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Cluster.ControlPlaneEncryption.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Cluster.ControlPlaneEncryption.Builder toBuilder()
Returns
TypeDescription
Cluster.ControlPlaneEncryption.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException