Cloud Workstations API (workstations:v1beta)

2022-12-11

30 new methods | New API

Additions

    Methods
  • workstations.projects.locations.workstationClusters.workstationConfigs.get

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Parameters:

        name

          Location: path

          Description: Required. Name of the requested resource.

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

          Required: Yes

          Type: string

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}

      Description: Returns the requested WorkstationConfig.

      Path: v1beta/{+name}

      HTTP Method: GET

  • workstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy

      Parameter Order: resource

      Parameters:

        resource

          Location: path

          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/[^/]+$

          Type: string

      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

  • workstations.projects.locations.workstationClusters.workstationConfigs.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.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions

      HTTP Method: POST

      Parameters:

        resource

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

          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.

          Type: string

      Parameter Order: resource

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+resource}:testIamPermissions

  • workstations.projects.locations.workstationClusters.workstationConfigs.patch

      Path: v1beta/{+name}

      Parameter Order: name

      HTTP Method: PATCH

      Parameters:

        validateOnly

          Type: boolean

          Location: query

          Description: If set, validate the request and preview the review, but do not actually apply it.

        updateMask

          Format: google-fieldmask

          Type: string

          Description: Required. Mask specifying which fields in the config should be updated.

          Location: query

        name

          Type: string

          Description: Full name of this resource.

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

          Location: path

          Required: Yes

        allowMissing

          Type: boolean

          Description: If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.

          Location: query

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Updates an existing WorkstationConfig.

  • workstations.projects.locations.workstationClusters.workstationConfigs.delete

      Parameters:

        validateOnly

          Location: query

          Description: If set, validate the request and preview the review, but do not actually apply it.

          Type: boolean

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

          Description: Required. Name of the config to delete.

          Required: Yes

          Location: path

          Type: string

        etag

          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.

          Type: string

        force

          Type: boolean

          Description: If set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations.

          Location: query

      Path: v1beta/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}

      Description: Deletes the specified WorkstationConfig.

      HTTP Method: DELETE

  • workstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy

      Path: v1beta/{+resource}:getIamPolicy

      Parameter Order: resource

      Parameters:

        resource

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

          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

          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

          Type: integer

          Format: int32

      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.

  • workstations.projects.locations.workstationClusters.workstationConfigs.listUsable

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+parent}/workstationConfigs:listUsable

      Parameters:

        pageToken

          Location: query

          Description: next_page_token value returned from a previous List request, if any.

          Type: string

        pageSize

          Format: int32

          Location: query

          Description: Maximum number of items to return.

          Type: integer

        parent

          Required: Yes

          Description: Required. Parent resource name.

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$

          Type: string

          Location: path

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs:listUsable

      Description: Returns all WorkstationConfigs in the specified cluster on which the caller has the "workstations.workstation.create" permission.

      HTTP Method: GET

      Parameter Order: parent

  • workstations.projects.locations.workstationClusters.workstationConfigs.create

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        workstationConfigId

          Type: string

          Location: query

          Description: Required. ID to use for the config.

        parent

          Description: Required. Parent resource name.

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$

          Required: Yes

          Type: string

          Location: path

        validateOnly

          Description: If set, validate the request and preview the review, but do not actually apply it.

          Type: boolean

          Location: query

      Path: v1beta/{+parent}/workstationConfigs

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs

      Parameter Order: parent

      Description: Creates a new WorkstationConfig.

      HTTP Method: POST

  • workstations.projects.locations.workstationClusters.workstationConfigs.list

      HTTP Method: GET

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: next_page_token value returned from a previous List request, if any.

        pageSize

          Type: integer

          Format: int32

          Location: query

          Description: Maximum number of items to return.

        parent

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$

          Type: string

          Description: Required. Parent resource name.

          Location: path

      Description: Returns all WorkstationConfigs in the specified cluster.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+parent}/workstationConfigs

      Parameter Order: parent

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken

      HTTP Method: POST

      Parameters:

        workstation

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          Type: string

          Location: path

          Description: Required. Name of the workstation for which the access token should be generated.

          Required: Yes

      Description: Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+workstation}:generateAccessToken

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:generateAccessToken

      Parameter Order: workstation

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.delete

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes the specified Workstation.

      HTTP Method: DELETE

      Path: v1beta/{+name}

      Parameter Order: name

      Parameters:

        etag

          Location: query

          Description: If set, the request will be rejected if the latest version of the workstation on the server does not have this etag.

          Type: string

        name

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          Location: path

          Type: string

          Description: Required. Name of the workstation to delete.

        validateOnly

          Location: query

          Type: boolean

          Description: If set, validate the request and preview the review, but do not actually apply it.

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.create

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+parent}/workstations

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations

      Description: Creates a new Workstation.

      HTTP Method: POST

      Parameter Order: parent

      Parameters:

        validateOnly

          Type: boolean

          Location: query

          Description: If set, validate the request and preview the review, but do not actually apply it.

        workstationId

          Type: string

          Location: query

          Description: Required. ID to use for the workstation.

        parent

          Location: path

          Description: Required. Parent resource name.

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.start

      Parameter Order: name

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          Type: string

          Description: Required. Name of the workstation to start.

          Location: path

          Required: Yes

      Path: v1beta/{+name}:start

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:start

      Description: Starts running a workstation so that users can connect to it.

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameters:

        resource

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          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

          Required: Yes

          Type: string

      Path: v1beta/{+resource}:setIamPolicy

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy

      Parameter Order: resource

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.get

      Parameter Order: name

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+name}

      HTTP Method: GET

      Parameters:

        name

          Location: path

          Description: Required. Name of the requested resource.

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          Type: string

          Required: Yes

      Description: Returns the requested Workstation.

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions

      Path: v1beta/{+resource}:testIamPermissions

      Parameters:

        resource

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          Location: path

          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.

      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}/workstations/{workstationsId}:testIamPermissions

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: resource

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy

      Path: v1beta/{+resource}:getIamPolicy

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: resource

      Parameters:

        options.requestedPolicyVersion

          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

          Format: int32

        resource

          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.

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.patch

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Updates an existing Workstation.

      Parameter Order: name

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}

      Parameters:

        validateOnly

          Type: boolean

          Description: If set, validate the request and preview the review, but do not actually apply it.

          Location: query

        updateMask

          Description: Required. Mask specifying which fields in the config should be updated.

          Format: google-fieldmask

          Type: string

          Location: query

        allowMissing

          Type: boolean

          Description: If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.

          Location: query

        name

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          Required: Yes

          Type: string

          Description: Full name of this resource.

      HTTP Method: PATCH

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.stop

      Path: v1beta/{+name}:stop

      Description: Stops running a workstation, reducing costs.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:stop

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$

          Required: Yes

          Type: string

          Description: Required. Name of the workstation to stop.

          Location: path

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable

      Parameters:

        parent

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

          Description: Required. Parent resource name.

          Type: string

        pageSize

          Location: query

          Description: Maximum number of items to return.

          Format: int32

          Type: integer

        pageToken

          Type: string

          Description: next_page_token value returned from a previous List request, if any.

          Location: query

      HTTP Method: GET

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable

      Path: v1beta/{+parent}/workstations:listUsable

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission.

  • workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list

      Parameters:

        pageToken

          Description: next_page_token value returned from a previous List request, if any.

          Location: query

          Type: string

        parent

          Required: Yes

          Description: Required. Parent resource name.

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$

          Location: path

          Type: string

        pageSize

          Description: Maximum number of items to return.

          Location: query

          Format: int32

          Type: integer

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations

      Path: v1beta/{+parent}/workstations

      Description: Returns all Workstations using the specified config.

      Parameter Order: parent

  • workstations.projects.locations.workstationClusters.get

      Path: v1beta/{+name}

      HTTP Method: GET

      Parameters:

        name

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$

          Description: Required. Name of the requested resource.

          Type: string

      Description: Returns the requested WorkstationCluster.

      Parameter Order: name

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • workstations.projects.locations.workstationClusters.patch

      Parameter Order: name

      Path: v1beta/{+name}

      Description: Updates an existing WorkstationCluster.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}

      Parameters:

        updateMask

          Format: google-fieldmask

          Type: string

          Description: Required. Mask specifying which fields in the cluster should be updated.

          Location: query

        validateOnly

          Type: boolean

          Description: If set, validate the request and preview the review, but do not actually apply it.

          Location: query

        name

          Type: string

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$

          Description: Full name of this resource.

        allowMissing

          Description: If set, and the cluster is not found, a new cluster will be created. In this situation, update_mask is ignored.

          Type: boolean

          Location: query

      HTTP Method: PATCH

  • workstations.projects.locations.workstationClusters.list

      Description: Returns all WorkstationClusters in the specified location.

      Parameter Order: parent

      Parameters:

        parent

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Required: Yes

          Description: Required. Parent resource name.

          Type: string

        pageSize

          Format: int32

          Description: Maximum number of items to return.

          Type: integer

          Location: query

        pageToken

          Location: query

          Description: next_page_token value returned from a previous List request, if any.

          Type: string

      Path: v1beta/{+parent}/workstationClusters

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters

      HTTP Method: GET

  • workstations.projects.locations.workstationClusters.delete

      HTTP Method: DELETE

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}

      Description: Deletes the specified WorkstationCluster.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta/{+name}

      Parameter Order: name

      Parameters:

        name

          Type: string

          Location: path

          Description: Required. Name of the cluster to delete.

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$

        etag

          Description: If set, the request will be rejected if the latest version of the cluster on the server does not have this etag.

          Location: query

          Type: string

        validateOnly

          Location: query

          Description: If set, validate the request and preview the review, but do not actually apply it.

          Type: boolean

        force

          Type: boolean

          Location: query

          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.

  • workstations.projects.locations.workstationClusters.create

      Parameters:

        workstationClusterId

          Description: Required. ID to use for the cluster.

          Location: query

          Type: string

        validateOnly

          Type: boolean

          Location: query

          Description: If set, validate the request and preview the review, but do not actually apply it.

        parent

          Location: path

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Description: Required. Parent resource name.

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters

      Path: v1beta/{+parent}/workstationClusters

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Description: Creates a new WorkstationCluster.

  • workstations.projects.locations.operations.cancel

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameters:

        name

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Description: The name of the operation resource to be cancelled.

          Type: string

          Required: Yes

      Path: v1beta/{+name}:cancel

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method: POST

      Parameter Order: name

  • workstations.projects.locations.operations.get

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Type: string

          Description: The name of the operation resource.

          Required: Yes

          Location: path

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path: v1beta/{+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.

      Parameter Order: name

  • workstations.projects.locations.operations.delete

      Path: v1beta/{+name}

      Parameter Order: name

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

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required: Yes

          Location: path

          Type: string

          Description: The name of the operation resource to be deleted.

  • workstations.projects.locations.operations.list

      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

      Path: v1beta/{+name}/operations

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations

      Parameters:

        pageToken

          Description: The standard list page token.

          Type: string

          Location: query

        name

          Description: The name of the operation's parent resource.

          Required: Yes

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+$

        filter

          Location: query

          Type: string

          Description: The standard list filter.

        pageSize

          Description: The standard list page size.

          Type: integer

          Format: int32

          Location: query