File "ProjectsLocationsSources.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/VMMigrationService/Resource/ProjectsLocationsSources.php
File size: 10.45 KB
MIME-type: text/x-php
Charset: utf-8
<?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\VMMigrationService\Resource;
use Google\Service\VMMigrationService\FetchInventoryResponse;
use Google\Service\VMMigrationService\FetchStorageInventoryResponse;
use Google\Service\VMMigrationService\ListSourcesResponse;
use Google\Service\VMMigrationService\Operation;
use Google\Service\VMMigrationService\Source;
/**
* The "sources" collection of methods.
* Typical usage is:
* <code>
* $vmmigrationService = new Google\Service\VMMigrationService(...);
* $sources = $vmmigrationService->projects_locations_sources;
* </code>
*/
class ProjectsLocationsSources extends \Google\Service\Resource
{
/**
* Creates a new Source in a given project and location. (sources.create)
*
* @param string $parent Required. The Source's parent.
* @param Source $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId A 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 sourceId Required. The source identifier.
* @return Operation
* @throws \Google\Service\Exception
*/
public function create($parent, Source $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a single Source. (sources.delete)
*
* @param string $name Required. The Source name.
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. A 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
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* List remote source's inventory of VMs. The remote source is the onprem
* vCenter (remote in the sense it's not in Compute Engine). The inventory
* describes the list of existing VMs in that source. Note that this operation
* lists the VMs on the remote source, as opposed to listing the MigratingVms
* resources in the vmmigration service. (sources.fetchInventory)
*
* @param string $source Required. The name of the Source.
* @param array $optParams Optional parameters.
*
* @opt_param bool forceRefresh If this flag is set to true, the source will be
* queried instead of using cached results. Using this flag will make the call
* slower.
* @opt_param int pageSize The maximum number of VMs to return. The service may
* return fewer than this value. For AWS source: If unspecified, at most 500 VMs
* will be returned. The maximum value is 1000; values above 1000 will be
* coerced to 1000. For VMWare source: If unspecified, all VMs will be returned.
* There is no limit for maximum value.
* @opt_param string pageToken A page token, received from a previous
* `FetchInventory` call. Provide this to retrieve the subsequent page. When
* paginating, all other parameters provided to `FetchInventory` must match the
* call that provided the page token.
* @return FetchInventoryResponse
* @throws \Google\Service\Exception
*/
public function fetchInventory($source, $optParams = [])
{
$params = ['source' => $source];
$params = array_merge($params, $optParams);
return $this->call('fetchInventory', [$params], FetchInventoryResponse::class);
}
/**
* List remote source's inventory of storage resources. The remote source is
* another cloud vendor (e.g. AWS, Azure). The inventory describes the list of
* existing storage resources in that source. Note that this operation lists the
* resources on the remote source, as opposed to listing the MigratingVms
* resources in the vmmigration service. (sources.fetchStorageInventory)
*
* @param string $source Required. The name of the Source.
* @param array $optParams Optional parameters.
*
* @opt_param bool forceRefresh Optional. If this flag is set to true, the
* source will be queried instead of using cached results. Using this flag will
* make the call slower.
* @opt_param int pageSize Optional. The maximum number of VMs to return. The
* service may return fewer than this value.
* @opt_param string pageToken Optional. A page token, received from a previous
* `FetchStorageInventory` call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `FetchStorageInventory`
* must match the call that provided the page token.
* @opt_param string type Required. The type of the storage inventory to fetch.
* @return FetchStorageInventoryResponse
* @throws \Google\Service\Exception
*/
public function fetchStorageInventory($source, $optParams = [])
{
$params = ['source' => $source];
$params = array_merge($params, $optParams);
return $this->call('fetchStorageInventory', [$params], FetchStorageInventoryResponse::class);
}
/**
* Gets details of a single Source. (sources.get)
*
* @param string $name Required. The Source name.
* @param array $optParams Optional parameters.
* @return Source
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Source::class);
}
/**
* Lists Sources in a given project and location.
* (sources.listProjectsLocationsSources)
*
* @param string $parent Required. The parent, which owns this collection of
* sources.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional. The filter request.
* @opt_param string orderBy Optional. the order by fields for the result.
* @opt_param int pageSize Optional. The maximum number of sources to return.
* The service may return fewer than this value. If unspecified, at most 500
* sources will be returned. The maximum value is 1000; values above 1000 will
* be coerced to 1000.
* @opt_param string pageToken Required. A page token, received from a previous
* `ListSources` call. Provide this to retrieve the subsequent page. When
* paginating, all other parameters provided to `ListSources` must match the
* call that provided the page token.
* @return ListSourcesResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsSources($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListSourcesResponse::class);
}
/**
* Updates the parameters of a single Source. (sources.patch)
*
* @param string $name Output only. The Source name.
* @param Source $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId A 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 Field mask is used to specify the fields to be
* overwritten in the Source resource by the update. The fields 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. If the user does not provide a mask then
* all fields will be overwritten.
* @return Operation
* @throws \Google\Service\Exception
*/
public function patch($name, Source $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsSources::class, 'Google_Service_VMMigrationService_Resource_ProjectsLocationsSources');