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

Inherits:
Object
  • Object
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, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Optional. Client-specified annotations.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Optional. Client-specified annotations.


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

  # 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:


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

  # 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:


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

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


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

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


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

  # 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}.


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

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


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

  # 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 Full name of this workstation.

Returns:

  • (::String)

    Full name of this workstation.


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

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


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

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


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

  # 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:


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

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


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

  # 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:


659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 659

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

  # @!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

  # 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