Viewing file:  ProjectsLocationsGroups.php (8.22 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\MigrationCenterAPI\Resource;
use Google\Service\MigrationCenterAPI\AddAssetsToGroupRequest;
use Google\Service\MigrationCenterAPI\Group;
use Google\Service\MigrationCenterAPI\ListGroupsResponse;
use Google\Service\MigrationCenterAPI\Operation;
use Google\Service\MigrationCenterAPI\RemoveAssetsFromGroupRequest;
/**
* The "groups" collection of methods.
* Typical usage is:
* <code>
* $migrationcenterService = new Google\Service\MigrationCenterAPI(...);
* $groups = $migrationcenterService->projects_locations_groups;
* </code>
*/
class ProjectsLocationsGroups extends \Google\Service\Resource
{
/**
* Adds assets to a group. (groups.addAssets)
*
* @param string $group Required. Group reference.
* @param AddAssetsToGroupRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
*/
public function addAssets($group, AddAssetsToGroupRequest $postBody, $optParams = [])
{
$params = ['group' => $group, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addAssets', [$params], Operation::class);
}
/**
* Creates a new group in a given project and location. (groups.create)
*
* @param string $parent Required. Value for parent.
* @param Group $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string groupId Required. User specified ID for the group. It will
* become the last component of the group name. The ID must be unique within the
* project, must conform with RFC-1034, is restricted to lower-cased letters,
* and has a maximum length of 63 characters. The ID must match the regular
* expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
* @opt_param string requestId Optional. An optional request ID to identify
* requests. Specify a unique request ID so that if you must retry your request,
* the server will know to ignore the request if it has already been completed.
* The server will guarantee that for at least 60 minutes since the first
* request. For example, consider a situation where you make an initial request
* and the request times out. If you make the request again with the same
* request ID, the server can check if original operation with the same request
* ID was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments. The request ID must
* be a valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @return Operation
*/
public function create($parent, Group $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a group. (groups.delete)
*
* @param string $name Required. Name of the group resource.
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. An optional request ID to identify
* requests. Specify a unique request ID so that if you must retry your request,
* the server will know to ignore the request if it has already been completed.
* The server will guarantee that for at least 60 minutes after the first
* request. For example, consider a situation where you make an initial request
* and the request times out. If you make the request again with the same
* request ID, the server can check if original operation with the same request
* ID was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments. The request ID must
* be a valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @return Operation
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Gets the details of a group. (groups.get)
*
* @param string $name Required. Name of the resource.
* @param array $optParams Optional parameters.
* @return Group
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Group::class);
}
/**
* Lists all groups in a given project and location.
* (groups.listProjectsLocationsGroups)
*
* @param string $parent Required. Parent value for `ListGroupsRequest`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Filtering results.
* @opt_param string orderBy Field to sort by. See
* https://google.aip.dev/132#ordering for more details.
* @opt_param int pageSize Requested page size. Server may return fewer items
* than requested. If unspecified, server will pick an appropriate default.
* @opt_param string pageToken A token identifying a page of results the server
* should return.
* @return ListGroupsResponse
*/
public function listProjectsLocationsGroups($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListGroupsResponse::class);
}
/**
* Updates the parameters of a group. (groups.patch)
*
* @param string $name Output only. The name of the group.
* @param Group $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. An optional request ID to identify
* requests. Specify a unique request ID so that if you must retry your request,
* the server will know to ignore the request if it has already been completed.
* The server will guarantee that for at least 60 minutes since the first
* request. For example, consider a situation where you make an initial request
* and the request times out. If you make the request again with the same
* request ID, the server can check if original operation with the same request
* ID was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments. The request ID must
* be a valid UUID with the exception that zero UUID is not supported
* (00000000-0000-0000-0000-000000000000).
* @opt_param string updateMask Required. Field mask is used to specify the
* fields to be overwritten in the `Group` resource by the update. The values
* specified in the `update_mask` are relative to the resource, not the full
* request. A field will be overwritten if it is in the mask. A single * value
* in the mask lets you to overwrite all fields.
* @return Operation
*/
public function patch($name, Group $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Removes assets from a group. (groups.removeAssets)
*
* @param string $group Required. Group reference.
* @param RemoveAssetsFromGroupRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
*/
public function removeAssets($group, RemoveAssetsFromGroupRequest $postBody, $optParams = [])
{
$params = ['group' => $group, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('removeAssets', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsGroups::class, 'Google_Service_MigrationCenterAPI_Resource_ProjectsLocationsGroups');
|