File "ProjectsLocationsImportJobs.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/MigrationCenterAPI/Resource/ProjectsLocationsImportJobs.php
File size: 8.61 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\MigrationCenterAPI\Resource;
use Google\Service\MigrationCenterAPI\ImportJob;
use Google\Service\MigrationCenterAPI\ListImportJobsResponse;
use Google\Service\MigrationCenterAPI\Operation;
use Google\Service\MigrationCenterAPI\RunImportJobRequest;
use Google\Service\MigrationCenterAPI\ValidateImportJobRequest;
/**
* The "importJobs" collection of methods.
* Typical usage is:
* <code>
* $migrationcenterService = new Google\Service\MigrationCenterAPI(...);
* $importJobs = $migrationcenterService->projects_locations_importJobs;
* </code>
*/
class ProjectsLocationsImportJobs extends \Google\Service\Resource
{
/**
* Creates an import job. (importJobs.create)
*
* @param string $parent Required. Value for parent.
* @param ImportJob $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string importJobId Required. ID of the import job.
* @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
* @throws \Google\Service\Exception
*/
public function create($parent, ImportJob $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes an import job. (importJobs.delete)
*
* @param string $name Required. Name of the resource.
* @param array $optParams Optional parameters.
*
* @opt_param bool force Optional. If set to `true`, any `ImportDataFiles` of
* this job will also be deleted If set to `false`, the request only works if
* the job has no data files.
* @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
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Gets the details of an import job. (importJobs.get)
*
* @param string $name Required. Name of the resource.
* @param array $optParams Optional parameters.
*
* @opt_param string view Optional. The level of details of the import job.
* Default value is FULL.
* @return ImportJob
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ImportJob::class);
}
/**
* Lists all import jobs. (importJobs.listProjectsLocationsImportJobs)
*
* @param string $parent Required. Parent value for `ListImportJobsRequest`.
* @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.
* @opt_param string view Optional. The level of details of each import job.
* Default value is BASIC.
* @return ListImportJobsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsImportJobs($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListImportJobsResponse::class);
}
/**
* Updates an import job. (importJobs.patch)
*
* @param string $name Output only. The full name of the import job.
* @param ImportJob $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 `Asset` resource by the update. The values
* specified in the `update_mask` field 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
* @throws \Google\Service\Exception
*/
public function patch($name, ImportJob $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Runs an import job. (importJobs.run)
*
* @param string $name Required. The name of the import job to run.
* @param RunImportJobRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function run($name, RunImportJobRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('run', [$params], Operation::class);
}
/**
* Validates an import job. (importJobs.validate)
*
* @param string $name Required. The name of the import job to validate.
* @param ValidateImportJobRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function validate($name, ValidateImportJobRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('validate', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsImportJobs::class, 'Google_Service_MigrationCenterAPI_Resource_ProjectsLocationsImportJobs');