Class WorkstationConfig.CustomerEncryptionKey (0.24.0)

public static final class WorkstationConfig.CustomerEncryptionKey extends GeneratedMessageV3 implements WorkstationConfig.CustomerEncryptionKeyOrBuilder

A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices.

Protobuf type google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > WorkstationConfig.CustomerEncryptionKey

Static Fields

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int KMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static WorkstationConfig.CustomerEncryptionKey getDefaultInstance()
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey

getDescriptor()

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

newBuilder()

public static WorkstationConfig.CustomerEncryptionKey.Builder newBuilder()
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey.Builder

newBuilder(WorkstationConfig.CustomerEncryptionKey prototype)

public static WorkstationConfig.CustomerEncryptionKey.Builder newBuilder(WorkstationConfig.CustomerEncryptionKey prototype)
Parameter
NameDescription
prototypeWorkstationConfig.CustomerEncryptionKey
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey.Builder

parseDelimitedFrom(InputStream input)

public static WorkstationConfig.CustomerEncryptionKey parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static WorkstationConfig.CustomerEncryptionKey parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static WorkstationConfig.CustomerEncryptionKey parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static WorkstationConfig.CustomerEncryptionKey parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static WorkstationConfig.CustomerEncryptionKey parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<WorkstationConfig.CustomerEncryptionKey> parser()
Returns
TypeDescription
Parser<CustomerEncryptionKey>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public WorkstationConfig.CustomerEncryptionKey getDefaultInstanceForType()
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey

getKmsKey()

public String getKmsKey()

Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.

string kms_key = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.

string kms_key = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for kmsKey.

getKmsKeyServiceAccount()

public String getKmsKeyServiceAccount()

Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

string kms_key_service_account = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The kmsKeyServiceAccount.

getKmsKeyServiceAccountBytes()

public ByteString getKmsKeyServiceAccountBytes()

Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

string kms_key_service_account = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for kmsKeyServiceAccount.

getParserForType()

public Parser<WorkstationConfig.CustomerEncryptionKey> getParserForType()
Returns
TypeDescription
Parser<CustomerEncryptionKey>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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 WorkstationConfig.CustomerEncryptionKey.Builder newBuilderForType()
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WorkstationConfig.CustomerEncryptionKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public WorkstationConfig.CustomerEncryptionKey.Builder toBuilder()
Returns
TypeDescription
WorkstationConfig.CustomerEncryptionKey.Builder

writeTo(CodedOutputStream output)

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