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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมการตรวจสอบสิทธิ์
ListLocation

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 ในคำตอบ ส่งโทเค็นหน้าเว็บนั้นเพื่อรับหน้าถัดไป

การตอบกลับ ListLocations

ข้อความตอบกลับสำหรับ Locations.ListLocations

ช่อง
locations[]

Location

รายการสถานที่ตั้งที่ตรงกับตัวกรองที่ระบุไว้ในคำขอ
next_page_token

string

โทเค็นหน้าถัดไปของรายการมาตรฐาน

ตำแหน่ง

ทรัพยากรที่แสดงตำแหน่งของ Google Cloud

ช่อง
name

string

ชื่อทรัพยากรของตำแหน่ง ซึ่งอาจแตกต่างกันไปตามการติดตั้งใช้งาน เช่น "projects/example-project/locations/us-east1"
location_id

string

รหัส Canonical ของสถานที่นี้ เช่น "us-east1"
display_name

string

ชื่อที่เรียกง่ายๆ สำหรับสถานที่นี้ ซึ่งมักจะเป็นชื่อเมืองใกล้เคียง เช่น "โตเกียว"
labels

map<string, string>

แอตทริบิวต์แบบข้ามบริการสำหรับสถานที่ตั้ง ตัวอย่างเช่น

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

Any

ข้อมูลเมตาเฉพาะบริการ เช่น ความจุที่มีให้ใช้งานในสถานที่ที่ระบุ