Package google.cloud.location

Chỉ mục

Địa điểm

Giao diện trừu tượng cung cấp thông tin liên quan đến vị trí của một dịch vụ. Siêu dữ liệu dành riêng cho dịch vụ được cung cấp thông qua trường Location.metadata.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

Nhận thông tin về một vị trí.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Liệt kê thông tin về các vị trí hỗ trợ dịch vụ này.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.

GetLocationRequest

Tin nhắn yêu cầu cho Locations.GetLocation.

Trường
name

string

Tên tài nguyên cho vị trí.

ListLocationsRequest

Tin nhắn yêu cầu cho Locations.ListLocations.

Trường
name

string

Tài nguyên sở hữu tập hợp vị trí, nếu có.

filter

string

Bộ lọc để thu hẹp kết quả và chỉ thu hẹp kết quả bạn mong muốn. Ngôn ngữ lọc chấp nhận các chuỗi như "displayName=tokyo" và được ghi lại chi tiết hơn trong AIP-160.

page_size

int32

Số lượng kết quả tối đa cần trả về. Nếu bạn không đặt chính sách này, dịch vụ sẽ chọn một chế độ mặc định.

page_token

string

Mã thông báo trang nhận được từ trường next_page_token trong phản hồi. Gửi mã thông báo trang đó để nhận trang tiếp theo.

ListLocationsResponse

Tin nhắn phản hồi cho Locations.ListLocations.

Trường
locations[]

Location

Danh sách vị trí khớp với bộ lọc đã chỉ định trong yêu cầu.

next_page_token

string

Mã thông báo tiêu chuẩn trên trang tiếp theo của Danh sách.

Vị trí

Tài nguyên đại diện cho một vị trí trên Google Cloud.

Trường
name

string

Tên tài nguyên cho vị trí, có thể khác nhau giữa các lần triển khai. Ví dụ: "projects/example-project/locations/us-east1"

location_id

string

Mã nhận dạng chính tắc của vị trí này. Ví dụ: "us-east1".

display_name

string

Tên thân thiện cho vị trí này, thường là tên thành phố lân cận. Ví dụ: "Tokyo".

labels

map<string, string>

Thuộc tính trên nhiều dịch vụ cho vị trí. Ví dụ

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

Any

Siêu dữ liệu dành riêng cho dịch vụ. Ví dụ: sức chứa hiện có tại vị trí đã cho.