public final class WorkstationConfig extends GeneratedMessageV3 implements WorkstationConfigOrBuilder
A set of configuration options describing how a workstation will be run.
Workstation configurations are intended to be shared across multiple
workstations.
Protobuf type google.cloud.workstations.v1.WorkstationConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONTAINER_FIELD_NUMBER
public static final int CONTAINER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEGRADED_FIELD_NUMBER
public static final int DEGRADED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENCRYPTION_KEY_FIELD_NUMBER
public static final int ENCRYPTION_KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IDLE_TIMEOUT_FIELD_NUMBER
public static final int IDLE_TIMEOUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PERSISTENT_DIRECTORIES_FIELD_NUMBER
public static final int PERSISTENT_DIRECTORIES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RUNNING_TIMEOUT_FIELD_NUMBER
public static final int RUNNING_TIMEOUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static WorkstationConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static WorkstationConfig.Builder newBuilder()
newBuilder(WorkstationConfig prototype)
public static WorkstationConfig.Builder newBuilder(WorkstationConfig prototype)
public static WorkstationConfig parseDelimitedFrom(InputStream input)
public static WorkstationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static WorkstationConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static WorkstationConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(CodedInputStream input)
public static WorkstationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(InputStream input)
public static WorkstationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static WorkstationConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WorkstationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<WorkstationConfig> parser()
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
Client-specified annotations.
map<string, string> annotations = 5;
| Parameter |
|---|
| Name | Description |
key | String
|
containsLabels(String key)
public boolean containsLabels(String key)
Client-specified labels that are applied to the resource and that are also
propagated to the underlying Compute Engine resources.
map<string, string> labels = 18;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
getAnnotationsCount()
public int getAnnotationsCount()
Client-specified annotations.
map<string, string> annotations = 5;
| Returns |
|---|
| Type | Description |
int | |
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
Client-specified annotations.
map<string, string> annotations = 5;
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
Client-specified annotations.
map<string, string> annotations = 5;
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
Client-specified annotations.
map<string, string> annotations = 5;
| Parameter |
|---|
| Name | Description |
key | String
|
getConditions(int index)
public Status getConditions(int index)
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
| Returns |
|---|
| Type | Description |
com.google.rpc.Status | |
getConditionsCount()
public int getConditionsCount()
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
getConditionsList()
public List<Status> getConditionsList()
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<com.google.rpc.Status> | |
getConditionsOrBuilder(int index)
public StatusOrBuilder getConditionsOrBuilder(int index)
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
| Returns |
|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
getConditionsOrBuilderList()
public List<? extends StatusOrBuilder> getConditionsOrBuilderList()
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<? extends com.google.rpc.StatusOrBuilder> | |
getContainer()
public WorkstationConfig.Container getContainer()
Container that will be run for each workstation using this configuration
when that workstation is started.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14;
getContainerOrBuilder()
public WorkstationConfig.ContainerOrBuilder getContainerOrBuilder()
Container that will be run for each workstation using this configuration
when that workstation is started.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14;
getCreateTime()
public Timestamp getCreateTime()
Output only. Time when this resource was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when this resource was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public WorkstationConfig getDefaultInstanceForType()
getDegraded()
public boolean getDegraded()
Output only. Whether this resource is degraded, in which case it may
require user action to restore full functionality. See also the
conditions field.
bool degraded = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | The degraded.
|
getDeleteTime()
public Timestamp getDeleteTime()
Output only. Time when this resource was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The deleteTime.
|
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. Time when this resource was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDisplayName()
public String getDisplayName()
Human-readable name for this resource.
string display_name = 2;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Human-readable name for this resource.
string display_name = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getEncryptionKey()
public WorkstationConfig.CustomerEncryptionKey getEncryptionKey()
Immutable. Encrypts resources of this workstation configuration using a
customer-managed encryption key.
If specified, the boot disk of the Compute Engine instance and the
persistent disk are encrypted using this encryption key. If
this field is not set, the disks are encrypted using a generated
key. Customer-managed encryption keys do not protect disk metadata.
If the customer-managed encryption key is rotated, when the workstation
instance is stopped, the system attempts to recreate the
persistent disk with the new version of the key. Be sure to keep
older versions of the key until the persistent disk is recreated.
Otherwise, data on the persistent disk will be lost.
If the encryption key is revoked, the workstation session will
automatically be stopped within 7 hours.
Immutable after the workstation configuration is created.
.google.cloud.workstations.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
getEncryptionKeyOrBuilder()
public WorkstationConfig.CustomerEncryptionKeyOrBuilder getEncryptionKeyOrBuilder()
Immutable. Encrypts resources of this workstation configuration using a
customer-managed encryption key.
If specified, the boot disk of the Compute Engine instance and the
persistent disk are encrypted using this encryption key. If
this field is not set, the disks are encrypted using a generated
key. Customer-managed encryption keys do not protect disk metadata.
If the customer-managed encryption key is rotated, when the workstation
instance is stopped, the system attempts to recreate the
persistent disk with the new version of the key. Be sure to keep
older versions of the key until the persistent disk is recreated.
Otherwise, data on the persistent disk will be lost.
If the encryption key is revoked, the workstation session will
automatically be stopped within 7 hours.
Immutable after the workstation configuration is created.
.google.cloud.workstations.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
getEtag()
Checksum computed by the server. May be sent on update and delete requests
to make sure that the client has an up-to-date value before proceeding.
string etag = 9;
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Checksum computed by the server. May be sent on update and delete requests
to make sure that the client has an up-to-date value before proceeding.
string etag = 9;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
getHost()
public WorkstationConfig.Host getHost()
Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12;
getHostOrBuilder()
public WorkstationConfig.HostOrBuilder getHostOrBuilder()
Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12;
getIdleTimeout()
public Duration getIdleTimeout()
How long to wait before automatically stopping an instance that hasn't
received any user traffic. A value of 0 indicates that this instance
should never time out due to idleness. Defaults to 20 minutes.
.google.protobuf.Duration idle_timeout = 10;
| Returns |
|---|
| Type | Description |
Duration | The idleTimeout.
|
getIdleTimeoutOrBuilder()
public DurationOrBuilder getIdleTimeoutOrBuilder()
How long to wait before automatically stopping an instance that hasn't
received any user traffic. A value of 0 indicates that this instance
should never time out due to idleness. Defaults to 20 minutes.
.google.protobuf.Duration idle_timeout = 10;
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Client-specified labels that are applied to the resource and that are also
propagated to the underlying Compute Engine resources.
map<string, string> labels = 18;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
Client-specified labels that are applied to the resource and that are also
propagated to the underlying Compute Engine resources.
map<string, string> labels = 18;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Client-specified labels that are applied to the resource and that are also
propagated to the underlying Compute Engine resources.
map<string, string> labels = 18;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Client-specified labels that are applied to the resource and that are also
propagated to the underlying Compute Engine resources.
map<string, string> labels = 18;
| Parameter |
|---|
| Name | Description |
key | String
|
getName()
Full name of this resource.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Full name of this resource.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<WorkstationConfig> getParserForType()
Overrides
getPersistentDirectories(int index)
public WorkstationConfig.PersistentDirectory getPersistentDirectories(int index)
Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13;
| Parameter |
|---|
| Name | Description |
index | int
|
getPersistentDirectoriesCount()
public int getPersistentDirectoriesCount()
Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13;
| Returns |
|---|
| Type | Description |
int | |
getPersistentDirectoriesList()
public List<WorkstationConfig.PersistentDirectory> getPersistentDirectoriesList()
Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13;
getPersistentDirectoriesOrBuilder(int index)
public WorkstationConfig.PersistentDirectoryOrBuilder getPersistentDirectoriesOrBuilder(int index)
Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13;
| Parameter |
|---|
| Name | Description |
index | int
|
getPersistentDirectoriesOrBuilderList()
public List<? extends WorkstationConfig.PersistentDirectoryOrBuilder> getPersistentDirectoriesOrBuilderList()
Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory persistent_directories = 13;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.workstations.v1.WorkstationConfig.PersistentDirectoryOrBuilder> | |
getReconciling()
public boolean getReconciling()
Output only. Indicates whether this resource is currently being updated to
match its intended state.
bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | The reconciling.
|
getRunningTimeout()
public Duration getRunningTimeout()
How long to wait before automatically stopping a workstation after it
started. A value of 0 indicates that workstations using this configuration
should never time out. Must be greater than 0 and less than 24 hours if
encryption_key is set. Defaults to 12 hours.
.google.protobuf.Duration running_timeout = 11;
| Returns |
|---|
| Type | Description |
Duration | The runningTimeout.
|
getRunningTimeoutOrBuilder()
public DurationOrBuilder getRunningTimeoutOrBuilder()
How long to wait before automatically stopping a workstation after it
started. A value of 0 indicates that workstations using this configuration
should never time out. Must be greater than 0 and less than 24 hours if
encryption_key is set. Defaults to 12 hours.
.google.protobuf.Duration running_timeout = 11;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUid()
Output only. A system-assigned unique identified for this resource.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. A system-assigned unique identified for this resource.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Time when this resource was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time when this resource was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasContainer()
public boolean hasContainer()
Container that will be run for each workstation using this configuration
when that workstation is started.
.google.cloud.workstations.v1.WorkstationConfig.Container container = 14;
| Returns |
|---|
| Type | Description |
boolean | Whether the container field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. Time when this resource was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasDeleteTime()
public boolean hasDeleteTime()
Output only. Time when this resource was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the deleteTime field is set.
|
hasEncryptionKey()
public boolean hasEncryptionKey()
Immutable. Encrypts resources of this workstation configuration using a
customer-managed encryption key.
If specified, the boot disk of the Compute Engine instance and the
persistent disk are encrypted using this encryption key. If
this field is not set, the disks are encrypted using a generated
key. Customer-managed encryption keys do not protect disk metadata.
If the customer-managed encryption key is rotated, when the workstation
instance is stopped, the system attempts to recreate the
persistent disk with the new version of the key. Be sure to keep
older versions of the key until the persistent disk is recreated.
Otherwise, data on the persistent disk will be lost.
If the encryption key is revoked, the workstation session will
automatically be stopped within 7 hours.
Immutable after the workstation configuration is created.
.google.cloud.workstations.v1.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
boolean | Whether the encryptionKey field is set.
|
hasHost()
Runtime host for the workstation.
.google.cloud.workstations.v1.WorkstationConfig.Host host = 12;
| Returns |
|---|
| Type | Description |
boolean | Whether the host field is set.
|
hasIdleTimeout()
public boolean hasIdleTimeout()
How long to wait before automatically stopping an instance that hasn't
received any user traffic. A value of 0 indicates that this instance
should never time out due to idleness. Defaults to 20 minutes.
.google.protobuf.Duration idle_timeout = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the idleTimeout field is set.
|
hasRunningTimeout()
public boolean hasRunningTimeout()
How long to wait before automatically stopping a workstation after it
started. A value of 0 indicates that workstations using this configuration
should never time out. Must be greater than 0 and less than 24 hours if
encryption_key is set. Defaults to 12 hours.
.google.protobuf.Duration running_timeout = 11;
| Returns |
|---|
| Type | Description |
boolean | Whether the runningTimeout field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Time when this resource was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public WorkstationConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WorkstationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public WorkstationConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
