public static final class WorkstationConfig.CustomerEncryptionKey extends GeneratedMessageV3 implements WorkstationConfig.CustomerEncryptionKeyOrBuilderA 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.CustomerEncryptionKeyStatic Fields
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
KMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER
public static final int KMS_KEY_SERVICE_ACCOUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static WorkstationConfig.CustomerEncryptionKey getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static WorkstationConfig.CustomerEncryptionKey.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey.Builder | |
newBuilder(WorkstationConfig.CustomerEncryptionKey prototype)
public static WorkstationConfig.CustomerEncryptionKey.Builder newBuilder(WorkstationConfig.CustomerEncryptionKey prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | WorkstationConfig.CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey.Builder | |
parseDelimitedFrom(InputStream input)
public static WorkstationConfig.CustomerEncryptionKey parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig.CustomerEncryptionKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig.CustomerEncryptionKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<WorkstationConfig.CustomerEncryptionKey> parser()| Returns | |
|---|---|
| Type | Description |
Parser<CustomerEncryptionKey> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
public WorkstationConfig.CustomerEncryptionKey getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for kmsKeyServiceAccount. |
getParserForType()
public Parser<WorkstationConfig.CustomerEncryptionKey> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<CustomerEncryptionKey> | |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public WorkstationConfig.CustomerEncryptionKey.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WorkstationConfig.CustomerEncryptionKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public WorkstationConfig.CustomerEncryptionKey.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
WorkstationConfig.CustomerEncryptionKey.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |