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