Viewing file:  ProjectsLocationsNamespacesServices.php (9.35 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?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\ServiceDirectory\Resource;
use Google\Service\ServiceDirectory\GetIamPolicyRequest;
use Google\Service\ServiceDirectory\ListServicesResponse;
use Google\Service\ServiceDirectory\Policy;
use Google\Service\ServiceDirectory\ResolveServiceRequest;
use Google\Service\ServiceDirectory\ResolveServiceResponse;
use Google\Service\ServiceDirectory\Service;
use Google\Service\ServiceDirectory\ServicedirectoryEmpty;
use Google\Service\ServiceDirectory\SetIamPolicyRequest;
use Google\Service\ServiceDirectory\TestIamPermissionsRequest;
use Google\Service\ServiceDirectory\TestIamPermissionsResponse;
/**
* The "services" collection of methods.
* Typical usage is:
* <code>
* $servicedirectoryService = new Google\Service\ServiceDirectory(...);
* $services = $servicedirectoryService->projects_locations_namespaces_services;
* </code>
*/
class ProjectsLocationsNamespacesServices extends \Google\Service\Resource
{
/**
* Creates a service, and returns the new service. (services.create)
*
* @param string $parent Required. The resource name of the namespace this
* service will belong to.
* @param Service $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string serviceId Required. The Resource ID must be 1-63 characters
* long, and comply with RFC1035. Specifically, the name must be 1-63 characters
* long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`
* which means the first character must be a lowercase letter, and all following
* characters must be a dash, lowercase letter, or digit, except the last
* character, which cannot be a dash.
* @return Service
*/
public function create($parent, Service $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Service::class);
}
/**
* Deletes a service. This also deletes all endpoints associated with the
* service. (services.delete)
*
* @param string $name Required. The name of the service to delete.
* @param array $optParams Optional parameters.
* @return ServicedirectoryEmpty
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], ServicedirectoryEmpty::class);
}
/**
* Gets a service. (services.get)
*
* @param string $name Required. The name of the service to get.
* @param array $optParams Optional parameters.
* @return Service
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Service::class);
}
/**
* Gets the IAM Policy for a resource (namespace or service only).
* (services.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 GetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
*/
public function getIamPolicy($resource, GetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists all services belonging to a namespace.
* (services.listProjectsLocationsNamespacesServices)
*
* @param string $parent Required. The resource name of the namespace whose
* services you'd like to list.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional. The filter to list results by. General
* `filter` string syntax: ` ()` * `` can be `name` or `annotations.` for map
* field * `` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:` means
* `HAS`, and is roughly the same as `=` * `` must be the same data type as
* field * `` can be `AND`, `OR`, `NOT` Examples of valid filters: *
* `annotations.owner` returns services that have a annotation with the key
* `owner`, this is the same as `annotations:owner` *
* `annotations.protocol=gRPC` returns services that have key/value
* `protocol=gRPC` * `name>projects/my-project/locations/us-east1/namespaces/my-
* namespace/services/service-c` returns services that have name that is
* alphabetically later than the string, so "service-e" is returned but
* "service-a" is not * `annotations.owner!=sd AND annotations.foo=bar` returns
* services that have `owner` in annotation key but value is not `sd` AND have
* key/value `foo=bar` * `doesnotexist.foo=bar` returns an empty list. Note that
* service doesn't have a field called "doesnotexist". Since the filter does not
* match any services, it returns no results For more information about
* filtering, see [API Filtering](https://aip.dev/160).
* @opt_param string orderBy Optional. The order to list results by. General
* `order_by` string syntax: ` () (,)` * `` allows value: `name` * `` ascending
* or descending order by ``. If this is left blank, `asc` is used Note that an
* empty `order_by` string results in default order, which is order by `name` in
* ascending order.
* @opt_param int pageSize Optional. The maximum number of items to return.
* @opt_param string pageToken Optional. The next_page_token value returned from
* a previous List request, if any.
* @return ListServicesResponse
*/
public function listProjectsLocationsNamespacesServices($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListServicesResponse::class);
}
/**
* Updates a service. (services.patch)
*
* @param string $name Immutable. The resource name for the service in the
* format `projects/locations/namespaces/services`.
* @param Service $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Required. List of fields to be updated in this
* request.
* @return Service
*/
public function patch($name, Service $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Service::class);
}
/**
* Returns a service and its associated endpoints. Resolving a service is not
* considered an active developer method. (services.resolve)
*
* @param string $name Required. The name of the service to resolve.
* @param ResolveServiceRequest $postBody
* @param array $optParams Optional parameters.
* @return ResolveServiceResponse
*/
public function resolve($name, ResolveServiceRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('resolve', [$params], ResolveServiceResponse::class);
}
/**
* Sets the IAM Policy for a resource (namespace or service only).
* (services.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
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Tests IAM permissions for a resource (namespace or service only).
* (services.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
*/
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(ProjectsLocationsNamespacesServices::class, 'Google_Service_ServiceDirectory_Resource_ProjectsLocationsNamespacesServices');
|