REST Resource: customers.policySchemas

منبع: PolicySchema

منبعی که یک طرح سیاست را نشان می دهد.

نمایندگی JSON
{
  "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
}
زمینه های
name

string

قالب: name=customers/{customer}/policySchemas/{schema_namespace}

policyDescription

string

فقط خروجی توضیحاتی درباره طرح خط مشی برای مصرف کاربر.

additionalTargetKeyNames[]

object ( AdditionalTargetKeyName )

فقط خروجی نام‌های کلید اضافی که برای شناسایی هدف ارزش خط‌مشی استفاده می‌شوند. هنگام تعیین یک policyTargetKey ، هر یک از کلیدهای اضافی مشخص شده در اینجا باید در نقشه additionalTargetKeys گنجانده شود.

definition

object ( FileDescriptorProto )

تعریف طرحواره با استفاده از توصیفگر پروتو

fieldDescriptions[]

object ( PolicySchemaFieldDescription )

فقط خروجی شرح مفصل هر فیلد که بخشی از طرحواره است.

accessRestrictions[]

string

فقط خروجی محدودیت‌های دسترسی خاص مربوط به این خط‌مشی.

notices[]

object ( PolicySchemaNoticeDescription )

فقط خروجی پیام های اخطار ویژه مربوط به تنظیم مقادیر خاص در فیلدهای خاص در طرحواره.

supportUri

string

فقط خروجی URI به مقاله پشتیبانی مرتبط برای این طرح.

schemaName

string

فقط خروجی نام کاملاً واجد شرایط طرح خط مشی. این مقدار برای پر کردن فیلد policySchema در PolicyValue هنگام فراخوانی orgunits.batchInherit orgunits.batchModify groups.batchModify یا groups.batchDelete استفاده می شود.

validTargetResources[]

enum ( TargetResource )

فقط خروجی اطلاعات در مورد منابع هدف قابل اجرا برای سیاست.

policyApiLifecycle

object ( PolicyApiLifecycle )

فقط خروجی اطلاعات چرخه حیات فعلی

categoryTitle

string

عنوان دسته ای که یک تنظیم به آن تعلق دارد.

AdditionalTargetKeyName

نام‌های کلید اضافی که برای شناسایی هدف ارزش خط‌مشی استفاده می‌شوند.

نمایندگی JSON
{
  "key": string,
  "keyDescription": string
}
زمینه های
key

string

نام کلید.

keyDescription

string

توضیحات کلید

FileDescriptorProto

یک فایل .proto کامل را شرح می دهد.

نمایندگی JSON
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
زمینه های
name

string

نام فایل، نسبت به ریشه درخت منبع

package

string

به عنوان مثال "foo"، "foo.bar"، و غیره.

messageType[]

object ( DescriptorProto )

تمام تعاریف سطح بالا در این فایل.

enumType[]

object ( EnumDescriptorProto )

syntax

string

نحو فایل پروتو. مقادیر پشتیبانی شده "proto2"، "proto3" و "editions" هستند.

اگر edition موجود باشد، این مقدار باید «ویرایش» باشد.

DescriptorProto

یک نوع پیام را توصیف می کند.

نمایندگی JSON
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
زمینه های
name

string

field[]

object ( FieldDescriptorProto )

nestedType[]

object ( DescriptorProto )

enumType[]

object ( EnumDescriptorProto )

oneofDecl[]

object ( OneofDescriptorProto )

FieldDescriptorProto

یک فیلد را در یک پیام توصیف می کند.

نمایندگی JSON
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
زمینه های
name

string

number

integer

label

enum ( Label )

type

enum ( Type )

اگر typeName تنظیم شده باشد، نیازی به تنظیم نیست. اگر این و typeName هر دو تنظیم شده باشند، باید یکی از TYPE_ENUM، TYPE_MESSAGE یا TYPE_GROUP باشد.

typeName

string

برای انواع پیام و enum، این نام نوع است. اگر نام با «.» شروع شود، کاملاً واجد شرایط است. در غیر این صورت، از قوانین محدوده مانند C++ برای یافتن نوع استفاده می شود (یعنی ابتدا انواع تودرتو در این پیام جستجو می شوند، سپس در والد، تا فضای نام ریشه جستجو می شوند).

defaultValue

string

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

oneofIndex

integer

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

jsonName

string

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

proto3Optional

boolean

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

هنگامی که proto3Optional درست است، این فیلد باید به یکی از یکی از آنها تعلق داشته باشد تا به مشتری های قدیمی proto3 نشان دهد که حضور برای این فیلد ردیابی می شود. این یکی از آنها به عنوان یکی از "مصنوعی" شناخته می شود، و این فیلد باید تنها عضو آن باشد (هر فیلد اختیاری proto3 یکی از فیلدهای مصنوعی خود را دریافت می کند). یکی از ترکیبات فقط در توصیفگر وجود دارد و هیچ API ایجاد نمی کند. یکی از مصنوعی باید بعد از همه "واقعی" سفارش داده شود.

برای فیلدهای پیام، proto3Optional هیچ تغییر معنایی ایجاد نمی کند، زیرا فیلدهای پیام تکرار نشده همیشه حضور را دنبال می کنند. با این حال، هنوز جزئیات معنایی را نشان می دهد که آیا کاربر «اختیاری» نوشته است یا نه. این می تواند برای رفت و برگشت فایل .proto مفید باشد. برای سازگاری، فیلدهای پیام را نیز ترکیبی می‌دهیم، حتی اگر برای ردیابی حضور لازم نباشد. این به ویژه مهم است زیرا تجزیه کننده نمی تواند تشخیص دهد که یک فیلد یک پیام است یا یک enum، بنابراین همیشه باید یک فیلد مصنوعی ایجاد کند.

فیلدهای اختیاری Proto2 این پرچم را تنظیم نمی کنند، زیرا از قبل با LABEL_OPTIONAL نشانگر اختیاری هستند.

برچسب

Enums
LABEL_OPTIONAL 0 برای خطاها محفوظ است
LABEL_REQUIRED
LABEL_REPEATED

تایپ کنید

Enums
TYPE_DOUBLE 0 برای خطاها محفوظ است. نظم به دلایل تاریخی عجیب است.
TYPE_FLOAT
TYPE_INT64 زیگ زاگ کدگذاری نشده است. اعداد منفی 10 بایت می گیرند. اگر مقادیر منفی محتمل است از TYPE_SINT64 استفاده کنید.
TYPE_UINT64
TYPE_INT32 زیگ زاگ کدگذاری نشده است. اعداد منفی 10 بایت می گیرند. اگر مقادیر منفی محتمل است از TYPE_SINT32 استفاده کنید.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP مجموع محدود شده با برچسب. نوع گروه منسوخ شده است و در proto3 پشتیبانی نمی شود. با این حال، پیاده‌سازی‌های Proto3 همچنان باید بتوانند قالب گروه سیم را تجزیه کنند و فیلدهای گروه را به عنوان فیلدهای ناشناخته در نظر بگیرند.
TYPE_MESSAGE مجموع محدود شده با طول.
TYPE_BYTES جدید در نسخه 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 از رمزگذاری ZigZag استفاده می کند.
TYPE_SINT64 از رمزگذاری ZigZag استفاده می کند.

EnumDescriptorProto

یک نوع enum را توصیف می کند.

نمایندگی JSON
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
زمینه های
name

string

value[]

object ( EnumValueDescriptorProto )

EnumValueDescriptorProto

یک مقدار را در یک enum توصیف می کند.

نمایندگی JSON
{
  "name": string,
  "number": integer
}
زمینه های
name

string

number

integer

OneofDescriptorProto

یکی از آنها را توصیف می کند.

نمایندگی JSON
{
  "name": string
}
زمینه های
name

string

PolicySchemaFieldDescription

اطلاعات دقیقی را برای یک فیلد خاص که بخشی از PolicySchema است ارائه می دهد.

نمایندگی JSON
{
  "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)
  }
}
زمینه های
field

string

فقط خروجی نام فیلد مربوط به این توضیحات.

description
(deprecated)

string

منسوخ. به جای آن از name و fieldDescription استفاده کنید. توضیحات مربوط به رشته

inputConstraint

string

فقط خروجی هرگونه محدودیت ورودی مرتبط با مقادیر فیلد.

knownValueDescriptions[]

object ( PolicySchemaFieldKnownValueDescription )

فقط خروجی اگر فیلد دارای مجموعه ای از مقادیر شناخته شده باشد، این فیلد توضیحاتی برای این مقادیر ارائه می دهد.

nestedFieldDescriptions[]

object ( PolicySchemaFieldDescription )

فقط خروجی توضیحات فیلدهای تو در تو در این فیلد را ارائه می دهد، اگر فیلد یک نوع پیام باشد که چندین فیلد را تعریف می کند.

fieldDependencies[]

object ( PolicySchemaFieldDependencies )

فقط خروجی فهرستی از فیلدها و مقادیر را ارائه می دهد. حداقل یکی از فیلدها باید مقدار مربوطه را داشته باشد تا این فیلد مجاز به تنظیم باشد.

requiredItems[]

object ( PolicySchemaRequiredItems )

فقط خروجی فهرستی از فیلدهایی را ارائه می دهد که در صورت داشتن مقدار مشخصی باید تنظیم شوند.

defaultValue

value ( Value format)

فقط خروجی اگر خط‌مشی تنظیم نشده باشد، پیش‌فرض مشتری.

name

string

فقط خروجی نام رشته.

fieldDescription

string

فقط خروجی شرح رشته.

fieldConstraints

object ( FieldConstraints )

فقط خروجی اطلاعات مربوط به هر گونه محدودیت ورودی مرتبط با مقادیر فیلد.

PolicySchemaFieldKnownValueDescription

اطلاعات دقیقی در مورد مقدار شناخته شده ای که برای یک فیلد خاص در PolicySchema مجاز است، ارائه می دهد.

نمایندگی JSON
{
  "value": string,
  "description": string
}
زمینه های
value

string

فقط خروجی نمایش رشته مقداری که می توان برای فیلد تنظیم کرد.

description

string

فقط خروجی توضیحات اضافی برای این مقدار

PolicySchemaField Dependencies

فیلد و مقداری که باید داشته باشد تا فیلد دیگری مجاز به تنظیم باشد.

نمایندگی JSON
{
  "sourceField": string,
  "sourceFieldValue": string
}
زمینه های
sourceField

string

فیلد منبعی که این فیلد به آن بستگی دارد.

sourceFieldValue

string

مقداری که فیلد منبع باید داشته باشد تا این فیلد مجاز به تنظیم باشد.

PolicySchemaRequiredItems

فیلدهایی که بر اساس مقدار این فیلد مورد نیاز خواهند بود.

نمایندگی JSON
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
زمینه های
fieldConditions[]

string

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

requiredFields[]

string

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

محدودیت های میدانی

اطلاعات در مورد هر گونه محدودیت محدوده.

نمایندگی JSON
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
زمینه های
numericRangeConstraint

object ( NumericRangeConstraint )

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

uploadedFileConstraints

object ( UploadedFileConstraints )

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

NumericRangeConstraint

یک محدودیت در کران های بالا و/یا پایین، با حداقل یک تنظیم.

نمایندگی JSON
{
  "minimum": string,
  "maximum": string
}
زمینه های
minimum

string ( int64 format)

حداقل ارزش.

maximum

string ( int64 format)

حداکثر مقدار

UploadedFileConstraints

محدودیت در فایل آپلود شده یک خط مشی فایل.

نمایندگی JSON
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
زمینه های
supportedContentTypes[]

enum ( ContentType )

انواع فایل هایی که می توان برای یک تنظیم آپلود کرد.

sizeLimitBytes

string ( int64 format)

محدودیت اندازه فایل های آپلود شده برای یک تنظیم، بر حسب بایت.

نوع محتوا

انواع فایل هایی که می توان برای یک تنظیم آپلود کرد.

Enums
CONTENT_TYPE_UNSPECIFIED نوع محتوای نامشخص
CONTENT_TYPE_PLAIN_TEXT متن ساده
CONTENT_TYPE_HTML HTML.
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF GIF.
CONTENT_TYPE_IMAGE_PNG PNG.
CONTENT_TYPE_JSON JSON.
CONTENT_TYPE_ZIP ZIP
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP WEBP.

PolicySchemaNoticeDescription

پیام های اخطار ویژه مربوط به یک مقدار خاص را در فیلدی که بخشی از PolicySchema است ارائه می دهد.

نمایندگی JSON
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
زمینه های
field

string

فقط خروجی نام فیلد مرتبط با اعلامیه.

noticeValue

string

فقط خروجی مقدار فیلدی که اعلان دارد. هنگام تنظیم فیلد روی این مقدار، ممکن است از کاربر خواسته شود که پیام اعلان را تأیید کند تا مقدار تنظیم شود.

noticeMessage

string

فقط خروجی پیام اعلان با مقدار فیلد مرتبط است.

acknowledgementRequired

boolean

فقط خروجی این که آیا کاربر باید پیام اعلان را قبل از تنظیم مقدار تأیید کند یا خیر.

منبع هدف

انواع منابع هدف

Enums
TARGET_RESOURCE_UNSPECIFIED منبع هدف نامشخص
ORG_UNIT منبع هدف واحد سازمانی
GROUP منبع هدف گروه

PolicyApiLifecycle

نمایندگی JSON
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
زمینه های
policyApiLifecycleStage

enum ( PolicyApiLifecycleEnum )

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

description

string

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

endSupport

object ( Date )

پایان تاریخ پشتیبانی برای خط مشی فعلی.

deprecatedInFavorOf[]

string

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

PolicyApiLifecycleEnum

Enums
API_UNSPECIFIED نامشخص
API_PREVIEW خط‌مشی هنوز کار نمی‌کند، اما به توسعه‌دهندگان اجازه می‌دهد تا فرمت را بالا ببرند. این مرحله می تواند به API_DEVELOPEMNT یا API_CURRENT منتقل شود.
API_DEVELOPMENT خط مشی می تواند قالب را به روشی ناسازگار با عقب تغییر دهد (تغییر شکستن). این مرحله می تواند به API_CURRENT یا API_DEPRECATED منتقل شود. این می‌تواند برای خط‌مشی‌هایی استفاده شود که فقط برای TT راه‌اندازی می‌شوند یا برای مشتریان منتخب برای استفاده اضطراری راه‌اندازی می‌شوند.
API_CURRENT خط مشی در قالب رسمی خط مشی می تواند قالب را به روشی سازگار با عقب تغییر دهد (تغییر بدون شکست). مثال: این خط مشی می تواند فیلد جدیدی را معرفی کند که در صورت استفاده صحیح از ماسک های فیلد، تغییر غیرقابل شکست در نظر گرفته می شود. این مرحله می تواند به API_DEPRECATED منتقل شود.
API_DEPRECATED لطفا استفاده از این سیاست را متوقف کنید. این خط‌مشی منسوخ شده است و ممکن است در آینده حذف شود. به احتمال زیاد سیاست جدیدی برای جایگزینی این سیاست معرفی شده است.

تاریخ

نمایانگر یک تاریخ تقویم کامل یا جزئی، مانند روز تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده است یا ناچیز است. تاریخ نسبت به تقویم میلادی است. این می تواند نشان دهنده یکی از موارد زیر باشد:

  • تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
  • یک ماه و روز، با یک سال صفر (مثلاً یک سالگرد).
  • یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
  • یک سال و یک ماه، با روز صفر (مثلاً تاریخ انقضای کارت اعتباری).

انواع مرتبط:

نمایندگی JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
زمینه های
year

integer

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

month

integer

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

day

integer

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

مواد و روش ها

get

 یک طرح خط مشی خاص برای مشتری با نام منبع آن دریافت کنید.

list

 فهرستی از طرح‌واره‌های خط‌مشی را دریافت می‌کند که با یک مقدار فیلتر مشخص شده برای یک مشتری مشخص مطابقت دارند.