Package google.cloud.location

Chỉ mục

Vị trí

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:

  • 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ề việc xác thực.
ListLocation (Vị trí danh sách)

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Liệt kê thông tin về các vị trí được hỗ trợ cho 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:

  • 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ề việc xác thực.

GetLocationRequest

Thông báo yêu cầu dành cho Locations.GetLocation.

Trường
name

string

Tên tài nguyên của vị trí.

ListLocationRequest

Thông báo yêu cầu dành 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

Một bộ lọc để thu hẹp kết quả đến một nhóm nhỏ ưu tiê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

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

Phản hồi ListLocationsLocation

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

Trường
locations[]

Location

Danh sách những 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 trang tiếp theo cho danh sách tiêu chuẩn.

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ã chính tắc cho vị trí này. Ví dụ: "us-east1".
display_name

string

Tên dễ nhớ của vị trí này, thường là tên thành phố lân cận. Ví dụ: "Tokyo".
labels

map<string, string>

Các thuộc tính dịch vụ chéo 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 một địa điểm cụ thể.