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