Package google.cloud.location

インデックス

ロケーション

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

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

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

認可スコープ

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

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

詳細については、Authentication Overview をご覧ください。
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

このサービスでサポートされているロケーションに関する情報をリストします。このメソッドは次の 2 つの方法で呼び出すことができます。

  • すべての公開ロケーションを一覧表示する: パス GET /v1/locations を使用します。
  • プロジェクトで表示可能なロケーションを一覧表示する: パス GET /v1/projects/{project_id}/locations を使用します。これには、一般公開のロケーションだけでなく、プロジェクトに固有の非公開のロケーションやその他のロケーションも含まれます。
認可スコープ

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

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

詳細については、Authentication Overview をご覧ください。

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 フィールドから受け取ったページトークン。そのページトークンを送信して、後続のページを受け取ります。
extra_location_types[]

string

省略可。この項目は使用しないでください。明示的に記載されていない限り、これはサポート対象外であり、無視されます。これは主に内部で使用されます。

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

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