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:
  • 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:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

      public String getName()
       Full name of this workstation configuration.
       
      string name = 1;
      Specified by:
      getName in interface WorkstationConfigOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Full name of this workstation configuration.
       
      string name = 1;
      Specified by:
      getNameBytes in interface WorkstationConfigOrBuilder
      Returns:
      The bytes for name.
    • getDisplayName

      public String getDisplayName()
       Optional. Human-readable name for this workstation configuration.
       
      string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisplayName in interface WorkstationConfigOrBuilder
      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:
      getDisplayNameBytes in interface WorkstationConfigOrBuilder
      Returns:
      The bytes for displayName.
    • getUid

      public String getUid()
       Output only. A system-assigned unique identifier for this workstation
       configuration.
       
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUid in interface WorkstationConfigOrBuilder
      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:
      getUidBytes in interface WorkstationConfigOrBuilder
      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:
      getReconciling in interface WorkstationConfigOrBuilder
      Returns:
      The reconciling.
    • getAnnotationsCount

      public int getAnnotationsCount()
      Description copied from interface: WorkstationConfigOrBuilder
       Optional. Client-specified annotations.
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsCount in interface WorkstationConfigOrBuilder
    • containsAnnotations

      public boolean containsAnnotations(String key)
       Optional. Client-specified annotations.
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsAnnotations in interface WorkstationConfigOrBuilder
    • getAnnotations

      @Deprecated public Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.
      Specified by:
      getAnnotations in interface WorkstationConfigOrBuilder
    • getAnnotationsMap

      public Map<String,String> getAnnotationsMap()
       Optional. Client-specified annotations.
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsMap in interface WorkstationConfigOrBuilder
    • getAnnotationsOrDefault

      public String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. Client-specified annotations.
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrDefault in interface WorkstationConfigOrBuilder
    • getAnnotationsOrThrow

      public String getAnnotationsOrThrow(String key)
       Optional. Client-specified annotations.
       
      map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotationsOrThrow in interface WorkstationConfigOrBuilder
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: WorkstationConfigOrBuilder
       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:
      getLabelsCount in interface WorkstationConfigOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       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:
      containsLabels in interface WorkstationConfigOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface WorkstationConfigOrBuilder
    • getLabelsMap

      public Map<String,String> 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:
      getLabelsMap in interface WorkstationConfigOrBuilder
    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       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:
      getLabelsOrDefault in interface WorkstationConfigOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       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:
      getLabelsOrThrow in interface WorkstationConfigOrBuilder
    • 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:
      hasCreateTime in interface WorkstationConfigOrBuilder
      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:
      getCreateTime in interface WorkstationConfigOrBuilder
      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:
      getCreateTimeOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      hasUpdateTime in interface WorkstationConfigOrBuilder
      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:
      getUpdateTime in interface WorkstationConfigOrBuilder
      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:
      getUpdateTimeOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      hasDeleteTime in interface WorkstationConfigOrBuilder
      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:
      getDeleteTime in interface WorkstationConfigOrBuilder
      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:
      getDeleteTimeOrBuilder in interface WorkstationConfigOrBuilder
    • getEtag

      public String 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:
      getEtag in interface WorkstationConfigOrBuilder
      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:
      getEtagBytes in interface WorkstationConfigOrBuilder
      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:
      hasIdleTimeout in interface WorkstationConfigOrBuilder
      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:
      getIdleTimeout in interface WorkstationConfigOrBuilder
      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:
      getIdleTimeoutOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      hasRunningTimeout in interface WorkstationConfigOrBuilder
      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:
      getRunningTimeout in interface WorkstationConfigOrBuilder
      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:
      getRunningTimeoutOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      hasHost in interface WorkstationConfigOrBuilder
      Returns:
      Whether the host field is set.
    • getHost

      public WorkstationConfig.Host getHost()
       Optional. Runtime host for the workstation.
       
      .google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHost in interface WorkstationConfigOrBuilder
      Returns:
      The host.
    • getHostOrBuilder

      public WorkstationConfig.HostOrBuilder getHostOrBuilder()
       Optional. Runtime host for the workstation.
       
      .google.cloud.workstations.v1beta.WorkstationConfig.Host host = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHostOrBuilder in interface WorkstationConfigOrBuilder
    • getPersistentDirectoriesList

      public List<WorkstationConfig.PersistentDirectory> 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:
      getPersistentDirectoriesList in interface WorkstationConfigOrBuilder
    • 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:
      getPersistentDirectoriesOrBuilderList in interface WorkstationConfigOrBuilder
    • 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:
      getPersistentDirectoriesCount in interface WorkstationConfigOrBuilder
    • getPersistentDirectories

      public WorkstationConfig.PersistentDirectory getPersistentDirectories(int index)
       Optional. Directories to persist across workstation sessions.
       
      repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPersistentDirectories in interface WorkstationConfigOrBuilder
    • getPersistentDirectoriesOrBuilder

      public WorkstationConfig.PersistentDirectoryOrBuilder getPersistentDirectoriesOrBuilder(int index)
       Optional. Directories to persist across workstation sessions.
       
      repeated .google.cloud.workstations.v1beta.WorkstationConfig.PersistentDirectory persistent_directories = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPersistentDirectoriesOrBuilder in interface WorkstationConfigOrBuilder
    • getEphemeralDirectoriesList

      public List<WorkstationConfig.EphemeralDirectory> 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:
      getEphemeralDirectoriesList in interface WorkstationConfigOrBuilder
    • 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:
      getEphemeralDirectoriesOrBuilderList in interface WorkstationConfigOrBuilder
    • 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:
      getEphemeralDirectoriesCount in interface WorkstationConfigOrBuilder
    • getEphemeralDirectories

      public WorkstationConfig.EphemeralDirectory getEphemeralDirectories(int index)
       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:
      getEphemeralDirectories in interface WorkstationConfigOrBuilder
    • getEphemeralDirectoriesOrBuilder

      public WorkstationConfig.EphemeralDirectoryOrBuilder getEphemeralDirectoriesOrBuilder(int index)
       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:
      getEphemeralDirectoriesOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      hasContainer in interface WorkstationConfigOrBuilder
      Returns:
      Whether the container field is set.
    • getContainer

      public WorkstationConfig.Container 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:
      getContainer in interface WorkstationConfigOrBuilder
      Returns:
      The container.
    • getContainerOrBuilder

      public WorkstationConfig.ContainerOrBuilder 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:
      getContainerOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      hasEncryptionKey in interface WorkstationConfigOrBuilder
      Returns:
      Whether the encryptionKey field is set.
    • getEncryptionKey

      public WorkstationConfig.CustomerEncryptionKey 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:
      getEncryptionKey in interface WorkstationConfigOrBuilder
      Returns:
      The encryptionKey.
    • getEncryptionKeyOrBuilder

      public WorkstationConfig.CustomerEncryptionKeyOrBuilder 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:
      getEncryptionKeyOrBuilder in interface WorkstationConfigOrBuilder
    • getReadinessChecksList

      public List<WorkstationConfig.ReadinessCheck> 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:
      getReadinessChecksList in interface WorkstationConfigOrBuilder
    • getReadinessChecksOrBuilderList

      public List<? extends WorkstationConfig.ReadinessCheckOrBuilder> 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:
      getReadinessChecksOrBuilderList in interface WorkstationConfigOrBuilder
    • 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:
      getReadinessChecksCount in interface WorkstationConfigOrBuilder
    • getReadinessChecks

      public WorkstationConfig.ReadinessCheck getReadinessChecks(int index)
       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:
      getReadinessChecks in interface WorkstationConfigOrBuilder
    • getReadinessChecksOrBuilder

      public WorkstationConfig.ReadinessCheckOrBuilder getReadinessChecksOrBuilder(int index)
       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:
      getReadinessChecksOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      getReplicaZonesList in interface WorkstationConfigOrBuilder
      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:
      getReplicaZonesCount in interface WorkstationConfigOrBuilder
      Returns:
      The count of replicaZones.
    • getReplicaZones

      public String getReplicaZones(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:
      getReplicaZones in interface WorkstationConfigOrBuilder
      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:
      getReplicaZonesBytes in interface WorkstationConfigOrBuilder
      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:
      getDegraded in interface WorkstationConfigOrBuilder
      Returns:
      The degraded.
    • 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];
      Specified by:
      getConditionsList in interface WorkstationConfigOrBuilder
    • 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];
      Specified by:
      getConditionsOrBuilderList in interface WorkstationConfigOrBuilder
    • 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:
      getConditionsCount in interface WorkstationConfigOrBuilder
    • getConditions

      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];
      Specified by:
      getConditions in interface WorkstationConfigOrBuilder
    • getConditionsOrBuilder

      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];
      Specified by:
      getConditionsOrBuilder in interface WorkstationConfigOrBuilder
    • 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:
      getEnableAuditAgent in interface WorkstationConfigOrBuilder
      Returns:
      The enableAuditAgent.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.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

      public static WorkstationConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static WorkstationConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static WorkstationConfig parseDelimitedFrom(InputStream input) throws IOException
      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

      public WorkstationConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static WorkstationConfig.Builder newBuilder()
    • newBuilder

      public static WorkstationConfig.Builder newBuilder(WorkstationConfig prototype)
    • toBuilder

      public WorkstationConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected WorkstationConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static WorkstationConfig getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<WorkstationConfig> parser()
    • getParserForType

      public com.google.protobuf.Parser<WorkstationConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public WorkstationConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder