Package google.cloud.location

אינדקס

• ‫Locations (ממשק)
• ‫GetLocationRequest (הודעה)
• ‫ListLocationsRequest (הודעה)
• ‫ListLocationsResponse (הודעה)
• ‫Location (הודעה)

מיקומים

ממשק מופשט שמספק מידע שקשור למיקום עבור שירות. מטא-נתונים שספציפיים לשירות מסופקים דרך השדה Location.metadata.

GetLocation
rpc GetLocation(GetLocationRequest) returns (Location) קבלת מידע על מיקום. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/notebooks ניתן למצוא מידע נוסף כאן: Authentication Overview.

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse) רשימת המיקומים הנתמכים בשירות הזה. השיטה הזו מציגה רשימה של מיקומים על סמך היקף המשאבים שצוין בשדה ListLocationsRequest.name: ‫Global locations: אם name ריק, השיטה מציגה את המיקומים הציבוריים שזמינים לכל הפרויקטים. מיקומים ספציפיים לפרויקט: אם name הוא בפורמט projects/{project}, הפונקציה מציגה רשימה של מיקומים שגלויים לפרויקט הספציפי הזה. המיקומים האלה כוללים מיקומים ציבוריים, פרטיים או מיקומים אחרים שספציפיים לפרויקט והופעלו עבור הפרויקט. בהטמעות של gRPC וספריית הלקוח, שם המשאב מועבר כשדה name. במקרה של קריאות ישירות לשירות, שם המשאב משולב בנתיב הבקשה בהתאם להטמעה ולגרסה הספציפיות של השירות. היקפי הרשאות נדרש אחד מהיקפי ההרשאות הבאים של OAuth: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/notebooks ניתן למצוא מידע נוסף כאן: Authentication Overview.

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 בתגובה. שולחים את טוקן הדף כדי לקבל את הדף הבא.
extra_location_types[]	string זה שינוי אופציונלי. אין להשתמש בשדה הזה אלא אם צוין אחרת במפורש במסמכים. השימוש הזה מיועד בעיקר לשימוש פנימי.

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 מטא-נתונים ספציפיים לשירות. לדוגמה, הקיבולת הזמינה במיקום מסוים.