1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DataprocMetastore
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsFederations

ProjectsLocationsFederations

class ProjectsLocationsFederations extends Resource (View source)

The "federations" collection of methods.

Typical usage is:

 $metastoreService = new Google\Service\DataprocMetastore(...);
 $federations = $metastoreService->projects_locations_federations;

Methods

Operation
create(string $parent, Federation $postBody, array $optParams = [])

Creates a metastore federation in a project and location.

Operation
delete(string $name, array $optParams = [])

Deletes a single federation. (federations.delete)

Federation
get(string $name, array $optParams = [])

Gets the details of a single federation. (federations.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

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)

ListFederationsResponse
listProjectsLocationsFederations(string $parent, array $optParams = [])

Lists federations in a project and location.

Operation
patch(string $name, Federation $postBody, array $optParams = [])

Updates the fields of a federation. (federations.patch)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

at line 65
Operation create(string $parent, Federation $postBody, array $optParams = [])

Creates a metastore federation in a project and location.

(federations.create)

Parameters

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}.
Federation $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 91
Operation delete(string $name, array $optParams = [])

Deletes a single federation. (federations.delete)

Parameters

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}.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 107
Federation get(string $name, array $optParams = [])

Gets the details of a single federation. (federations.get)

Parameters

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}.
array $optParams

Optional parameters.

Return Value

Federation

Exceptions

Exception

at line 137
Policy getIamPolicy(string $resource, array $optParams = [])

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)

Parameters

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.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 169
ListFederationsResponse listProjectsLocationsFederations(string $parent, array $optParams = [])

Lists federations in a project and location.

(federations.listProjectsLocationsFederations)

Parameters

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}.
array $optParams

Optional parameters.

Return Value

ListFederationsResponse

Exceptions

Exception

at line 200
Operation patch(string $name, Federation $postBody, array $optParams = [])

Updates the fields of a federation. (federations.patch)

Parameters

string $name

Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{f ederation_id}`.
Federation $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 220
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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)

Parameters

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.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 243
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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)

Parameters

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.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception