Package google.cloud.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

شناسه متعارف این مکان. به عنوان مثال: "us-east1" .

display_name

string

نام دوستانه برای این مکان، معمولاً نام شهر نزدیک است. به عنوان مثال، "توکیو".

labels

map<string, string>

ویژگی های خدمات متقابل برای مکان. مثلا

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

Any

فراداده مخصوص سرویس به عنوان مثال ظرفیت موجود در مکان معین.