Package google.cloud.location

Indeks

Lokasi

Antarmuka abstrak yang menyediakan informasi terkait lokasi untuk layanan. Metadata khusus layanan disediakan melalui kolom Location.metadata.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

Mendapatkan informasi tentang suatu lokasi.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Mencantumkan informasi tentang lokasi yang didukung untuk layanan ini.

Metode ini mencantumkan lokasi berdasarkan cakupan resource yang diberikan di kolom [ListLocationsRequest.name]:

  • Lokasi global: Jika name kosong, metode ini akan mencantumkan lokasi publik yang tersedia untuk semua project.
  • Lokasi khusus project: Jika name mengikuti format projects/{project}, metode ini akan mencantumkan lokasi yang terlihat oleh project tertentu tersebut. Hal ini mencakup lokasi publik, pribadi, atau lokasi khusus proyek lainnya yang diaktifkan untuk proyek.

Untuk penerapan gRPC dan library klien, nama resource diteruskan sebagai kolom name. Untuk panggilan layanan langsung, nama resource dimasukkan ke dalam jalur permintaan berdasarkan penerapan dan versi layanan tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

GetLocationRequest

Pesan permintaan untuk Locations.GetLocation.

Kolom
name

string

Nama resource untuk lokasi.

ListLocationsRequest

Pesan permintaan untuk Locations.ListLocations.

Kolom
name

string

Resource yang memiliki kumpulan lokasi, jika ada.
filter

string

Filter untuk mempersempit hasil ke subkumpulan pilihan. Bahasa pemfilteran menerima string seperti "displayName=tokyo", dan didokumentasikan secara lebih mendetail dalam AIP-160.
page_size

int32

Jumlah hasil maksimum yang akan ditampilkan. Jika tidak disetel, layanan akan memilih default.
page_token

string

Token halaman yang diterima dari kolom next_page_token dalam respons. Kirim token halaman tersebut untuk menerima halaman berikutnya.
extra_location_types[]

string

Opsional. Jangan gunakan kolom ini. Fitur ini tidak didukung dan diabaikan kecuali jika didokumentasikan secara eksplisit. Ini terutama untuk penggunaan internal.

ListLocationsResponse

Pesan respons untuk Locations.ListLocations.

Kolom
locations[]

Location

Daftar lokasi yang cocok dengan filter yang ditentukan dalam permintaan.
next_page_token

string

Daftar standar token halaman berikutnya.

Lokasi

Resource yang merepresentasikan lokasi Google Cloud.

Kolom
name

string

Nama resource untuk lokasi, yang dapat bervariasi di antara penerapan. Contoh: "projects/example-project/locations/us-east1"
location_id

string

ID kanonis untuk lokasi ini. Misalnya: "us-east1".
display_name

string

Nama yang mudah diingat untuk lokasi ini, biasanya nama kota terdekat. Misalnya, "Tokyo".
labels

map<string, string>

Atribut lintas layanan untuk lokasi. Contohnya

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

Any

Metadata khusus layanan. Misalnya, kapasitas yang tersedia di lokasi tertentu.