Class: Google::Cloud::Workstations::V1::WorkstationCluster

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 workstation cluster resource in the Cloud Workstations API.

Defines a group of workstations in a particular region and the VPC network they're attached to.

Defined Under Namespace

Classes: AnnotationsEntry, LabelsEntry, PrivateClusterConfig

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.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#conditions ⇒ ::Array<::Google::Rpc::Status> (readonly)

Returns Output only. Status conditions describing the workstation cluster's current state.

Returns:

  • (::Array<::Google::Rpc::Status>) —

    Output only. Status conditions describing the workstation cluster's current state.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#control_plane_ip ⇒ ::String (readonly)

Returns Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.

Returns:

  • (::String) —

    Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

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

Returns Output only. Time when this workstation cluster was created.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#degraded ⇒ ::Boolean (readonly)

Returns Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.

Returns:

  • (::Boolean) —

    Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

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

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

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#display_name ⇒ ::String

Returns Optional. Human-readable name for this workstation cluster.

Returns:

  • (::String) —

    Optional. Human-readable name for this workstation cluster.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
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.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

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

Returns Optional. Labels that are applied to the workstation cluster 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 cluster and that are also propagated to the underlying Compute Engine resources.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#name ⇒ ::String

Returns Full name of this workstation cluster.

Returns:

  • (::String) —

    Full name of this workstation cluster.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#network ⇒ ::String

Returns Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.

Returns:

  • (::String) —

    Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#private_cluster_config ⇒ ::Google::Cloud::Workstations::V1::WorkstationCluster::PrivateClusterConfig

Returns Optional. Configuration for private workstation cluster.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#reconciling ⇒ ::Boolean (readonly)

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

Returns:

  • (::Boolean) —

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#subnetwork ⇒ ::String

Returns Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.

Returns:

  • (::String) —

    Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

#uid ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end

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

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

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/cloud/workstations/v1/workstations.rb', line 93

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

  # Configuration options for private workstation clusters.
  # @!attribute [rw] enable_private_endpoint
  #   @return [::Boolean]
  #     Immutable. Whether Workstations endpoint is private.
  # @!attribute [r] cluster_hostname
  #   @return [::String]
  #     Output only. Hostname for the workstation cluster. This field will be
  #     populated only when private endpoint is enabled. To access workstations
  #     in the workstation cluster, create a new DNS zone mapping this domain
  #     name to an internal IP address and a forwarding rule mapping that address
  #     to the service attachment.
  # @!attribute [r] service_attachment_uri
  #   @return [::String]
  #     Output only. Service attachment URI for the workstation cluster. The
  #     service attachemnt is created when private endpoint is enabled. To access
  #     workstations in the workstation cluster, configure access to the managed
  #     service using [Private Service
  #     Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
  # @!attribute [rw] allowed_projects
  #   @return [::Array<::String>]
  #     Optional. Additional projects that are allowed to attach to the
  #     workstation cluster's service attachment. By default, the workstation
  #     cluster's project and the VPC host project (if different) are allowed.
  class PrivateClusterConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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
end