class ProjectsLocationsWorkstationClustersWorkstationConfigsWorkstations extends Resource (View source)

The "workstations" collection of methods.

Typical usage is:

 $workstationsService = new Google\Service\CloudWorkstations(...);
 $workstations = $workstationsService->projects_locations_workstationClusters_workstationConfigs_workstations;

Methods

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

Creates a new workstation. (workstations.create)

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

Deletes the specified workstation. (workstations.delete)

generateAccessToken(string $workstation, GenerateAccessTokenRequest $postBody, array $optParams = [])

Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. (workstations.generateAccessToken)

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

Returns the requested workstation. (workstations.get)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (workstations.getIamPolicy)

listProjectsLocationsWorkstationClustersWorkstationConfigsWorkstations(string $parent, array $optParams = [])

Returns all Workstations using the specified workstation configuration. (work stations.listProjectsLocationsWorkstationClustersWorkstationConfigsWorkstatio ns)

listUsable(string $parent, array $optParams = [])

Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

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

Updates an existing workstation. (workstations.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (workstations.setIamPolicy)

start(string $name, StartWorkstationRequest $postBody, array $optParams = [])

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

stop(string $name, StopWorkstationRequest $postBody, array $optParams = [])

Stops running a workstation, reducing costs. (workstations.stop)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

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

Creates a new workstation. (workstations.create)

Parameters

string $parent

Required. Parent resource name.

Workstation $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes the specified workstation. (workstations.delete)

Parameters

string $name

Required. Name of the workstation to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

GenerateAccessTokenResponse generateAccessToken(string $workstation, GenerateAccessTokenRequest $postBody, array $optParams = [])

Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. (workstations.generateAccessToken)

Parameters

string $workstation

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

GenerateAccessTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GenerateAccessTokenResponse

Exceptions

Exception

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

Returns the requested workstation. (workstations.get)

Parameters

string $name

Required. Name of the requested resource.

array $optParams

Optional parameters.

Return Value

Workstation

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (workstations.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListWorkstationsResponse listProjectsLocationsWorkstationClustersWorkstationConfigsWorkstations(string $parent, array $optParams = [])

Returns all Workstations using the specified workstation configuration. (work stations.listProjectsLocationsWorkstationClustersWorkstationConfigsWorkstatio ns)

Parameters

string $parent

Required. Parent resource name.

array $optParams

Optional parameters.

Return Value

ListWorkstationsResponse

Exceptions

Exception

ListUsableWorkstationsResponse listUsable(string $parent, array $optParams = [])

Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

(workstations.listUsable)

Parameters

string $parent

Required. Parent resource name.

array $optParams

Optional parameters.

Return Value

ListUsableWorkstationsResponse

Exceptions

Exception

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

Updates an existing workstation. (workstations.patch)

Parameters

string $name

Identifier. Full name of this workstation.

Workstation $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (workstations.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Operation start(string $name, StartWorkstationRequest $postBody, array $optParams = [])

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

(workstations.start)

Parameters

string $name

Required. Name of the workstation to start.

StartWorkstationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation stop(string $name, StopWorkstationRequest $postBody, array $optParams = [])

Stops running a workstation, reducing costs. (workstations.stop)

Parameters

string $name

Required. Name of the workstation to stop.

StopWorkstationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception