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

מטא-נתונים שספציפיים לשירות. לדוגמה, הקיבולת הזמינה במיקום הנתון.