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

نحو فایل پروتو. مقادیر پشتیبانی شده "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

برای انواع عددی، حاوی نمایش متن اصلی مقدار است. برای Booleans، "درست" یا "نادرست". برای رشته ها، حاوی محتویات متن پیش فرض (به هیچ وجه خارج نشده است). برای بایت ها، حاوی مقدار فرار C است. همه بایت ها >= 128 فرار می کنند.

integer

اگر تنظیم شود، نمایه یکی از آن ها را در لیست oneofDecl نوع حاوی آن نشان می دهد. این فیلد یکی از اعضای آن یکی است.

string

نام JSON این فیلد. مقدار توسط کامپایلر پروتکل تنظیم می شود. اگر کاربر گزینه "jsonName" را در این فیلد تنظیم کرده باشد، از مقدار آن گزینه استفاده خواهد شد. در غیر این صورت، با تبدیل آن به camelCase از نام فیلد استنباط می شود.

boolean

اگر درست باشد، این یک proto3 "اختیاری" است. هنگامی که یک فیلد proto3 اختیاری است، بدون توجه به نوع فیلد، حضور را دنبال می‌کند.

وقتی proto3Optional درست است، این فیلد باید به یکی از یکی از آنها تعلق داشته باشد تا به مشتری های قدیمی 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

منسوخ شده است. به جای آن از name و 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

مقدار(های) فیلدی که اجرای فیلد مورد نیاز را تحریک می کند. یک فیلد خالی Conditions به این معنی است که هر مقداری که به این فیلد اختصاص داده شود، اجرای فیلد مورد نیاز را تحریک خواهد کرد.

string

فیلدهایی که در نتیجه شرایط زمین مورد نیاز هستند.

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

object ( NumericRangeConstraint )

محدوده مجاز برای فیلدهای عددی.

object ( UploadedFileConstraints )

محدودیت در فایل آپلود شده یک خط مشی فایل. در صورت وجود، این خط‌مشی به نشانی اینترنتی نیاز دارد که می‌توان آن را با آپلود یک فایل با محدودیت‌های مشخص‌شده در این پروتکل واکشی کرد.

{
  "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 نشان داده می‌شوند. فقط در صورتی می‌توان تنظیم کرد که PolicyApiLifecycleStage API_DEPRECATED باشد.

string

مربوط به deprecatedInFavorOf، فضای نام (های) کاملا واجد شرایط خط‌مشی‌های قدیمی است که به دلیل معرفی این خط‌مشی منسوخ خواهند شد.

enum ( PolicyApiLifecycleEnum )

مرحله چرخه عمر فعلی API سیاست را نشان می دهد.

string

توضیحاتی در مورد چرخه زندگی فعلی

object ( Date )

پایان تاریخ پشتیبانی برای خط مشی فعلی. تلاش برای تغییر یک خط‌مشی پس از تاریخ پایان پشتیبانی آن منجر به یک درخواست بد (خطای 400) می‌شود. فقط در صورتی می‌توان تنظیم کرد که PolicyApiLifecycleStage API_DEPRECATED باشد.

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

integer

سال تاریخ. برای تعیین تاریخ بدون سال باید از 1 تا 9999 یا 0 باشد.

integer

ماه از یک سال. باید از 1 تا 12 یا 0 باشد تا یک سال بدون ماه و روز مشخص شود.

integer

روز یک ماه. باید از 1 تا 31 باشد و برای سال و ماه معتبر باشد، یا 0 برای مشخص کردن یک سال به تنهایی یا یک سال و ماهی که در آن روز مهم نیست، معتبر باشد.