get(name, x__xgafv=None)

Gets information about a location.

Args:
  name: string, Resource name for the location. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource that represents Google Cloud Platform location.
  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
    "a_key": "A String",
  },
  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
}

list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists information about the supported locations for this service.

Args:
  name: string, The resource that owns the locations collection, if applicable. (required)
  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](https://google.aip.dev/160).
  pageSize: integer, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Locations.ListLocations.
  "locations": [ # A list of locations that matches the specified filter in the request.
    { # A resource that represents Google Cloud Platform location.
      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
        "a_key": "A String",
      },
      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
    },
  ],
  "nextPageToken": "A String", # The standard List next-page token.
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

Eventarc API . projects . locations

Instance Methods

Method Details