REST Resource: projects.locations

Resource: Location

A resource that represents a Google Cloud location.

JSON representation
{
  "name": string,
  "locationId": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  }
}
Fields
name

string

Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

locationId

string

The canonical id for this location. For example: "us-east1".

displayName

string

The friendly name for this location, typically a nearby city name. For example, "Tokyo".

labels

map (key: string, value: string)

Cross-service attributes for the location. For example

{"cloud.googleapis.com/region": "us-east1"}

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

metadata

object

Service-specific metadata. For example the available capacity at the given location.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Methods

checkOnboardingStatus

CheckOnboardingStatus reports the onboarding status for a project, folder, or organization.

fetchEffectiveSettings

FetchEffectiveSettings returns the effective PAM Settings for the given project, folder, or organization.

get

Gets information about a location.

getSettings

GetSettings returns the PAM Settings for the given project, folder, or organization.

list

Lists information about the supported locations for this service.

updateSettings

UpdateSettings updates the PAM Settings resource specified in the request.