📄 Source: ProjectsLocationsParameters.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\ParameterManager\Resource;
use Google\Service\ParameterManager\ListParametersResponse;
use Google\Service\ParameterManager\Parameter;
use Google\Service\ParameterManager\ParametermanagerEmpty;
/**
* The "parameters" collection of methods.
* Typical usage is:
* <code>
* $parametermanagerService = new Google\Service\ParameterManager(...);
* $parameters = $parametermanagerService->projects_locations_parameters;
* </code>
*/
class ProjectsLocationsParameters extends \Google\Service\Resource
{
/**
* Creates a new Parameter in a given project and location. (parameters.create)
*
* @param string $parent Required. Value for parent in the format
* `projects/locations`.
* @param Parameter $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string parameterId Required. Id of the Parameter resource
* @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 Parameter
* @throws \Google\Service\Exception
*/
public function create($parent, Parameter $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Parameter::class);
}
/**
* Deletes a single Parameter. (parameters.delete)
*
* @param string $name Required. Name of the resource in the format
* `projects/locations/parameters`.
* @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 ParametermanagerEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], ParametermanagerEmpty::class);
}
/**
* Gets details of a single Parameter. (parameters.get)
*
* @param string $name Required. Name of the resource in the format
* `projects/locations/parameters`.
* @param array $optParams Optional parameters.
* @return Parameter
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Parameter::class);
}
/**
* Lists Parameters in a given project and location.
* (parameters.listProjectsLocationsParameters)
*
* @param string $parent Required. Parent value for ListParametersRequest in the
* format `projects/locations`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional. Filtering results
* @opt_param string orderBy Optional. Hint for how to order the results
* @opt_param int pageSize Optional. Requested page size. Server may return
* fewer items than requested. If unspecified, server will pick an appropriate
* default.
* @opt_param string pageToken Optional. A page token, received from a previous
* `ListParameters` call. Provide this to retrieve the subsequent page. When
* paginating, all other parameters provided to `ListParameters` must match the
* call that provided the page token.
* @return ListParametersResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsParameters($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListParametersResponse::class);
}
/**
* Updates a single Parameter. (parameters.patch)
*
* @param string $name Identifier. [Output only] The resource name of the
* Parameter in the format `projects/locations/parameters`.
* @param Parameter $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 Optional. Field mask is used to specify the
* fields to be overwritten in the Parameter resource by the update. The fields
* specified in the update_mask are relative to the resource, not the full
* request. A mutable field will be overwritten if it is in the mask. If the
* user does not provide a mask then all mutable fields present in the request
* will be overwritten.
* @return Parameter
* @throws \Google\Service\Exception
*/
public function patch($name, Parameter $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Parameter::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsParameters::class, 'Google_Service_ParameterManager_Resource_ProjectsLocationsParameters');
← Back