Viewing file:  ProjectsLocationsFederations.php (11.47 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\DataprocMetastore\Resource;
use Google\Service\DataprocMetastore\Federation;
use Google\Service\DataprocMetastore\ListFederationsResponse;
use Google\Service\DataprocMetastore\Operation;
use Google\Service\DataprocMetastore\Policy;
use Google\Service\DataprocMetastore\SetIamPolicyRequest;
use Google\Service\DataprocMetastore\TestIamPermissionsRequest;
use Google\Service\DataprocMetastore\TestIamPermissionsResponse;
/**
* The "federations" collection of methods.
* Typical usage is:
* <code>
* $metastoreService = new Google\Service\DataprocMetastore(...);
* $federations = $metastoreService->projects_locations_federations;
* </code>
*/
class ProjectsLocationsFederations extends \Google\Service\Resource
{
/**
* Creates a metastore federation in a project and location.
* (federations.create)
*
* @param string $parent Required. The relative resource name of the location in
* which to create a federation service, in the following
* form:projects/{project_number}/locations/{location_id}.
* @param Federation $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string federationId Required. The ID of the metastore federation,
* which is used as the final component of the metastore federation's name.This
* value must be between 2 and 63 characters long inclusive, begin with a
* letter, end with a letter or number, and consist of alpha-numeric ASCII
* characters or hyphens.
* @opt_param string requestId Optional. A request ID. Specify a unique request
* ID to allow the server to ignore the request if it has completed. The server
* will ignore subsequent requests that provide a duplicate request ID for at
* least 60 minutes after the first request.For example, if an initial request
* times out, followed by another request with the same request ID, the server
* ignores the second request to prevent the creation of duplicate
* commitments.The request ID must be a valid UUID
* (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero
* UUID (00000000-0000-0000-0000-000000000000) is not supported.
* @return Operation
*/
public function create($parent, Federation $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Operation::class);
}
/**
* Deletes a single federation. (federations.delete)
*
* @param string $name Required. The relative resource name of the metastore
* federation to delete, in the following form:projects/{project_number}/locatio
* ns/{location_id}/federations/{federation_id}.
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. A request ID. Specify a unique request
* ID to allow the server to ignore the request if it has completed. The server
* will ignore subsequent requests that provide a duplicate request ID for at
* least 60 minutes after the first request.For example, if an initial request
* times out, followed by another request with the same request ID, the server
* ignores the second request to prevent the creation of duplicate
* commitments.The request ID must be a valid UUID
* (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero
* UUID (00000000-0000-0000-0000-000000000000) is not supported.
* @return Operation
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Gets the details of a single federation. (federations.get)
*
* @param string $name Required. The relative resource name of the metastore
* federation to retrieve, in the following form:projects/{project_number}/locat
* ions/{location_id}/federations/{federation_id}.
* @param array $optParams Optional parameters.
* @return Federation
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Federation::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (federations.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
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists federations in a project and location.
* (federations.listProjectsLocationsFederations)
*
* @param string $parent Required. The relative resource name of the location of
* metastore federations to list, in the following form:
* projects/{project_number}/locations/{location_id}.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Optional. The filter to apply to list results.
* @opt_param string orderBy Optional. Specify the ordering of results as
* described in Sorting Order
* (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not
* specified, the results will be sorted in the default order.
* @opt_param int pageSize Optional. The maximum number of federations to
* return. The response may contain less than the maximum number. If
* unspecified, no more than 500 services are returned. The maximum value is
* 1000; values above 1000 are changed to 1000.
* @opt_param string pageToken Optional. A page token, received from a previous
* ListFederationServices call. Provide this token to retrieve the subsequent
* page.To retrieve the first page, supply an empty page token.When paginating,
* other parameters provided to ListFederationServices must match the call that
* provided the page token.
* @return ListFederationsResponse
*/
public function listProjectsLocationsFederations($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListFederationsResponse::class);
}
/**
* Updates the fields of a federation. (federations.patch)
*
* @param string $name Immutable. The relative resource name of the federation,
* of the form: projects/{project_number}/locations/{location_id}/federations/{f
* ederation_id}`.
* @param Federation $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string requestId Optional. A request ID. Specify a unique request
* ID to allow the server to ignore the request if it has completed. The server
* will ignore subsequent requests that provide a duplicate request ID for at
* least 60 minutes after the first request.For example, if an initial request
* times out, followed by another request with the same request ID, the server
* ignores the second request to prevent the creation of duplicate
* commitments.The request ID must be a valid UUID
* (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero
* UUID (00000000-0000-0000-0000-000000000000) is not supported.
* @opt_param string updateMask Required. A field mask used to specify the
* fields to be overwritten in the metastore federation resource by the update.
* Fields specified in the update_mask are relative to the resource (not to the
* full request). A field is overwritten if it is in the mask.
* @return Operation
*/
public function patch($name, Federation $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Operation::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
* errors. (federations.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);
}
/**
* 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.
* (federations.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(ProjectsLocationsFederations::class, 'Google_Service_DataprocMetastore_Resource_ProjectsLocationsFederations');
|