2022-12-09
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.setIamPolicy
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+resource}:setIamPolicy
Parameter Order: resource
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Location: path
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy
Parameters:
options.requestedPolicyVersion
Format: int32
Location: query
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Path: v1beta/{+resource}:getIamPolicy
HTTP Method: GET
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list
Path: v1beta/{+parent}/workstations
Description: Returns all Workstations using the specified config.
Parameter Order: parent
Parameters:
parent
Description: Required. Parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Type: string
Location: path
Required: Yes
pageToken
Type: string
Location: query
Description: next_page_token value returned from a previous List request, if any.
pageSize
Format: int32
Description: Maximum number of items to return.
Location: query
Type: integer
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable
Description: Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission.
Parameters:
pageToken
Description: next_page_token value returned from a previous List request, if any.
Type: string
Location: query
pageSize
Type: integer
Format: int32
Location: query
Description: Maximum number of items to return.
parent
Location: path
Description: Required. Parent resource name.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Parameter Order: parent
Path: v1beta/{+parent}/workstations:listUsable
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable
HTTP Method: GET
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+resource}:testIamPermissions
HTTP Method: POST
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.stop
Path: v1beta/{+name}:stop
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Stops running a workstation, reducing costs.
HTTP Method: POST
Parameters:
name
Location: path
Type: string
Description: Required. Name of the workstation to stop.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:stop
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.delete
Parameters:
etag
Type: string
Description: If set, the request will be rejected if the latest version of the workstation on the server does not have this etag.
Location: query
name
Description: Required. Name of the workstation to delete.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Location: path
validateOnly
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
HTTP Method: DELETE
Description: Deletes the specified Workstation.
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.patch
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
HTTP Method: PATCH
Description: Updates an existing Workstation.
Parameters:
name
Required: Yes
Description: Full name of this resource.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
updateMask
Location: query
Format: google-fieldmask
Description: Required. Mask specifying which fields in the config should be updated.
Type: string
allowMissing
Type: boolean
Location: query
Description: If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.
validateOnly
Description: If set, validate the request and preview the review, but do not actually apply it.
Location: query
Type: boolean
Path: v1beta/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken
Description: Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:generateAccessToken
Parameter Order: workstation
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+workstation}:generateAccessToken
Parameters:
workstation
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
Description: Required. Name of the workstation for which the access token should be generated.
Location: path
Type: string
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Description: Required. Name of the requested resource.
Location: path
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
Path: v1beta/{+name}
HTTP Method: GET
Description: Returns the requested Workstation.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.start
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:start
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Type: string
Description: Required. Name of the workstation to start.
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1beta/{+name}:start
Description: Starts running a workstation so that users can connect to it.
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.create
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
Parameter Order: parent
Parameters:
parent
Type: string
Location: path
Description: Required. Parent resource name.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
workstationId
Location: query
Description: Required. ID to use for the workstation.
Type: string
validateOnly
Location: query
Type: boolean
Description: If set, validate the request and preview the review, but do not actually apply it.
Description: Creates a new Workstation.
Path: v1beta/{+parent}/workstations
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.listUsable
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns all WorkstationConfigs in the specified cluster on which the caller has the "workstations.workstation.create" permission.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs:listUsable
Path: v1beta/{+parent}/workstationConfigs:listUsable
HTTP Method: GET
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: Maximum number of items to return.
pageToken
Type: string
Description: next_page_token value returned from a previous List request, if any.
Location: query
parent
Required: Yes
Description: Required. Parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Type: string
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Returns the requested WorkstationConfig.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
Path: v1beta/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
Required: Yes
Description: Required. Name of the requested resource.
Type: string
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.delete
Description: Deletes the specified WorkstationConfig.
Parameter Order: name
Parameters:
force
Type: boolean
Location: query
Description: If set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations.
validateOnly
Description: If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
Location: query
etag
Type: string
Location: query
Description: If set, the request will be rejected if the latest version of the config on the server does not have this etag.
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
Description: Required. Name of the config to delete.
Type: string
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
Path: v1beta/{+name}
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.create
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Type: string
Description: Required. Parent resource name.
Required: Yes
Location: path
validateOnly
Type: boolean
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
workstationConfigId
Description: Required. ID to use for the config.
Type: string
Location: query
Path: v1beta/{+parent}/workstationConfigs
Description: Creates a new WorkstationConfig.
HTTP Method: POST
Parameter Order: parent
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.list
Description: Returns all WorkstationConfigs in the specified cluster.
Parameters:
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Description: Required. Parent resource name.
pageSize
Location: query
Format: int32
Description: Maximum number of items to return.
Type: integer
pageToken
Location: query
Description: next_page_token value returned from a previous List request, if any.
Type: string
HTTP Method: GET
Path: v1beta/{+parent}/workstationConfigs
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
Parameter Order: parent
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1beta/{+resource}:setIamPolicy
Parameter Order: resource
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Type: string
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+resource}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions
Parameter Order: resource
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.patch
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
Description: Updates an existing WorkstationConfig.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
allowMissing
Location: query
Description: If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.
Type: boolean
updateMask
Type: string
Location: query
Format: google-fieldmask
Description: Required. Mask specifying which fields in the config should be updated.
validateOnly
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
name
Required: Yes
Description: Full name of this resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
HTTP Method: PATCH
Path: v1beta/{+name}
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy
HTTP Method: GET
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Type: integer
Location: query
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy
Path: v1beta/{+resource}:getIamPolicy
▼ ▲ workstations.projects.locations.workstationClusters.patch
Description: Updates an existing WorkstationCluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
updateMask
Location: query
Type: string
Format: google-fieldmask
Description: Required. Mask specifying which fields in the cluster should be updated.
allowMissing
Location: query
Description: If set, and the cluster is not found, a new cluster will be created. In this situation, update_mask is ignored.
Type: boolean
name
Type: string
Location: path
Description: Full name of this resource.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Required: Yes
validateOnly
Type: boolean
Description: If set, validate the request and preview the review, but do not actually apply it.
Location: query
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
HTTP Method: PATCH
Path: v1beta/{+name}
▼ ▲ workstations.projects.locations.workstationClusters.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters
Description: Creates a new WorkstationCluster.
HTTP Method: POST
Path: v1beta/{+parent}/workstationClusters
Parameters:
validateOnly
Type: boolean
Description: If set, validate the request and preview the review, but do not actually apply it.
Location: query
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent resource name.
Location: path
workstationClusterId
Location: query
Type: string
Description: Required. ID to use for the cluster.
▼ ▲ workstations.projects.locations.workstationClusters.delete
Description: Deletes the specified WorkstationCluster.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Required: Yes
Description: Required. Name of the cluster to delete.
Type: string
validateOnly
Type: boolean
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
force
Description: If set, any WorkstationConfigs and Workstations in the cluster will also be deleted. Otherwise, the request will work only if the cluster has no configs or workstations.
Location: query
Type: boolean
etag
Description: If set, the request will be rejected if the latest version of the cluster on the server does not have this etag.
Type: string
Location: query
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}
HTTP Method: DELETE
▼ ▲ workstations.projects.locations.workstationClusters.list
Description: Returns all WorkstationClusters in the specified location.
Path: v1beta/{+parent}/workstationClusters
Parameter Order: parent
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters
Parameters:
pageToken
Type: string
Description: next_page_token value returned from a previous List request, if any.
Location: query
pageSize
Format: int32
Type: integer
Description: Maximum number of items to return.
Location: query
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent resource name.
HTTP Method: GET
▼ ▲ workstations.projects.locations.workstationClusters.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
HTTP Method: GET
Description: Returns the requested WorkstationCluster.
Parameters:
name
Location: path
Type: string
Required: Yes
Description: Required. Name of the requested resource.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
▼ ▲ workstations.projects.locations.operations.cancel
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}:cancel
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
HTTP Method: POST
▼ ▲ workstations.projects.locations.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}/operations
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: The name of the operation's parent resource.
filter
Location: query
Description: The standard list filter.
Type: string
pageToken
Type: string
Description: The standard list page token.
Location: query
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
▼ ▲ workstations.projects.locations.operations.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Location: path
Path: v1beta/{+name}
HTTP Method: GET
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ workstations.projects.locations.operations.delete
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Path: v1beta/{+name}
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.setIamPolicy
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+resource}:setIamPolicy
Parameter Order: resource
Parameters:
resource
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Location: path
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy
Parameters:
options.requestedPolicyVersion
Format: int32
Location: query
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Path: v1beta/{+resource}:getIamPolicy
HTTP Method: GET
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list
Path: v1beta/{+parent}/workstations
Description: Returns all Workstations using the specified config.
Parameter Order: parent
Parameters:
parent
Description: Required. Parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Type: string
Location: path
Required: Yes
pageToken
Type: string
Location: query
Description: next_page_token value returned from a previous List request, if any.
pageSize
Format: int32
Description: Maximum number of items to return.
Location: query
Type: integer
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable
Description: Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission.
Parameters:
pageToken
Description: next_page_token value returned from a previous List request, if any.
Type: string
Location: query
pageSize
Type: integer
Format: int32
Location: query
Description: Maximum number of items to return.
parent
Location: path
Description: Required. Parent resource name.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Parameter Order: parent
Path: v1beta/{+parent}/workstations:listUsable
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable
HTTP Method: GET
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+resource}:testIamPermissions
HTTP Method: POST
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.stop
Path: v1beta/{+name}:stop
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Stops running a workstation, reducing costs.
HTTP Method: POST
Parameters:
name
Location: path
Type: string
Description: Required. Name of the workstation to stop.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:stop
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.delete
Parameters:
etag
Type: string
Description: If set, the request will be rejected if the latest version of the workstation on the server does not have this etag.
Location: query
name
Description: Required. Name of the workstation to delete.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Location: path
validateOnly
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
HTTP Method: DELETE
Description: Deletes the specified Workstation.
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.patch
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
HTTP Method: PATCH
Description: Updates an existing Workstation.
Parameters:
name
Required: Yes
Description: Full name of this resource.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
updateMask
Location: query
Format: google-fieldmask
Description: Required. Mask specifying which fields in the config should be updated.
Type: string
allowMissing
Type: boolean
Location: query
Description: If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.
validateOnly
Description: If set, validate the request and preview the review, but do not actually apply it.
Location: query
Type: boolean
Path: v1beta/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken
Description: Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:generateAccessToken
Parameter Order: workstation
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+workstation}:generateAccessToken
Parameters:
workstation
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
Description: Required. Name of the workstation for which the access token should be generated.
Location: path
Type: string
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Description: Required. Name of the requested resource.
Location: path
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
Path: v1beta/{+name}
HTTP Method: GET
Description: Returns the requested Workstation.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.start
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:start
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Type: string
Description: Required. Name of the workstation to start.
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1beta/{+name}:start
Description: Starts running a workstation so that users can connect to it.
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.create
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
Parameter Order: parent
Parameters:
parent
Type: string
Location: path
Description: Required. Parent resource name.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
workstationId
Location: query
Description: Required. ID to use for the workstation.
Type: string
validateOnly
Location: query
Type: boolean
Description: If set, validate the request and preview the review, but do not actually apply it.
Description: Creates a new Workstation.
Path: v1beta/{+parent}/workstations
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.listUsable
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns all WorkstationConfigs in the specified cluster on which the caller has the "workstations.workstation.create" permission.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs:listUsable
Path: v1beta/{+parent}/workstationConfigs:listUsable
HTTP Method: GET
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: Maximum number of items to return.
pageToken
Type: string
Description: next_page_token value returned from a previous List request, if any.
Location: query
parent
Required: Yes
Description: Required. Parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Type: string
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Returns the requested WorkstationConfig.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
Path: v1beta/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
Required: Yes
Description: Required. Name of the requested resource.
Type: string
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.delete
Description: Deletes the specified WorkstationConfig.
Parameter Order: name
Parameters:
force
Type: boolean
Location: query
Description: If set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations.
validateOnly
Description: If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
Location: query
etag
Type: string
Location: query
Description: If set, the request will be rejected if the latest version of the config on the server does not have this etag.
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
Description: Required. Name of the config to delete.
Type: string
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
Path: v1beta/{+name}
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.create
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Type: string
Description: Required. Parent resource name.
Required: Yes
Location: path
validateOnly
Type: boolean
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
workstationConfigId
Description: Required. ID to use for the config.
Type: string
Location: query
Path: v1beta/{+parent}/workstationConfigs
Description: Creates a new WorkstationConfig.
HTTP Method: POST
Parameter Order: parent
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.list
Description: Returns all WorkstationConfigs in the specified cluster.
Parameters:
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Description: Required. Parent resource name.
pageSize
Location: query
Format: int32
Description: Maximum number of items to return.
Type: integer
pageToken
Location: query
Description: next_page_token value returned from a previous List request, if any.
Type: string
HTTP Method: GET
Path: v1beta/{+parent}/workstationConfigs
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
Parameter Order: parent
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1beta/{+resource}:setIamPolicy
Parameter Order: resource
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Type: string
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+resource}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions
Parameter Order: resource
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.patch
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
Description: Updates an existing WorkstationConfig.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
allowMissing
Location: query
Description: If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.
Type: boolean
updateMask
Type: string
Location: query
Format: google-fieldmask
Description: Required. Mask specifying which fields in the config should be updated.
validateOnly
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
name
Required: Yes
Description: Full name of this resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
HTTP Method: PATCH
Path: v1beta/{+name}
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy
HTTP Method: GET
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Type: integer
Location: query
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy
Path: v1beta/{+resource}:getIamPolicy
▼ ▲ workstations.projects.locations.workstationClusters.patch
Description: Updates an existing WorkstationCluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
updateMask
Location: query
Type: string
Format: google-fieldmask
Description: Required. Mask specifying which fields in the cluster should be updated.
allowMissing
Location: query
Description: If set, and the cluster is not found, a new cluster will be created. In this situation, update_mask is ignored.
Type: boolean
name
Type: string
Location: path
Description: Full name of this resource.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Required: Yes
validateOnly
Type: boolean
Description: If set, validate the request and preview the review, but do not actually apply it.
Location: query
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
HTTP Method: PATCH
Path: v1beta/{+name}
▼ ▲ workstations.projects.locations.workstationClusters.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters
Description: Creates a new WorkstationCluster.
HTTP Method: POST
Path: v1beta/{+parent}/workstationClusters
Parameters:
validateOnly
Type: boolean
Description: If set, validate the request and preview the review, but do not actually apply it.
Location: query
parent
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent resource name.
Location: path
workstationClusterId
Location: query
Type: string
Description: Required. ID to use for the cluster.
▼ ▲ workstations.projects.locations.workstationClusters.delete
Description: Deletes the specified WorkstationCluster.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Required: Yes
Description: Required. Name of the cluster to delete.
Type: string
validateOnly
Type: boolean
Location: query
Description: If set, validate the request and preview the review, but do not actually apply it.
force
Description: If set, any WorkstationConfigs and Workstations in the cluster will also be deleted. Otherwise, the request will work only if the cluster has no configs or workstations.
Location: query
Type: boolean
etag
Description: If set, the request will be rejected if the latest version of the cluster on the server does not have this etag.
Type: string
Location: query
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}
HTTP Method: DELETE
▼ ▲ workstations.projects.locations.workstationClusters.list
Description: Returns all WorkstationClusters in the specified location.
Path: v1beta/{+parent}/workstationClusters
Parameter Order: parent
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters
Parameters:
pageToken
Type: string
Description: next_page_token value returned from a previous List request, if any.
Location: query
pageSize
Format: int32
Type: integer
Description: Maximum number of items to return.
Location: query
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent resource name.
HTTP Method: GET
▼ ▲ workstations.projects.locations.workstationClusters.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
HTTP Method: GET
Description: Returns the requested WorkstationCluster.
Parameters:
name
Location: path
Type: string
Required: Yes
Description: Required. Name of the requested resource.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
▼ ▲ workstations.projects.locations.operations.cancel
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}:cancel
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
HTTP Method: POST
▼ ▲ workstations.projects.locations.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}/operations
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: The name of the operation's parent resource.
filter
Location: query
Description: The standard list filter.
Type: string
pageToken
Type: string
Description: The standard list page token.
Location: query
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
▼ ▲ workstations.projects.locations.operations.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Type: string
Location: path
Path: v1beta/{+name}
HTTP Method: GET
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ workstations.projects.locations.operations.delete
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Path: v1beta/{+name}