Package google.cloud.location

索引

• Locations (介面)
• GetLocationRequest (訊息)
• ListLocationsRequest (訊息)
• ListLocationsResponse (訊息)
• Location (訊息)

位置

一種抽象介面，提供服務適用的位置相關資訊。服務專用的中繼資料是透過 Location.metadata 欄位提供。

GetLocation
rpc GetLocation(GetLocationRequest) returns (Location) 取得位置相關資訊。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳情請參閱驗證總覽一文。

ListLocations
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 服務專用的中繼資料，例如指定位置的可用容量。