Class: Google::Cloud::Workstations::V1beta::WorkstationCluster

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/workstations/v1beta/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, DomainConfig, GatewayConfig, LabelsEntry, PrivateClusterConfig, TagsEntry

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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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. The conditions field contains detailed information about the status of the cluster.

Returns:

  • (::Boolean)

    Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#domain_config::Google::Cloud::Workstations::V1beta::WorkstationCluster::DomainConfig

Returns Optional. Configuration options for a custom domain.

Returns:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#gateway_config::Google::Cloud::Workstations::V1beta::WorkstationCluster::GatewayConfig

Returns Optional. Configuration options for Cluster HTTP Gateway.

Returns:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#name::String

Returns Identifier. Full name of this workstation cluster.

Returns:

  • (::String)

    Identifier. Full name of this workstation cluster.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#private_cluster_config::Google::Cloud::Workstations::V1beta::WorkstationCluster::PrivateClusterConfig

Returns Optional. Configuration for private workstation cluster.

Returns:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#satisfies_pzi::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean)

    Output only. Reserved for future use.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#satisfies_pzs::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean)

    Output only. Reserved for future use.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

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

Returns Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing".

Returns:

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

    Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class TagsEntry
    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:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#workstation_authorization_url::String

Returns Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster.

Redirects to this endpoint will send a base64 encoded state query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using GenerateAccessToken and redirecting back to the original hostname with the token.

Returns:

  • (::String)

    Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster.

    Redirects to this endpoint will send a base64 encoded state query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using GenerateAccessToken and redirecting back to the original hostname with the token.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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

#workstation_launch_url::String

Returns Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL.

Requests redirected to the launch endpoint will be sent with a workstation and project query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches STATE_RUNNING, and then issuing a redirect to the workstation's host URL.

Returns:

  • (::String)

    Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL.

    Requests redirected to the launch endpoint will be sent with a workstation and project query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches STATE_RUNNING, and then issuing a redirect to the workstation's host URL.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'proto_docs/google/cloud/workstations/v1beta/workstations.rb', line 130

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 attachment 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

  # Configuration options for a custom domain.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Immutable. Domain used by Workstations for HTTP ingress.
  class DomainConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration options for Cluster HTTP Gateway.
  # @!attribute [rw] http2_enabled
  #   @return [::Boolean]
  #     Optional. Whether HTTP/2 is enabled for this workstation cluster.
  #     Defaults to false.
  class GatewayConfig
    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

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