2023-09-06
▼ ▲ workstations.projects.locations.workstationClusters.get
Description: Returns the requested workstation cluster.
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Description: Required. Name of the requested resource.
Location: path
Required: Yes
HTTP Method: GET
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
▼ ▲ workstations.projects.locations.workstationClusters.create
Path: v1/{+parent}/workstationClusters
HTTP Method: POST
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters
Description: Creates a new workstation cluster.
Parameters:
workstationClusterId
Type: string
Location: query
Description: Required. ID to use for the workstation cluster.
parent
Description: Required. Parent resource name.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
validateOnly
Type: boolean
Location: query
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
▼ ▲ workstations.projects.locations.workstationClusters.delete
Parameters:
force
Description: Optional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.
Location: query
Type: boolean
name
Location: path
Description: Required. Name of the workstation cluster to delete.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
etag
Description: Optional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.
Type: string
Location: query
validateOnly
Description: Optional. If set, validate the request and preview the review, but do not apply it.
Type: boolean
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
Description: Deletes the specified workstation cluster.
Path: v1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
▼ ▲ workstations.projects.locations.workstationClusters.list
HTTP Method: GET
Description: Returns all workstation clusters in the specified location.
Parameters:
pageToken
Location: query
Type: string
Description: Optional. next_page_token value returned from a previous List request, if any.
pageSize
Description: Optional. Maximum number of items to return.
Format: int32
Location: query
Type: integer
parent
Required: Yes
Description: Required. Parent resource name.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters
Parameter Order: parent
Path: v1/{+parent}/workstationClusters
▼ ▲ workstations.projects.locations.workstationClusters.patch
Parameter Order: name
Path: v1/{+name}
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates an existing workstation cluster.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
Parameters:
validateOnly
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
Location: query
allowMissing
Description: Optional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored.
Type: boolean
Location: query
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Description: Full name of this workstation cluster.
updateMask
Format: google-fieldmask
Description: Required. Mask that specifies which fields in the workstation cluster should be updated.
Type: string
Location: query
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns the requested workstation configuration.
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Description: Required. Name of the requested resource.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Required: Yes
Type: string
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
HTTP Method: GET
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.delete
Parameter Order: name
Parameters:
name
Type: string
Location: path
Description: Required. Name of the workstation configuration to delete.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Required: Yes
force
Location: query
Description: Optional. If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations.
Type: boolean
etag
Description: Optional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag.
Type: string
Location: query
validateOnly
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
Location: query
Type: boolean
Path: v1/{+name}
HTTP Method: DELETE
Description: Deletes the specified workstation configuration.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy
Parameters:
resource
Type: string
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.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Location: path
Path: v1/{+resource}: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.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy
Parameters:
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.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
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).
HTTP Method: GET
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.
Parameter Order: resource
Path: v1/{+resource}:getIamPolicy
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.testIamPermissions
Parameters:
resource
Location: path
Type: string
Required: Yes
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.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+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
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Returns all workstation configurations in the specified cluster.
Parameter Order: parent
Parameters:
pageSize
Location: query
Format: int32
Type: integer
Description: Optional. Maximum number of items to return.
parent
Type: string
Required: Yes
Location: path
Description: Required. Parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
pageToken
Type: string
Description: Optional. next_page_token value returned from a previous List request, if any.
Location: query
Path: v1/{+parent}/workstationConfigs
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.listUsable
Parameters:
pageToken
Type: string
Location: query
Description: Optional. next_page_token value returned from a previous List request, if any.
pageSize
Location: query
Description: Optional. Maximum number of items to return.
Format: int32
Type: integer
parent
Required: Yes
Type: string
Description: Required. Parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs:listUsable
Path: v1/{+parent}/workstationConfigs:listUsable
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.create
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
Location: path
Description: Required. Parent resource name.
Type: string
Required: Yes
validateOnly
Type: boolean
Location: query
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
workstationConfigId
Description: Required. ID to use for the workstation configuration.
Type: string
Location: query
Description: Creates a new workstation configuration.
HTTP Method: POST
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/workstationConfigs
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.patch
Parameters:
name
Location: path
Required: Yes
Description: Full name of this workstation configuration.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
validateOnly
Location: query
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Mask specifying which fields in the workstation configuration should be updated.
allowMissing
Location: query
Description: Optional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored.
Type: boolean
HTTP Method: PATCH
Description: Updates an existing workstation configuration.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
Parameter Order: name
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken
Parameter Order: workstation
Path: v1/{+workstation}: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: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:generateAccessToken
Parameters:
workstation
Description: Required. Name of the workstation for which the access token should be generated.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.get
Parameter Order: name
Parameters:
name
Type: string
Required: Yes
Description: Required. Name of the requested resource.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
Path: v1/{+name}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns the requested workstation.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.start
Parameters:
name
Location: path
Type: string
Required: Yes
Description: Required. Name of the workstation to start.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:start
Path: v1/{+name}:start
Parameter Order: name
HTTP Method: POST
Description: Starts running a workstation so that users can connect to it.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.create
Parameters:
workstationId
Type: string
Description: Required. ID to use for the workstation.
Location: query
validateOnly
Type: boolean
Location: query
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
parent
Type: string
Required: Yes
Location: path
Description: Required. Parent resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
Path: v1/{+parent}/workstations
HTTP Method: POST
Description: Creates a new workstation.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list
Parameter Order: parent
Parameters:
parent
Location: path
Description: Required. Parent resource name.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Type: string
pageToken
Type: string
Description: Optional. next_page_token value returned from a previous List request, if any.
Location: query
pageSize
Description: Optional. Maximum number of items to return.
Format: int32
Location: query
Type: integer
HTTP Method: GET
Path: v1/{+parent}/workstations
Description: Returns all Workstations using the specified workstation configuration.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions
HTTP Method: POST
Parameters:
resource
Type: string
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
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions
Parameter Order: resource
Path: v1/{+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.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.patch
Description: Updates an existing workstation.
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
Path: v1/{+name}
Parameter Order: name
Parameters:
allowMissing
Type: boolean
Location: query
Description: Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.
name
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Type: string
Location: path
Required: Yes
Description: Full name of this workstation.
validateOnly
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
Location: query
Type: boolean
updateMask
Location: query
Format: google-fieldmask
Description: Required. Mask specifying which fields in the workstation configuration should be updated.
Type: string
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.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.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
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.
Path: v1/{+resource}:setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
Parameter Order: name
Description: Deletes the specified workstation.
HTTP Method: DELETE
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. Name of the workstation to delete.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
validateOnly
Location: query
Description: Optional. If set, validate the request and preview the review, but do not actually apply it.
Type: boolean
etag
Type: string
Location: query
Description: Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Description: Optional. next_page_token value returned from a previous List request, if any.
Location: query
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
Description: Required. Parent resource name.
Required: Yes
Location: path
Type: string
pageSize
Location: query
Type: integer
Format: int32
Description: Optional. Maximum number of items to return.
Description: Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
Path: v1/{+parent}/workstations:listUsable
Parameter Order: parent
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:getIamPolicy
Parameter Order: resource
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:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
Required: Yes
Type: string
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.
options.requestedPolicyVersion
Format: int32
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).
Location: query
▼ ▲ workstations.projects.locations.workstationClusters.workstationConfigs.workstations.stop
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:stop
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:stop
Description: Stops running a workstation, reducing costs.
Parameters:
name
Type: string
Description: Required. Name of the workstation to stop.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
HTTP Method: POST
Parameter Order: name
▼ ▲ workstations.projects.locations.operations.cancel
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path: v1/{+name}:cancel
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Location: path
Type: string
HTTP Method: POST
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`.
▼ ▲ workstations.projects.locations.operations.get
HTTP Method: GET
Path: v1/{+name}
Parameter Order: name
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.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
Description: The name of the operation resource.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ workstations.projects.locations.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
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`.
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
▼ ▲ workstations.projects.locations.operations.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Location: query
Type: string
Description: The standard list page token.
name
Location: path
Description: The name of the operation's parent resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1/{+name}/operations
▼ ▲ workstations.projects.locations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Resource name for the location.
Type: string
Location: path
Required: Yes
Path: v1/{+name}
Description: Gets information about a location.
Parameter Order: name
HTTP Method: GET
▼ ▲ workstations.projects.locations.list
Parameters:
filter
Location: query
Type: string
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize
Location: query
Format: int32
Description: The maximum number of results to return. If not set, the service selects a default.
Type: integer
pageToken
Type: string
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location: query
name
Pattern: ^projects/[^/]+$
Required: Yes
Description: The resource that owns the locations collection, if applicable.
Location: path
Type: string
Flat Path: v1/projects/{projectsId}/locations
Description: Lists information about the supported locations for this service.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}/locations