class ProjectsLocationsWorkstationClustersWorkstationConfigs extends Resource (View source)

The "workstationConfigs" collection of methods.

Typical usage is:

 $workstationsService = new Google\Service\CloudWorkstations(...);
 $workstationConfigs = $workstationsService->projects_locations_workstationClusters_workstationConfigs;

Methods

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

Creates a new workstation configuration. (workstationConfigs.create)

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

Deletes the specified workstation configuration. (workstationConfigs.delete)

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

Returns the requested workstation configuration. (workstationConfigs.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.

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

Returns all workstation configurations in the specified cluster. (workstation Configs.listProjectsLocationsWorkstationClustersWorkstationConfigs)

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

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

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

Updates an existing workstation configuration. (workstationConfigs.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. (workstationConfigs.setIamPolicy)

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, WorkstationConfig $postBody, array $optParams = [])

Creates a new workstation configuration. (workstationConfigs.create)

Parameters

string $parent

Required. Parent resource name.

WorkstationConfig $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes the specified workstation configuration. (workstationConfigs.delete)

Parameters

string $name

Required. Name of the workstation configuration to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Returns the requested workstation configuration. (workstationConfigs.get)

Parameters

string $name

Required. Name of the requested resource.

array $optParams

Optional parameters.

Return Value

WorkstationConfig

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.

(workstationConfigs.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

ListWorkstationConfigsResponse listProjectsLocationsWorkstationClustersWorkstationConfigs(string $parent, array $optParams = [])

Returns all workstation configurations in the specified cluster. (workstation Configs.listProjectsLocationsWorkstationClustersWorkstationConfigs)

Parameters

string $parent

Required. Parent resource name.

array $optParams

Optional parameters.

Return Value

ListWorkstationConfigsResponse

Exceptions

Exception

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

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

(workstationConfigs.listUsable)

Parameters

string $parent

Required. Parent resource name.

array $optParams

Optional parameters.

Return Value

ListUsableWorkstationConfigsResponse

Exceptions

Exception

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

Updates an existing workstation configuration. (workstationConfigs.patch)

Parameters

string $name

Identifier. Full name of this workstation configuration.

WorkstationConfig $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. (workstationConfigs.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

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. (workstationConfigs.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