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