Package google.cloud.location

指数

地点

为服务提供位置相关信息的抽象接口。特定于服务的元数据通过Location.metadata字段提供。

获取位置

rpc GetLocation( GetLocationRequest ) returns ( Location )

获取有关位置的信息。

授权范围

需要以下 OAuth 范围之一:

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

有关详细信息,请参阅身份验证概述

列出位置

rpc ListLocations( ListLocationsRequest ) returns ( ListLocationsResponse )

列出有关此服务支持的位置的信息。

授权范围

需要以下 OAuth 范围之一:

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

有关详细信息,请参阅身份验证概述

获取位置请求

Locations.GetLocation的请求消息。

领域
name

string

位置的资源名称。

列出位置请求

Locations.ListLocations的请求消息。

领域
name

string

拥有位置集合的资源(如果适用)。

filter

string

用于将结果缩小到首选子集的过滤器。过滤语言接受类似"displayName=tokyo"的字符串,并在AIP-160中有更详细的记录。

page_size

int32

要返回的最大结果数。如果未设置,服务将选择默认值。

page_token

string

从响应中的next_page_token字段接收的页面令牌。发送该页面令牌以接收后续页面。

列出位置响应

Locations.ListLocations的响应消息。

领域
locations[]

Location

与请求中指定过滤器匹配的位置列表。

next_page_token

string

标准列表下一页标记。

地点

代表 Google Cloud 位置的资源。

领域
name

string

位置的资源名称,可能因实现而异。例如: "projects/example-project/locations/us-east1"

location_id

string

该位置的规范 ID。例如: "us-east1"

display_name

string

该位置的友好名称,通常是附近的城市名称。例如“东京”。

labels

map<string, string>

位置的跨服务属性。例如

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

Any

特定于服务的元数据。例如给定位置的可用容量。