Method: googleapis.firestore.v1.projects.locations.list

Lists information about the supported locations for this service.

Arguments

Parameters
name

string

Required. The resource that owns the locations collection, if applicable.

filter

string

A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

pageSize

integer (int32 format)

The maximum number of results to return. If not set, the service selects a default.

pageToken

string

A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListLocationsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.firestore.v1.projects.locations.list
    args:
        name: ...
        filter: ...
        pageSize: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.firestore.v1.projects.locations.list",
      "args": {
        "name": "...",
        "filter": "...",
        "pageSize": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]