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

詳細については、 「認証の概要」を参照してください。

GetLocationRequest

Locations.GetLocationのリクエスト メッセージ。

田畑
name

string

場所のリソース名。

ListLocationsRequest

Locations.ListLocationsのリクエスト メッセージ。

田畑
name

string

場所のコレクションを所有するリソース (該当する場合)。

filter

string

結果を優先サブセットに絞り込むためのフィルター。フィルタリング言語は"displayName=tokyo"のような文字列を受け入れます。詳しくはAIP-160に記載されています。

page_size

int32

返される結果の最大数。設定されていない場合、サービスはデフォルトを選択します。

page_token

string

応答のnext_page_tokenフィールドから受け取ったページ トークン。そのページ トークンを送信して、後続のページを受信します。

ListLocationsResponse

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

サービス固有のメタデータ。たとえば、特定の場所で利用可能な容量などです。