REST Resource: projects.databases.collectionGroups.fields

משאב: שדה

מייצג שדה אחד במסד הנתונים.

השדות מקובצים לפי 'קבוצת אוספים' שמייצגת את כל האוספים במסד הנתונים שיש להם אותו מזהה.

ייצוג JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
שדות
name

string

חובה. שם שדה בטופס projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

נתיב של שדה יכול להיות שם של שדה פשוט, למשל address או נתיב לשדות בתוך mapValue , כמו address.city, או נתיב של שדה מיוחד. השדה המיוחד החוקי היחיד הוא *, שמייצג כל שדה.

אפשר לצטט נתיבי שדות באמצעות (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` וכן באמצעות תווי ASCII.

דוגמאות: (הערה: התגובות כאן נכתבות בתחביר של סימני קריאה, כך שיש שכבה נוספת של סימני הטעמה שמייצגים בלוק קוד) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, ולא אף שדה.

Field מיוחד מכיל את הגדרות ברירת המחדל להוספה לאינדקס עבור כל השדות. שם המשאב בשדה הזה הוא: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* האינדקסים שהוגדרו ב-Field הזה יוחלו על כל השדות שאין להם תצורה משלהם של Field של אינדקס.
indexConfig

object (IndexConfig)

תצורת האינדקס עבור השדה הזה. אם המדיניות לא מוגדרת, ההוספה של שדות לאינדקס תחזור למצב שבו הוגדרה ancestorField. כדי להסיר באופן מפורש את כל האינדקסים עבור השדה הזה, יש לציין הגדרת אינדקס עם רשימה ריקה של אינדקסים.
ttlConfig

object (TtlConfig)

הגדרות TTL בשביל Field הזה. הגדרה או ביטול של ההגדרה תפעיל או תשבית את TTL עבור מסמכים עם Field זה.

IndexConfig

תצורת האינדקס עבור השדה הזה.

ייצוג JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
שדות
indexes[]

object (Index)

האינדקסים הנתמכים עבור השדה הזה.
usesAncestorConfig

boolean

פלט בלבד. כאשר הערך הוא True, הגדרת האינדקס של Field נקבעת לפי ההגדרות שמצוינות ב-ancestorField. כשהערך הוא False, הגדרת האינדקס של Field מוגדרת באופן מפורש.
ancestorField

string

פלט בלבד. המדיניות מציינת את שם המשאב של Field שממנו מוגדרת תצורת האינדקס של השדה הזה (כאשר usesAncestorConfig מוגדרת כ-True), או שממנו יש להגדיר את המשאב אם לא הייתה הגדרת אינדקס בשדה הזה (כאשר usesAncestorConfig מוגדרת כ-False).
reverting

boolean

הפלט רק כאשר הערך הוא True, הגדרת האינדקס של Field נמצאת בתהליך החזרה לגרסה קודמת. בסיום, הגדרת האינדקס תעבור לאותו מצב כמו השדה שצוין על ידי ancestorField. בשלב הזה usesAncestorConfig יהיה true ו-reverting יהיה false.

TtlConfig

תצורת ה-TTL (זמן חיים) עבור מסמכים שבהם Field מוגדר.

אחסון של ערך חותמת זמן בשדה שתומך ב-TTL ייחשב כזמן התפוגה המוחלט של המסמך. ערכי חותמת הזמן בעבר מציינים שהמסמך עומד לפוג באופן מיידי. שימוש בסוגי נתונים אחרים או השארת השדה חסר יגרמו להשבתת התפוגה של המסמך הספציפי.

ייצוג JSON 
{
  "state": enum (State)
}
שדות
state

enum (State)

פלט בלבד. מצב התצורה של ה-TTL.

ארץ

מצב החלת תצורת ה-TTL על כל המסמכים.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED המדינה לא צוינה או לא ידועה.
CREATING המערכת מחילה את ה-TTL. יש פעולה פעילה ממושכת כדי לעקוב אחר השינוי. על מסמכים חדשים שנכתבו יוחלו ערכי TTL בהתאם לבקשה. ערכי ה-TTL המבוקשים על מסמכים קיימים עדיין נמצאים בעיבוד. לאחר עיבוד ה-TTL בכל המסמכים הקיימים, המצב יעבור למצב 'פעיל'.
ACTIVE ה-TTL פעיל עבור כל המסמכים.
NEEDS_REPAIR לא ניתן להפעיל את תצורת ה-TTL עבור כל המסמכים הקיימים. על מסמכים חדשים שנכתבו עדיין יחולו ה-TTL שלהם. ה-LRO הוחזר כאשר הניסיון האחרון להפעיל TTL עבור Field זה נכשל, וייתכן שיש לו פרטים נוספים.

שיטות

get

 מקבל את המטא-נתונים וההגדרות של שדה.

list

 פירוט ההגדרות והמטא-נתונים של השדות למסד הנתונים הזה.

patch

 מעדכן הגדרות של שדה.