パッケージ google.cloud.location

目次

Locations

サービスの場所に関連する情報を提供する抽象インターフェース。サービス固有のメタデータは Location.metadata フィールドを通じて提供されます。

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

ロケーションに関する情報を取得します。

承認スコープ

次の OAuth スコープが必要です。

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

詳しくは、Auth ガイドをご覧ください。
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

このサービスでサポートされているロケーションに関する情報をリストします。

承認スコープ

次の OAuth スコープが必要です。

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

詳しくは、Auth ガイドをご覧ください。

GetLocationRequest

Locations.GetLocation に対するリクエスト メッセージ。

項目
name

string

場所のリソース名。

ListLocationsRequest

Locations.ListLocations に対するリクエスト メッセージ。

項目
name

string

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

filter

string

標準的なリストのフィルタ。

page_size

int32

標準的なリストのページサイズ。

page_token

string

標準的なリストのページトークン。

ListLocationsResponse

Locations.ListLocations に対するレスポンス メッセージ。

項目
locations[]

Location

リクエストで指定したフィルタに一致する場所のリスト。

next_page_token

string

標準的なリストの次ページのトークン。

Location

Google Cloud Platform の場所を表すリソース。

フィールド
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

サービス固有のメタデータ。たとえば、特定のロケーションで使用可能な容量などです。