Class: Google::Cloud::Workstations::V1::Workstation

Inherits:

Object

Object
Google::Cloud::Workstations::V1::Workstation

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/workstations/v1/workstations.rb

Overview

A single instance of a developer workstation with its own persistent storage.

Defined Under Namespace

Modules: State Classes: AnnotationsEntry, EnvEntry, LabelsEntry, RuntimeHost, WorkstationPersistentDirectory

Instance Attribute Summary collapse

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}
Optional.
#create_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#delete_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#display_name ⇒ ::String
Optional.
#env ⇒ ::Google::Protobuf::Map{::String => ::String}
Optional.
#etag ⇒ ::String
Optional.
#host ⇒ ::String readonly
Output only.
#kms_key ⇒ ::String readonly
Output only.
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Optional.
#name ⇒ ::String
Identifier.
#persistent_directories ⇒ ::Array<::Google::Cloud::Workstations::V1::Workstation::WorkstationPersistentDirectory>
Optional.
#reconciling ⇒ ::Boolean readonly
Output only.
#runtime_host ⇒ ::Google::Cloud::Workstations::V1::Workstation::RuntimeHost readonly
Optional.
#source_workstation ⇒ ::String
Optional.
#start_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#state ⇒ ::Google::Cloud::Workstations::V1::Workstation::State readonly
Output only.
#uid ⇒ ::String readonly
Output only.
#update_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.

Instance Attribute Details

#annotations ⇒ `::Google::Protobuf::Map{::String => ::String}`

Returns Optional. Client-specified annotations.

Returns:

(::Google::Protobuf::Map{::String => ::String}) —
Optional. Client-specified annotations.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time when this workstation was created.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time when this workstation was created.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#delete_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time when this workstation was soft-deleted.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time when this workstation was soft-deleted.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#display_name ⇒ `::String`

Returns Optional. Human-readable name for this workstation.

Returns:

(::String) —
Optional. Human-readable name for this workstation.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#env ⇒ `::Google::Protobuf::Map{::String => ::String}`

Returns Optional. Environment variables passed to the workstation container's entrypoint.

Returns:

(::Google::Protobuf::Map{::String => ::String}) —
Optional. Environment variables passed to the workstation container's entrypoint.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#etag ⇒ `::String`

Returns 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.

Returns:

(::String) —
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.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#host ⇒ `::String` (readonly)

Returns Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

Returns:

(::String) —
Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#kms_key ⇒ `::String` (readonly)

Returns Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

Returns:

(::String) —
Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

Returns Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

Returns:

(::Google::Protobuf::Map{::String => ::String}) —
Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#name ⇒ `::String`

Returns Identifier. Full name of this workstation.

Returns:

(::String) —
Identifier. Full name of this workstation.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#persistent_directories ⇒ `::Array<::Google::Cloud::Workstations::V1::Workstation::WorkstationPersistentDirectory>`

Returns Optional. Directories to persist across workstation sessions.

Returns:

(::Array<::Google::Cloud::Workstations::V1::Workstation::WorkstationPersistentDirectory>) —
Optional. Directories to persist across workstation sessions.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#reconciling ⇒ `::Boolean` (readonly)

Returns Output only. Indicates whether this workstation is currently being updated to match its intended state.

Returns:

(::Boolean) —
Output only. Indicates whether this workstation is currently being updated to match its intended state.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#runtime_host ⇒ `::Google::Cloud::Workstations::V1::Workstation::RuntimeHost` (readonly)

Returns Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

Returns:

(::Google::Cloud::Workstations::V1::Workstation::RuntimeHost) —
Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#source_workstation ⇒ `::String`

Returns Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

Returns:

(::String) —
Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#start_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#state ⇒ `::Google::Cloud::Workstations::V1::Workstation::State` (readonly)

Returns Output only. Current state of the workstation.

Returns:

(::Google::Cloud::Workstations::V1::Workstation::State) —
Output only. Current state of the workstation.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#uid ⇒ `::String` (readonly)

Returns Output only. A system-assigned unique identifier for this workstation.

Returns:

(::String) —
Output only. A system-assigned unique identifier for this workstation.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

#update_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. Time when this workstation was most recently updated.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. Time when this workstation was most recently updated.

# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 1087

class Workstation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A directory to persist across workstation sessions. Updates to this field
  # will only take effect on this workstation after it is restarted.
  # @!attribute [rw] mount_path
  #   @return [::String]
  #     Optional. The mount path of the persistent directory.
  # @!attribute [rw] size_gb
  #   @return [::Integer]
  #     Optional. Size of the persistent directory in GB. If specified in an
  #     update request, this is the desired size of the directory.
  class WorkstationPersistentDirectory
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Runtime host for the workstation.
  # @!attribute [rw] gce_instance_host
  #   @return [::Google::Cloud::Workstations::V1::Workstation::RuntimeHost::GceInstanceHost]
  #     Specifies a Compute Engine instance as the host.
  class RuntimeHost
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Compute Engine instance host.
    # @!attribute [r] name
    #   @return [::String]
    #     Optional. Output only. The name of the Compute Engine instance.
    # @!attribute [r] id
    #   @return [::String]
    #     Optional. Output only. The ID of the Compute Engine instance.
    # @!attribute [r] zone
    #   @return [::String]
    #     Optional. Output only. The zone of the Compute Engine instance.
    class GceInstanceHost
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class EnvEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether a workstation is running and ready to receive user requests.
  module State
    # Do not use.
    STATE_UNSPECIFIED = 0

    # The workstation is not yet ready to accept requests from users but will
    # be soon.
    STATE_STARTING = 1

    # The workstation is ready to accept requests from users.
    STATE_RUNNING = 2

    # The workstation is being stopped.
    STATE_STOPPING = 3

    # The workstation is stopped and will not be able to receive requests until
    # it is started.
    STATE_STOPPED = 4
  end
end

Class: Google::Cloud::Workstations::V1::Workstation

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#display_name ⇒ ::String

#env ⇒ ::Google::Protobuf::Map{::String => ::String}

#etag ⇒ ::String

#host ⇒ ::String (readonly)

#kms_key ⇒ ::String (readonly)

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

#name ⇒ ::String

#persistent_directories ⇒ ::Array<::Google::Cloud::Workstations::V1::Workstation::WorkstationPersistentDirectory>

#reconciling ⇒ ::Boolean (readonly)

#runtime_host ⇒ ::Google::Cloud::Workstations::V1::Workstation::RuntimeHost (readonly)

#source_workstation ⇒ ::String

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#state ⇒ ::Google::Cloud::Workstations::V1::Workstation::State (readonly)

#uid ⇒ ::String (readonly)

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#annotations ⇒ `::Google::Protobuf::Map{::String => ::String}`

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#delete_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#display_name ⇒ `::String`

#env ⇒ `::Google::Protobuf::Map{::String => ::String}`

#etag ⇒ `::String`

#host ⇒ `::String` (readonly)

#kms_key ⇒ `::String` (readonly)

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

#name ⇒ `::String`

#persistent_directories ⇒ `::Array<::Google::Cloud::Workstations::V1::Workstation::WorkstationPersistentDirectory>`

#reconciling ⇒ `::Boolean` (readonly)

#runtime_host ⇒ `::Google::Cloud::Workstations::V1::Workstation::RuntimeHost` (readonly)

#source_workstation ⇒ `::String`

#start_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#state ⇒ `::Google::Cloud::Workstations::V1::Workstation::State` (readonly)

#uid ⇒ `::String` (readonly)

#update_time ⇒ `::Google::Protobuf::Timestamp` (readonly)