1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudWorkstations
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsWorkstationClusters

ProjectsLocationsWorkstationClusters

class ProjectsLocationsWorkstationClusters extends Resource (View source)

The "workstationClusters" collection of methods.

Typical usage is:

 $workstationsService = new Google\Service\CloudWorkstations(...);
 $workstationClusters = $workstationsService->projects_locations_workstationClusters;

Methods

Operation
create(string $parent, WorkstationCluster $postBody, array $optParams = [])

Creates a new workstation cluster. (workstationClusters.create)

Operation
delete(string $name, array $optParams = [])

Deletes the specified workstation cluster. (workstationClusters.delete)

WorkstationCluster
get(string $name, array $optParams = [])

Returns the requested workstation cluster. (workstationClusters.get)

ListWorkstationClustersResponse
listProjectsLocationsWorkstationClusters(string $parent, array $optParams = [])

Returns all workstation clusters in the specified location.

Operation
patch(string $name, WorkstationCluster $postBody, array $optParams = [])

Updates an existing workstation cluster. (workstationClusters.patch)

Details

at line 48
Operation create(string $parent, WorkstationCluster $postBody, array $optParams = [])

Creates a new workstation cluster. (workstationClusters.create)

Parameters

string $parent

Required. Parent resource name.
WorkstationCluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 72
Operation delete(string $name, array $optParams = [])

Deletes the specified workstation cluster. (workstationClusters.delete)

Parameters

string $name

Required. Name of the workstation cluster to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 86
WorkstationCluster get(string $name, array $optParams = [])

Returns the requested workstation cluster. (workstationClusters.get)

Parameters

string $name

Required. Name of the requested resource.
array $optParams

Optional parameters.

Return Value

WorkstationCluster

Exceptions

Exception

at line 105
ListWorkstationClustersResponse listProjectsLocationsWorkstationClusters(string $parent, array $optParams = [])

Returns all workstation clusters in the specified location.

(workstationClusters.listProjectsLocationsWorkstationClusters)

Parameters

string $parent

Required. Parent resource name.
array $optParams

Optional parameters.

Return Value

ListWorkstationClustersResponse

Exceptions

Exception

at line 128
Operation patch(string $name, WorkstationCluster $postBody, array $optParams = [])

Updates an existing workstation cluster. (workstationClusters.patch)

Parameters

string $name

Identifier. Full name of this workstation cluster.
WorkstationCluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception