Class WorkstationConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.workstations.v1beta.WorkstationConfig
- All Implemented Interfaces:
WorkstationConfigOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class WorkstationConfig
extends com.google.protobuf.GeneratedMessage
implements WorkstationConfigOrBuilder
A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.Protobuf type
google.cloud.workstations.v1beta.WorkstationConfig- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA workstation configuration resource in the Cloud Workstations API.static final classA Docker container.static interfacestatic final classA customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration.static interfacestatic final classAn ephemeral directory which won't persist across workstation sessions.static interfacestatic final classRuntime host for a workstation.static interfacestatic final classA directory to persist across workstation sessions.static interfacestatic final classA readiness check to be performed on a workstation.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanOptional.booleancontainsLabels(String key) Optional.booleanDeprecated.intOptional.Optional.getAnnotationsOrDefault(String key, String defaultValue) Optional.Optional.getConditions(int index) Output only.intOutput only.Output only.getConditionsOrBuilder(int index) Output only.List<? extends StatusOrBuilder>Output only.Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static WorkstationConfigbooleanOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static final com.google.protobuf.Descriptors.DescriptorOptional.com.google.protobuf.ByteStringOptional.booleanOptional.Immutable.Immutable.getEphemeralDirectories(int index) Optional.intOptional.Optional.getEphemeralDirectoriesOrBuilder(int index) Optional.Optional.getEtag()Optional.com.google.protobuf.ByteStringOptional.getHost()Optional.Optional.com.google.protobuf.DurationOptional.com.google.protobuf.DurationOrBuilderOptional.Deprecated.intOptional.Optional.getLabelsOrDefault(String key, String defaultValue) Optional.getLabelsOrThrow(String key) Optional.getName()Full name of this workstation configuration.com.google.protobuf.ByteStringFull name of this workstation configuration.com.google.protobuf.Parser<WorkstationConfig>getPersistentDirectories(int index) Optional.intOptional.Optional.getPersistentDirectoriesOrBuilder(int index) Optional.Optional.getReadinessChecks(int index) Optional.intOptional.Optional.getReadinessChecksOrBuilder(int index) Optional.List<? extends WorkstationConfig.ReadinessCheckOrBuilder>Optional.booleanOutput only.getReplicaZones(int index) Optional.com.google.protobuf.ByteStringgetReplicaZonesBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.com.google.protobuf.DurationOptional.com.google.protobuf.DurationOrBuilderOptional.intgetUid()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOptional.booleanOutput only.booleanOutput only.booleanImmutable.inthashCode()booleanhasHost()Optional.booleanOptional.booleanOptional.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic WorkstationConfig.Builderstatic WorkstationConfig.BuildernewBuilder(WorkstationConfig prototype) protected WorkstationConfig.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static WorkstationConfigparseDelimitedFrom(InputStream input) static WorkstationConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkstationConfigparseFrom(byte[] data) static WorkstationConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkstationConfigparseFrom(com.google.protobuf.ByteString data) static WorkstationConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkstationConfigparseFrom(com.google.protobuf.CodedInputStream input) static WorkstationConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkstationConfigparseFrom(InputStream input) static WorkstationConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkstationConfigparseFrom(ByteBuffer data) static WorkstationConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<WorkstationConfig>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER- See Also:
-
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER- See Also:
-
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER- See Also:
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER- See Also:
-
IDLE_TIMEOUT_FIELD_NUMBER
public static final int IDLE_TIMEOUT_FIELD_NUMBER- See Also:
-
RUNNING_TIMEOUT_FIELD_NUMBER
public static final int RUNNING_TIMEOUT_FIELD_NUMBER- See Also:
-
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER- See Also:
-
PERSISTENT_DIRECTORIES_FIELD_NUMBER
public static final int PERSISTENT_DIRECTORIES_FIELD_NUMBER- See Also:
-
EPHEMERAL_DIRECTORIES_FIELD_NUMBER
public static final int EPHEMERAL_DIRECTORIES_FIELD_NUMBER- See Also:
-
CONTAINER_FIELD_NUMBER
public static final int CONTAINER_FIELD_NUMBER- See Also:
-
ENCRYPTION_KEY_FIELD_NUMBER
public static final int ENCRYPTION_KEY_FIELD_NUMBER- See Also:
-
READINESS_CHECKS_FIELD_NUMBER
public static final int READINESS_CHECKS_FIELD_NUMBER- See Also:
-
REPLICA_ZONES_FIELD_NUMBER
public static final int REPLICA_ZONES_FIELD_NUMBER- See Also:
-
DEGRADED_FIELD_NUMBER
public static final int DEGRADED_FIELD_NUMBER- See Also:
-
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER- See Also:
-
ENABLE_AUDIT_AGENT_FIELD_NUMBER
public static final int ENABLE_AUDIT_AGENT_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
Full name of this workstation configuration.
string name = 1;- Specified by:
getNamein interfaceWorkstationConfigOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Full name of this workstation configuration.
string name = 1;- Specified by:
getNameBytesin interfaceWorkstationConfigOrBuilder- Returns:
- The bytes for name.
-
getDisplayName
Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDisplayNamein interfaceWorkstationConfigOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDisplayNameBytesin interfaceWorkstationConfigOrBuilder- Returns:
- The bytes for displayName.
-
getUid
Output only. A system-assigned unique identifier for this workstation configuration.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUidin interfaceWorkstationConfigOrBuilder- Returns:
- The uid.
-
getUidBytes
public com.google.protobuf.ByteString getUidBytes()Output only. A system-assigned unique identifier for this workstation configuration.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUidBytesin interfaceWorkstationConfigOrBuilder- Returns:
- The bytes for uid.
-
getReconciling
public boolean getReconciling()Output only. Indicates whether this workstation configuration is currently being updated to match its intended state.
bool reconciling = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getReconcilingin interfaceWorkstationConfigOrBuilder- Returns:
- The reconciling.
-
getAnnotationsCount
public int getAnnotationsCount()Description copied from interface:WorkstationConfigOrBuilderOptional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAnnotationsCountin interfaceWorkstationConfigOrBuilder
-
containsAnnotations
Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
containsAnnotationsin interfaceWorkstationConfigOrBuilder
-
getAnnotations
Deprecated.UsegetAnnotationsMap()instead.- Specified by:
getAnnotationsin interfaceWorkstationConfigOrBuilder
-
getAnnotationsMap
Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAnnotationsMapin interfaceWorkstationConfigOrBuilder
-
getAnnotationsOrDefault
Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAnnotationsOrDefaultin interfaceWorkstationConfigOrBuilder
-
getAnnotationsOrThrow
Optional. Client-specified annotations.
map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAnnotationsOrThrowin interfaceWorkstationConfigOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:WorkstationConfigOrBuilderOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsCountin interfaceWorkstationConfigOrBuilder
-
containsLabels
Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
containsLabelsin interfaceWorkstationConfigOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceWorkstationConfigOrBuilder
-
getLabelsMap
Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsMapin interfaceWorkstationConfigOrBuilder
-
getLabelsOrDefault
Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsOrDefaultin interfaceWorkstationConfigOrBuilder
-
getLabelsOrThrow
Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsOrThrowin interfaceWorkstationConfigOrBuilder
-
hasCreateTime
public boolean hasCreateTime()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceWorkstationConfigOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceWorkstationConfigOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when this workstation configuration was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceWorkstationConfigOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceWorkstationConfigOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceWorkstationConfigOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Time when this workstation configuration was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceWorkstationConfigOrBuilder
-
hasDeleteTime
public boolean hasDeleteTime()Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasDeleteTimein interfaceWorkstationConfigOrBuilder- Returns:
- Whether the deleteTime field is set.
-
getDeleteTime
public com.google.protobuf.Timestamp getDeleteTime()Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeleteTimein interfaceWorkstationConfigOrBuilder- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()Output only. Time when this workstation configuration was soft-deleted.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeleteTimeOrBuilderin interfaceWorkstationConfigOrBuilder
-
getEtag
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEtagin interfaceWorkstationConfigOrBuilder- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.ByteString getEtagBytes()Optional. 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 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEtagBytesin interfaceWorkstationConfigOrBuilder- Returns:
- The bytes for etag.
-
hasIdleTimeout
public boolean hasIdleTimeout()Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
.google.protobuf.Duration idle_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasIdleTimeoutin interfaceWorkstationConfigOrBuilder- Returns:
- Whether the idleTimeout field is set.
-
getIdleTimeout
public com.google.protobuf.Duration getIdleTimeout()Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
.google.protobuf.Duration idle_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getIdleTimeoutin interfaceWorkstationConfigOrBuilder- Returns:
- The idleTimeout.
-
getIdleTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
.google.protobuf.Duration idle_timeout = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getIdleTimeoutOrBuilderin interfaceWorkstationConfigOrBuilder
-
hasRunningTimeout
public boolean hasRunningTimeout()Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The [idle_timeout][google.cloud.workstations.v1beta.WorkstationConfig.idle_timeout] and [running_timeout][google.cloud.workstations.v1beta.WorkstationConfig.running_timeout] fields are independent of each other. Note that the [running_timeout][google.cloud.workstations.v1beta.WorkstationConfig.running_timeout] field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If [encryption_key][google.cloud.workstations.v1beta.WorkstationConfig.encryption_key] is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
.google.protobuf.Duration running_timeout = 11 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasRunningTimeoutin interfaceWorkstationConfigOrBuilder- Returns:
- Whether the runningTimeout field is set.
-
getRunningTimeout
public com.google.protobuf.Duration getRunningTimeout()Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The [idle_timeout][google.cloud.workstations.v1beta.WorkstationConfig.idle_timeout] and [running_timeout][google.cloud.workstations.v1beta.WorkstationConfig.running_timeout] fields are independent of each other. Note that the [running_timeout][google.cloud.workstations.v1beta.WorkstationConfig.running_timeout] field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If [encryption_key][google.cloud.workstations.v1beta.WorkstationConfig.encryption_key] is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
.google.protobuf.Duration running_timeout = 11 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getRunningTimeoutin interfaceWorkstationConfigOrBuilder- Returns:
- The runningTimeout.
-
getRunningTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getRunningTimeoutOrBuilder()Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The [idle_timeout][google.cloud.workstations.v1beta.WorkstationConfig.idle_timeout] and [running_timeout][google.cloud.workstations.v1beta.WorkstationConfig.running_timeout] fields are independent of each other. Note that the [running_timeout][google.cloud.workstations.v1beta.WorkstationConfig.running_timeout] field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If [encryption_key][google.cloud.workstations.v1beta.WorkstationConfig.encryption_key] is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
.google.protobuf.Duration running_timeout = 11 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getRunningTimeoutOrBuilderin interfaceWorkstationConfigOrBuilder
-
hasHost
public boolean hasHost()Optional. Runtime host for the workstation.
.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasHostin interfaceWorkstationConfigOrBuilder- Returns:
- Whether the host field is set.
-
getHost
Optional. Runtime host for the workstation.
.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHostin interfaceWorkstationConfigOrBuilder- Returns:
- The host.
-
getHostOrBuilder
Optional. Runtime host for the workstation.
.google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHostOrBuilderin interfaceWorkstationConfigOrBuilder
-
getPersistentDirectoriesList
Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPersistentDirectoriesListin interfaceWorkstationConfigOrBuilder
-
getPersistentDirectoriesOrBuilderList
public List<? extends WorkstationConfig.PersistentDirectoryOrBuilder> getPersistentDirectoriesOrBuilderList()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPersistentDirectoriesOrBuilderListin interfaceWorkstationConfigOrBuilder
-
getPersistentDirectoriesCount
public int getPersistentDirectoriesCount()Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPersistentDirectoriesCountin interfaceWorkstationConfigOrBuilder
-
getPersistentDirectories
Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPersistentDirectoriesin interfaceWorkstationConfigOrBuilder
-
getPersistentDirectoriesOrBuilder
Optional. Directories to persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPersistentDirectoriesOrBuilderin interfaceWorkstationConfigOrBuilder
-
getEphemeralDirectoriesList
Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEphemeralDirectoriesListin interfaceWorkstationConfigOrBuilder
-
getEphemeralDirectoriesOrBuilderList
public List<? extends WorkstationConfig.EphemeralDirectoryOrBuilder> getEphemeralDirectoriesOrBuilderList()Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEphemeralDirectoriesOrBuilderListin interfaceWorkstationConfigOrBuilder
-
getEphemeralDirectoriesCount
public int getEphemeralDirectoriesCount()Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEphemeralDirectoriesCountin interfaceWorkstationConfigOrBuilder
-
getEphemeralDirectories
Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEphemeralDirectoriesin interfaceWorkstationConfigOrBuilder
-
getEphemeralDirectoriesOrBuilder
Optional. Ephemeral directories which won't persist across workstation sessions.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.EphemeralDirectory ephemeral_directories = 22 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEphemeralDirectoriesOrBuilderin interfaceWorkstationConfigOrBuilder
-
hasContainer
public boolean hasContainer()Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasContainerin interfaceWorkstationConfigOrBuilder- Returns:
- Whether the container field is set.
-
getContainer
Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getContainerin interfaceWorkstationConfigOrBuilder- Returns:
- The container.
-
getContainerOrBuilder
Optional. Container that runs upon startup for each workstation using this workstation configuration.
.google.cloud.workstations.v1beta.WorkstationConfig.Container container = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getContainerOrBuilderin interfaceWorkstationConfigOrBuilder
-
hasEncryptionKey
public boolean hasEncryptionKey()Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). 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 might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
hasEncryptionKeyin interfaceWorkstationConfigOrBuilder- Returns:
- Whether the encryptionKey field is set.
-
getEncryptionKey
Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). 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 might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getEncryptionKeyin interfaceWorkstationConfigOrBuilder- Returns:
- The encryptionKey.
-
getEncryptionKeyOrBuilder
Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). 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 might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
.google.cloud.workstations.v1beta.WorkstationConfig.CustomerEncryptionKey encryption_key = 17 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getEncryptionKeyOrBuilderin interfaceWorkstationConfigOrBuilder
-
getReadinessChecksList
Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getReadinessChecksListin interfaceWorkstationConfigOrBuilder
-
getReadinessChecksOrBuilderList
Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getReadinessChecksOrBuilderListin interfaceWorkstationConfigOrBuilder
-
getReadinessChecksCount
public int getReadinessChecksCount()Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getReadinessChecksCountin interfaceWorkstationConfigOrBuilder
-
getReadinessChecks
Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getReadinessChecksin interfaceWorkstationConfigOrBuilder
-
getReadinessChecksOrBuilder
Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
repeated .google.cloud.workstations.v1beta.WorkstationConfig.ReadinessCheck readiness_checks = 19 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getReadinessChecksOrBuilderin interfaceWorkstationConfigOrBuilder
-
getReplicaZonesList
public com.google.protobuf.ProtocolStringList getReplicaZonesList()Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];- Specified by:
getReplicaZonesListin interfaceWorkstationConfigOrBuilder- Returns:
- A list containing the replicaZones.
-
getReplicaZonesCount
public int getReplicaZonesCount()Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];- Specified by:
getReplicaZonesCountin interfaceWorkstationConfigOrBuilder- Returns:
- The count of replicaZones.
-
getReplicaZones
Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];- Specified by:
getReplicaZonesin interfaceWorkstationConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The replicaZones at the given index.
-
getReplicaZonesBytes
public com.google.protobuf.ByteString getReplicaZonesBytes(int index) Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];- Specified by:
getReplicaZonesBytesin interfaceWorkstationConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the replicaZones at the given index.
-
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][google.cloud.workstations.v1beta.WorkstationConfig.conditions] field.
bool degraded = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDegradedin interfaceWorkstationConfigOrBuilder- Returns:
- The degraded.
-
getConditionsList
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getConditionsListin interfaceWorkstationConfigOrBuilder
-
getConditionsOrBuilderList
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getConditionsOrBuilderListin interfaceWorkstationConfigOrBuilder
-
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];- Specified by:
getConditionsCountin interfaceWorkstationConfigOrBuilder
-
getConditions
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getConditionsin interfaceWorkstationConfigOrBuilder
-
getConditionsOrBuilder
Output only. Status conditions describing the current resource state.
repeated .google.rpc.Status conditions = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getConditionsOrBuilderin interfaceWorkstationConfigOrBuilder
-
getEnableAuditAgent
public boolean getEnableAuditAgent()Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).
bool enable_audit_agent = 20 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEnableAuditAgentin interfaceWorkstationConfigOrBuilder- Returns:
- The enableAuditAgent.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static WorkstationConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkstationConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkstationConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkstationConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkstationConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkstationConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static WorkstationConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static WorkstationConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static WorkstationConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static WorkstationConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected WorkstationConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-