Viewing file:  ProjectsLocationsWorkstationClustersWorkstationConfigs.php (9.58 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\CloudWorkstations\Resource;
use Google\Service\CloudWorkstations\ListUsableWorkstationConfigsResponse;
use Google\Service\CloudWorkstations\ListWorkstationConfigsResponse;
use Google\Service\CloudWorkstations\Operation;
use Google\Service\CloudWorkstations\Policy;
use Google\Service\CloudWorkstations\SetIamPolicyRequest;
use Google\Service\CloudWorkstations\TestIamPermissionsRequest;
use Google\Service\CloudWorkstations\TestIamPermissionsResponse;
use Google\Service\CloudWorkstations\WorkstationConfig;
/**
* The "workstationConfigs" collection of methods.
* Typical usage is:
* <code>
* $workstationsService = new Google\Service\CloudWorkstations(...);
* $workstationConfigs = $workstationsService->projects_locations_workstationClusters_workstationConfigs;
* </code>
*/
class ProjectsLocationsWorkstationClustersWorkstationConfigs extends \Google\Service\Resource
{
/**
* Creates a new workstation configuration. (workstationConfigs.create)
*
* @param string $parent Required. Parent resource name.
* @param WorkstationConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool validateOnly If set, validate the request and preview the
* review, but do not actually apply it.
* @opt_param string workstationConfigId Required. ID to use for the config.
* @return Operation
*/
public function create($parent, WorkstationConfig $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes the specified workstation configuration. (workstationConfigs.delete)
*
* @param string $name Required. Name of the config to delete.
* @param array $optParams Optional parameters.
*
* @opt_param string etag If set, the request will be rejected if the latest
* version of the config on the server does not have this etag.
* @opt_param bool force If set, any Workstations in the config will also be
* deleted. Otherwise, the request will work only if the config has no
* workstations.
* @opt_param bool validateOnly If set, validate the request and preview the
* review, but do not actually apply it.
* @return Operation
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Returns the requested workstation configuration. (workstationConfigs.get)
*
* @param string $name Required. Name of the requested resource.
* @param array $optParams Optional parameters.
* @return WorkstationConfig
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], WorkstationConfig::class);
}
/**
* 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)
*
* @param string $resource 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.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion 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).
* @return Policy
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Returns all workstation configurations in the specified cluster. (workstation
* Configs.listProjectsLocationsWorkstationClustersWorkstationConfigs)
*
* @param string $parent Required. Parent resource name.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Maximum number of items to return.
* @opt_param string pageToken next_page_token value returned from a previous
* List request, if any.
* @return ListWorkstationConfigsResponse
*/
public function listProjectsLocationsWorkstationClustersWorkstationConfigs($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListWorkstationConfigsResponse::class);
}
/**
* Returns all workstation configurations in the specified cluster on which the
* caller has the "workstations.workstation.create" permission.
* (workstationConfigs.listUsable)
*
* @param string $parent Required. Parent resource name.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Maximum number of items to return.
* @opt_param string pageToken next_page_token value returned from a previous
* List request, if any.
* @return ListUsableWorkstationConfigsResponse
*/
public function listUsable($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('listUsable', [$params], ListUsableWorkstationConfigsResponse::class);
}
/**
* Updates an existing workstation configuration. (workstationConfigs.patch)
*
* @param string $name Full name of this resource.
* @param WorkstationConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool allowMissing If set, and the config is not found, a new
* config will be created. In this situation, update_mask is ignored.
* @opt_param string updateMask Required. Mask specifying which fields in the
* config should be updated.
* @opt_param bool validateOnly If set, validate the request and preview the
* review, but do not actually apply it.
* @return Operation
*/
public function patch($name, WorkstationConfig $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* 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)
*
* @param string $resource 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.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* 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)
*
* @param string $resource 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.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsWorkstationClustersWorkstationConfigs::class, 'Google_Service_CloudWorkstations_Resource_ProjectsLocationsWorkstationClustersWorkstationConfigs');
|