📄 Source: ProjectsLocationsEvaluations.php
<?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\WorkloadManager\Resource;
use Google\Service\WorkloadManager\Evaluation;
use Google\Service\WorkloadManager\ListEvaluationsResponse;
use Google\Service\WorkloadManager\Operation;
/**
* The "evaluations" collection of methods.
* Typical usage is:
* <code>
* $workloadmanagerService = new Google\Service\WorkloadManager(...);
* $evaluations = $workloadmanagerService->projects_locations_evaluations;
* </code>
*/
class ProjectsLocationsEvaluations extends \Google\Service\Resource
{
/**
* Creates a new Evaluation in a given project and location.
* (evaluations.create)
*
* @param string $parent Required. The resource prefix of the evaluation
* location using the form: `projects/{project_id}/locations/{location_id}`.
* @param Evaluation $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string evaluationId Required. Id of the requesting object.
* @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, Evaluation $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a single Evaluation. (evaluations.delete)
*
* @param string $name Required. Name of the resource.
* @param array $optParams Optional parameters.
*
* @opt_param bool force Optional. Followed the best practice from
* https://aip.dev/135#cascading-delete.
* @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 details of a single Evaluation. (evaluations.get)
*
* @param string $name Required. Name of the resource.
* @param array $optParams Optional parameters.
* @return Evaluation
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Evaluation::class);
}
/**
* Lists Evaluations in a given project and location.
* (evaluations.listProjectsLocationsEvaluations)
*
* @param string $parent Required. Parent value for ListEvaluationsRequest.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Filter to be applied when listing the evaluation
* results.
* @opt_param string orderBy Hint for how to order the results.
* @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 ListEvaluationsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsEvaluations($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListEvaluationsResponse::class);
}
/**
* Updates the parameters of a single Evaluation. (evaluations.patch)
*
* @param string $name Name of resource that has the form
* `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.
* @param Evaluation $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 Evaluation 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.
* @return Operation
* @throws \Google\Service\Exception
*/
public function patch($name, Evaluation $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(ProjectsLocationsEvaluations::class, 'Google_Service_WorkloadManager_Resource_ProjectsLocationsEvaluations');
← Back