REST Resource: customers.policySchemas

{
  "name": string,
  "policyDescription": string,
  "additionalTargetKeyNames": [
    {
      object (AdditionalTargetKeyName)
    }
  ],
  "definition": {
    object (FileDescriptorProto)
  },
  "fieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "accessRestrictions": [
    string
  ],
  "notices": [
    {
      object (PolicySchemaNoticeDescription)
    }
  ],
  "supportUri": string,
  "schemaName": string,
  "validTargetResources": [
    enum (TargetResource)
  ],
  "policyApiLifecycle": {
    object (PolicyApiLifecycle)
  },
  "categoryTitle": string,
  "supportedPlatforms": [
    enum (Platform)
  ]
}

string

פורמט: name=customers/{customer}/policySchemas/{schema_namespace}

string

פלט בלבד. תיאור של סכימת המדיניות לצריכת משתמשים.

object (AdditionalTargetKeyName)

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

object (FileDescriptorProto)

הגדרת סכימה באמצעות מתאר פרוטו.

object (PolicySchemaFieldDescription)

פלט בלבד. תיאור מפורט של כל שדה שנכלל בסכימה. המערכת מציעה שדות לפי הסדר ברשימה הזו ולא לפי מספר השדה.

string

פלט בלבד. הגבלות גישה ספציפיות שקשורות למדיניות הזו.

object (PolicySchemaNoticeDescription)

פלט בלבד. הודעות מיוחדות הקשורות להגדרת ערכים מסוימים בשדות מסוימים בסכימה.

string

פלט בלבד. URI למאמר תמיכה שקשור לסכימה הזו.

string

פלט בלבד. השם המוגדר במלואו של סכימת המדיניות. הערך הזה משמש למילוי השדה policySchema ב-PolicyValue כשקוראים לפונקציה BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies או BatchDeleteGroupPolicies.

enum (TargetResource)

פלט בלבד. מידע על משאבי היעד הרלוונטיים למדיניות.

object (PolicyApiLifecycle)

פלט בלבד. מידע על מחזור החיים הנוכחי.

string

שם הקטגוריה שאליה משויכת ההגדרה.

enum (Platform)

פלט בלבד. הרשימה מציינת שהמדיניות תחול רק על מכשירים/משתמשים בפלטפורמות האלה.

{
  "key": string,
  "keyDescription": string
}

string

שם מפתח.

string

תיאור מפתח.

{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}

string

שם קובץ, ביחס לשורש של עץ המקור

string

לדוגמה 'foo', 'foo.bar' וכו'.

object (DescriptorProto)

כל ההגדרות ברמה העליונה בקובץ הזה.

object (EnumDescriptorProto)

string

התחביר של קובץ ה-proto. הערכים הנתמכים הם "proto2", "proto3" ו-"editions".

אם edition קיים, הערך הזה צריך להיות 'מהדורות'.

{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}

string

object (FieldDescriptorProto)

object (DescriptorProto)

object (EnumDescriptorProto)

object (OneofDescriptorProto)

{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}

string

integer

enum (Label)

enum (Type)

אם השדה typeName מוגדר, אין צורך להגדיר אותו. אם גם זה וגם typeName מוגדרים, הערך צריך להיות אחד מהערכים TYPE_ENUM, TYPE_MESSAGE או TYPE_GROUP.

string

כשמדובר בהודעות ובטיפוסים 'טיפוסים בני מנייה (enum)', זה שם הסוג. אם השם מתחיל בתו '.', פירוש הדבר הוא שהוא כשיר לחלוטין. אחרת, נעשה שימוש בכללי היקף דמויי C++ כדי למצוא את הסוג (כלומר, קודם מחפשים את הסוגים המקוננים בהודעה הזו, ואז בתוך ההורה, עד למרחב השמות הבסיסי).

string

בסוגים מספריים, הערך מכיל את הייצוג המקורי של הטקסט. למטבעות בוליאניים, "true" או 'false'. במחרוזות, מכיל את תוכן הטקסט שמוגדר כברירת מחדל (בלי לסמן בתו בריחה (escape) בשום צורה). לבייטים, מכיל את הערך C, שסומן בתו בריחה (escape). כל הבייטים שגדולים מ-128 מסומנים בתווי בריחה (escape).

integer

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

string

השם של קובץ JSON של השדה הזה. הערך נקבע על ידי מהדר הפרוטוקולים. אם המשתמש הגדיר קובץ JSONName בשדה הזה, המערכת תשתמש בערך של האפשרות הזו. אחרת, היא נגזרת משם השדה על ידי המרתו לקאמלקאסל.

boolean

אם True, מדובר ב-proto3 'אופציונלי'. כששדה proto3 הוא אופציונלי, הוא עוקב אחר הנוכחות ללא קשר לסוג השדה.

כאשר הערך של הפרמטר proto3Optional הוא True, השדה הזה חייב להשתייך לאחד מהבאים כדי לאותת ללקוחות proto3 ישנים שמבוצעת מעקב אחרי הנוכחות בשדה הזה. האחד הזה נקרא "סינתטי" אחד, והשדה הזה חייב להיות החבר היחיד שלו (כל שדה אופציונלי ב-proto3 מקבל שדה סינתטי משלו). מאפיינים סינתטיים קיימים במתאר בלבד והם לא יוצרים API כלשהו. יש להזמין נכסים סינתטיים אחרי הוספה של כל הפריטים ה"אמיתיים" אחת או יותר.

בשדות של הודעות, הפרמטר proto3Optional לא יוצר שינוי סמנטי, כי שדות של הודעות שאינם חוזרים תמיד עוקבים אחרי הנוכחות. עם זאת, עדיין מצוין הפרטים הסמנטיים אם המשתמש כתב 'אופציונלי'. או לא. האפשרות הזו יכולה להיות שימושית להעברת קובץ ה- .proto הלוך ושוב. כדי לשמור על עקביות, אנחנו נותנים לשדות ההודעות ערך סינתטי גם, למרות שהוא לא נדרש למעקב אחר הנוכחות. זה חשוב במיוחד כי המנתח לא יכול לזהות אם שדה הוא הודעה או 'טיפוסים בני מנייה (enum)', ולכן הוא צריך תמיד ליצור אחד מהם סינתטי.

בשדות האופציונליים של Proto2 לא מוגדר הסימון הזה, כי הם כבר מסומנים כאופציונליים אצל LABEL_OPTIONAL.

{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}

string

object (EnumValueDescriptorProto)

{
  "name": string,
  "number": integer
}

string

integer

{
  "name": string
}

string

{
  "field": string,
  "description": string,
  "inputConstraint": string,
  "knownValueDescriptions": [
    {
      object (PolicySchemaFieldKnownValueDescription)
    }
  ],
  "nestedFieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ],
  "requiredItems": [
    {
      object (PolicySchemaRequiredItems)
    }
  ],
  "defaultValue": value,
  "name": string,
  "fieldDescription": string,
  "fieldConstraints": {
    object (FieldConstraints)
  }
}

string

פלט בלבד. שם השדה שמשויך לתיאור הזה.

string

הוצא משימוש. במקום זאת, צריך להשתמש בשם וב-FieldDescription. תיאור השדה.

string

פלט בלבד. כל מגבלות קלט שמשויכות לערכים בשדה.

object (PolicySchemaFieldKnownValueDescription)

פלט בלבד. אם השדה מכיל קבוצה של ערכים ידועים, השדה הזה יספק תיאור של הערכים האלה.

object (PolicySchemaFieldDescription)

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

object (PolicySchemaFieldDependencies)

פלט בלבד. מספקת רשימה של שדות וערכים. כדי שאפשר יהיה להגדיר את השדה הזה, לפחות אחד מהשדות חייב להכיל את הערך המתאים.

object (PolicySchemaRequiredItems)

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

value (Value format)

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

string

פלט בלבד. שם השדה.

string

פלט בלבד. תיאור השדה.

object (FieldConstraints)

פלט בלבד. מידע על אילוצי קלט שמשויכים לערכים בשדה.

{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}

string

פלט בלבד. הייצוג מחדש של המחרוזת שאפשר להגדיר בשדה.

string

פלט בלבד. תיאור נוסף לערך הזה.

object (PolicySchemaFieldDependencies)

פלט בלבד. התנאים לשדה שנדרשים כדי שהערך הזה יהיה חוקי.

{
  "sourceField": string,
  "sourceFieldValue": string
}

string

שדה המקור שבו השדה הזה תלוי.

string

הערך ששדה המקור חייב להכיל כדי לאפשר הגדרה של השדה הזה.

{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}

string

הערכים בשדות שגורמים לאכיפה נדרשת של השדה. אם השדה ריק, התנאי מרמז על כך שכל ערך שמוקצה לשדה הזה יגרום לאכיפה נדרשת של השדה.

string

השדות הנדרשים כתוצאה מתנאי השדה.

{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}

object (NumericRangeConstraint)

הטווח המותר לשדות מספריים.

object (UploadedFileConstraints)

מגבלות על הקובץ של המדיניות בנושא קבצים. אם המדיניות הזו קיימת, נדרשת כתובת URL לאחזור על ידי העלאת קובץ עם המגבלות שצוינו בפרוטו הזה.

{
  "minimum": string,
  "maximum": string
}

string (int64 format)

ערך מינימלי.

string (int64 format)

ערך מקסימלי.

{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}

enum (ContentType)

סוגי קבצים שאפשר להעלות במסגרת הגדרה מסוימת.

string (int64 format)

מגבלת הגודל בבייטים של קבצים שניתן להעלות להגדרה מסוימת.

{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}

string

פלט בלבד. שם השדה שמשויך להודעה.

string

פלט בלבד. הערך בשדה שיש בו הודעה. אם מגדירים בשדה את הערך הזה, יכול להיות שהמשתמש יצטרך לאשר את הודעת ההתראה כדי שיהיה מוגדר.

string

פלט בלבד. הודעת ההודעה שמשויכת לערך בשדה.

boolean

פלט בלבד. האם המשתמש צריך לאשר את הודעת ההתראה לפני שניתן להגדיר את הערך.

{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}

string

במקרה שהמדיניות הזו הוצאה משימוש לטובת מדיניות אחרת, מרחבי השמות המלאים של כללי המדיניות החדשים יופיעו ב-PolicyAPI. אפשר להגדיר רק אם המדיניות ApiLifecycleStage היא API_DEPRECATED.

string

בהתאם ל-InFavorOf שהוצאו משימוש, מרחבי השמות שהוגדרו במלואם של כללי המדיניות הישנים יוצאו משימוש עקב הצגת המדיניות הזו.

enum (PolicyApiLifecycleEnum)

הצגת השלב הנוכחי של מחזור החיים של ה-API של המדיניות.

string

תיאור של מחזור החיים הנוכחי.

object (Date)

תאריך סיום התמיכה במדיניות הנוכחית. ניסיון לשנות מדיניות לאחר תאריך התמיכה שלה יגרום להצגה של 'בקשה שגויה' (שגיאה 400). אפשר להגדיר רק אם המדיניות ApiLifecycleStage היא API_DEPRECATED.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

השנה שבה חל התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.

integer

החודש בשנה. הערך חייב להיות 1 עד 12, או 0 כדי לציין שנה בלי חודש ויום.

integer

היום בחודש. הערך צריך להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם אין חשיבות לציון יום מסוים.