Method: projects.locations.federations.list

Stay organized with collections Save and categorize content based on your preferences.

Lists federations in a project and location.

HTTP request

GET https://metastore.googleapis.com/v1alpha/{parent}/federations

Path parameters

Parameters
parent

string

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{projectNumber}/locations/{locationId}.

Authorization requires the following IAM permission on the specified resource parent:

  • metastore.federations.list

Query parameters

Parameters
pageSize

integer

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.

pageToken

string

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

string

Optional. The filter to apply to list results.

orderBy

string

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for federations.list

JSON representation
{
  "federations": [
    {
      object (Federation)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
federations[]

object (Federation)

The services in the specified location.

nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

unreachable[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.