File "ProjectsLocationsApis.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/ApigeeRegistry/Resource/ProjectsLocationsApis.php
File size: 9.21 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\ApigeeRegistry\Resource;
use Google\Service\ApigeeRegistry\Api;
use Google\Service\ApigeeRegistry\ApigeeregistryEmpty;
use Google\Service\ApigeeRegistry\ListApisResponse;
use Google\Service\ApigeeRegistry\Policy;
use Google\Service\ApigeeRegistry\SetIamPolicyRequest;
use Google\Service\ApigeeRegistry\TestIamPermissionsRequest;
use Google\Service\ApigeeRegistry\TestIamPermissionsResponse;
/**
* The "apis" collection of methods.
* Typical usage is:
* <code>
* $apigeeregistryService = new Google\Service\ApigeeRegistry(...);
* $apis = $apigeeregistryService->projects_locations_apis;
* </code>
*/
class ProjectsLocationsApis extends \Google\Service\Resource
{
/**
* Creates a specified API. (apis.create)
*
* @param string $parent Required. The parent, which owns this collection of
* APIs. Format: `projects/locations`
* @param Api $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string apiId Required. The ID to use for the API, which will
* become the final component of the API's resource name. This value should be
* 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must
* not have the form of a UUID.
* @return Api
* @throws \Google\Service\Exception
*/
public function create($parent, Api $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Api::class);
}
/**
* Removes a specified API and all of the resources that it owns. (apis.delete)
*
* @param string $name Required. The name of the API to delete. Format:
* `projects/locations/apis`
* @param array $optParams Optional parameters.
*
* @opt_param bool force If set to true, any child resources will also be
* deleted. (Otherwise, the request will only work if there are no child
* resources.)
* @return ApigeeregistryEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], ApigeeregistryEmpty::class);
}
/**
* Returns a specified API. (apis.get)
*
* @param string $name Required. The name of the API to retrieve. Format:
* `projects/locations/apis`
* @param array $optParams Optional parameters.
* @return Api
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Api::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (apis.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Returns matching APIs. (apis.listProjectsLocationsApis)
*
* @param string $parent Required. The parent, which owns this collection of
* APIs. Format: `projects/locations`
* @param array $optParams Optional parameters.
*
* @opt_param string filter An expression that can be used to filter the list.
* Filters use the Common Expression Language and can refer to all message
* fields.
* @opt_param string orderBy A comma-separated list of fields, e.g. "foo,bar"
* Fields can be sorted in descending order using the "desc" identifier, e.g.
* "foo desc,bar"
* @opt_param int pageSize The maximum number of APIs to return. The service may
* return fewer than this value. If unspecified, at most 50 values will be
* returned. The maximum is 1000; values above 1000 will be coerced to 1000.
* @opt_param string pageToken A page token, received from a previous `ListApis`
* call. Provide this to retrieve the subsequent page. When paginating, all
* other parameters provided to `ListApis` must match the call that provided the
* page token.
* @return ListApisResponse
* @throws \Google\Service\Exception
*/
public function listProjectsLocationsApis($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListApisResponse::class);
}
/**
* Used to modify a specified API. (apis.patch)
*
* @param string $name Resource name.
* @param Api $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool allowMissing If set to true, and the API is not found, a new
* API will be created. In this situation, `update_mask` is ignored.
* @opt_param string updateMask The list of fields to be updated. If omitted,
* all fields are updated that are set in the request message (fields set to
* default values are ignored). If an asterisk "*" is specified, all fields are
* updated, including fields that are unspecified/default in the request.
* @return Api
* @throws \Google\Service\Exception
*/
public function patch($name, Api $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Api::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (apis.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of permissions, not a
* `NOT_FOUND` error. Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization checking.
* This operation may "fail open" without warning. (apis.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsApis::class, 'Google_Service_ApigeeRegistry_Resource_ProjectsLocationsApis');