2022-06-22
▼ ▲ metastore.projects.locations.federations.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+parent}/federations
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: 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}.
federationId
Location: query
Description: 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.
Type: string
requestId
Location: query
Type: string
Description: 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.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/federations
Parameter Order: parent
HTTP Method: POST
Description: Creates a metastore federation in a project and location.
▼ ▲ metastore.projects.locations.federations.delete
HTTP Method: DELETE
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$
Type: string
Required: Yes
Description: Required. The relative resource name of the metastore federation to delete, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.
requestId
Location: query
Description: 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.
Type: string
Path: v1beta/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single federation.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}
▼ ▲ metastore.projects.locations.federations.list
Parameters:
parent
Description: Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
pageSize
Location: query
Format: int32
Type: integer
Description: 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.
filter
Description: Optional. The filter to apply to list results.
Type: string
Location: query
pageToken
Location: query
Type: string
Description: 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.
orderBy
Location: query
Type: string
Description: 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.
Description: Lists federations in a project and location.
HTTP Method: GET
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/federations
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+parent}/federations
Parameter Order: parent
▼ ▲ metastore.projects.locations.federations.get
HTTP Method: GET
Description: Gets the details of a single federation.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta/{+name}
Parameters:
name
Location: path
Type: string
Description: Required. The relative resource name of the metastore federation to retrieve, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$
▼ ▲ metastore.projects.locations.federations.patch
Parameters:
name
Type: string
Description: Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/federations/[^/]+$
Location: path
Required: Yes
requestId
Type: string
Description: 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.
Location: query
updateMask
Description: 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.
Format: google-fieldmask
Type: string
Location: query
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}
Path: v1beta/{+name}
Parameter Order: name
Description: Updates the fields of a federation.
HTTP Method: PATCH