- المورد: PolicySchema
- AdditionalTargetKeyName
- FileDescriptorProto
- DescriptorProto
- FieldDescriptorProto
- التصنيف
- النوع
- EnumDescriptorProto
- EnumValueDescriptorProto
- OneofDescriptorProto
- PolicySchemaFieldDescription
- PolicySchemaFieldKnownValueDescription
- PolicySchemaFieldDependencies
- PolicySchemaRequiredItems
- FieldConstraints
- NumericRangeConstraint
- UploadedFileConstraints
- ContentType
- PolicySchemaNoticeDescription
- TargetResource
- PolicyApiLifecycle
- PolicyApiLifecycleEnum
- التاريخ
- الطُرق
المورد: PolicySchema
تمثّل هذه السمة موردًا يمثّل مخططًا للسياسة.
تمثيل JSON |
---|
{ "name": string, "policyDescription": string, "additionalTargetKeyNames": [ { object ( |
الحقول | |
---|---|
name |
التنسيق: name=customers/{customer}/policySchemas/{schema_namespace} |
policyDescription |
النتائج فقط. وصف حول مخطط السياسة لاستهلاك المستخدمين. |
additionalTargetKeyNames[] |
النتائج فقط. أسماء مفاتيح إضافية سيتم استخدامها لتحديد الهدف من قيمة السياسة. عند تحديد |
definition |
تعريف المخطط باستخدام الواصف الأولي. |
fieldDescriptions[] |
النتائج فقط. وصف تفصيلي لكل حقل يُعد جزءًا من المخطط. |
accessRestrictions[] |
النتائج فقط. قيود الوصول المحددة المرتبطة بهذه السياسة. |
notices[] |
النتائج فقط. رسائل الإشعارات الخاصة المتعلقة بضبط قيم معيّنة في حقول معيّنة في المخطط. |
supportUri |
النتائج فقط. معرّف موارد منتظم (URI) لمقالة الدعم ذات الصلة بهذا المخطط |
schemaName |
النتائج فقط. تمثّل هذه السمة الاسم المؤهّل بالكامل لمخطط السياسة. يتم استخدام هذه القيمة لملء الحقل |
validTargetResources[] |
النتائج فقط. معلومات عن الموارد المستهدَفة السارية للسياسة. |
policyApiLifecycle |
النتائج فقط. معلومات دورة الحياة الحالية. |
categoryTitle |
عنوان الفئة التي ينتمي إليها الإعداد. |
AdditionalTargetKeyName
أسماء مفاتيح إضافية سيتم استخدامها لتحديد الهدف من قيمة السياسة.
تمثيل JSON |
---|
{ "key": string, "keyDescription": string } |
الحقول | |
---|---|
key |
اسم المفتاح |
keyDescription |
وصف المفتاح |
FileDescriptorProto
تصف ملف .proto الكامل.
تمثيل JSON |
---|
{ "name": string, "package": string, "messageType": [ { object ( |
الحقول | |
---|---|
name |
اسم الملف بالنسبة إلى جذر شجرة المصدر |
package |
مثلاً "foo" أو "foo.bar" أو غير ذلك. |
messageType[] |
جميع التعريفات ذات المستوى الأعلى في هذا الملف. |
enumType[] |
|
syntax |
بناء جملة ملف proto. والقيم المسموح بإدراجها هي "proto2" و"proto3" و "الإصدارات". في حال توفُّر |
DescriptorProto
يصف نوع الرسالة.
تمثيل JSON |
---|
{ "name": string, "field": [ { object ( |
الحقول | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
يصف حقلاً داخل رسالة.
تمثيل JSON |
---|
{ "name": string, "number": integer, "label": enum ( |
الحقول | |
---|---|
name |
|
number |
|
label |
|
type |
إذا تم ضبط typeName، لن يتم ضبط هذه السياسة. إذا تم تعيين كل من هذا وtypeName، يجب أن تكون القيمة أيًا مما يلي: TYPE_ENUM أو TYPE_MESSAGE أو TYPE_GROUP. |
typeName |
بالنسبة لأنواع الرسائل والتعداد، يكون هذا هو اسم النوع. وإذا كان الاسم يبدأ بعلامة "."، يكون الاسم مؤهّلاً بالكامل. بخلاف ذلك، يتم استخدام قواعد تحديد النطاق المشابهة لـ C++ للعثور على النوع (أي أولاً يتم البحث في الأنواع المتداخلة داخل هذه الرسالة، ثم داخل الأصل، حتى مساحة الاسم الجذر). |
defaultValue |
بالنسبة للأنواع الرقمية، يحتوي على تمثيل النص الأصلي للقيمة. للقيم المنطقية، "صحيح" أو "خطأ". بالنسبة إلى السلاسل، تحتوي على المحتوى النصي التلقائي (لا يتم إفلاته بأي شكل من الأشكال). بالنسبة إلى وحدات البايت، يحتوي على القيمة C التي تم تجاوزها. يتم تخطي جميع وحدات البايت >= 128. |
oneofIndex |
في حال ضبطها، سيتم توفير فهرس واحد من في قائمة oneofDecl الخاصة بالنوع الذي يحتوي على القيمة. هذا الحقل هو عضو في هذا الحقل. |
jsonName |
اسم JSON لهذا الحقل يتم تحديد القيمة من خلال المحول البرمجي للبروتوكول. وإذا ضبط المستخدم خيار "jsonName" في هذا الحقل، سيتم استخدام قيمة هذا الخيار. وإلا، يتم استنتاجها من اسم الحقل بتحويله إلى حالة CamlCase. |
proto3Optional |
إذا كانت true، يكون هذا Proto3 "اختياريًا". عندما يكون حقل proto3 اختياريًا، فإنه يتتبّع التواجد بغض النظر عن نوع الحقل. عندما تكون قيمة proto3Optional صحيحة، يجب أن ينتمي هذا الحقل إلى أحد الحقلين لإرسال إشارة إلى عملاء proto3 القدامى بأنه يتم تتبع التواجد لهذا الحقل. وتُعرف هذه الحقل باسم "مادة اصطناعية"، ويجب أن يكون هذا الحقل العضو الوحيد فيه (يحصل كل حقل اختياري للنموذج الأوّلي على حقل اصطناعي خاص به). تتوفّر الأعمدة الاصطناعية في الوصف فقط، ولا تنشئ أي واجهة برمجة تطبيقات. ويجب طلب المنتجات الاصطناعية بعد كل الأحرف "الحقيقية". بالنسبة إلى حقول الرسائل، لا يُنشئ proto3Optional أي تغيير دلالي، لأنّ حقول الرسائل غير المتكرّرة تتتبّع التواجد دائمًا. ومع ذلك، فهي لا تزال تشير إلى التفاصيل الدلالية لما إذا كان المستخدم كتب كلمة "اختياري" أم لا. يمكن أن يكون هذا مفيدًا في عملية ذهاب وعودة ملف .proto. ولضمان الاتساق، نمنح حقول الرسائل صفًا اصطناعيًا أيضًا، على الرغم من أنّ ذلك ليس شرطًا لتتبُّع التواجد. ويحظى ذلك بأهمية خاصة، لأنّ المحلِّل لا يمكنه معرفة ما إذا كان الحقل عبارة عن رسالة أم تعدادًا، لذا يجب أن ينشئ دائمًا حقلاً اصطناعيًا. لا يتم ضبط هذه العلامة في حقول Proto2 الاختيارية، لأنها تشير إلى أنّها اختيارية باستخدام |
التصنيف
عمليات التعداد | |
---|---|
LABEL_OPTIONAL |
تم حجز العدد 0 بسبب الأخطاء. |
LABEL_REQUIRED |
|
LABEL_REPEATED |
النوع
عمليات التعداد | |
---|---|
TYPE_DOUBLE |
0 محجوز للأخطاء. الطلب غريب لأسباب تاريخية. |
TYPE_FLOAT |
|
TYPE_INT64 |
ليس بترميز ZigZag. بينما تشغل الأرقام السالبة 10 بايت. استخدم TYPE_SINT64 إذا كان من المحتمل أن يكون هناك قيم سالبة. |
TYPE_UINT64 |
|
TYPE_INT32 |
ليس بترميز ZigZag. بينما تشغل الأرقام السالبة 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
لوصف نوع التعداد.
تمثيل JSON |
---|
{
"name": string,
"value": [
{
object ( |
الحقول | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
لوصف قيمة ضمن التعداد.
تمثيل JSON |
---|
{ "name": string, "number": integer } |
الحقول | |
---|---|
name |
|
number |
|
OneofDescriptorProto
يصف واحد مما يلي.
تمثيل JSON |
---|
{ "name": string } |
الحقول | |
---|---|
name |
|
PolicySchemaFieldDescription
توفِّر معلومات تفصيلية لحقل معيّن يُعد جزءًا من PolicySchema.
تمثيل JSON |
---|
{ "field": string, "description": string, "inputConstraint": string, "knownValueDescriptions": [ { object ( |
الحقول | |
---|---|
field |
النتائج فقط. اسم الحقل المرتبط بهذا الوصف. |
description |
تمّ الإيقاف. استخدِم الاسم والحقل الوصف بدلاً من ذلك. تمثّل هذه السمة وصف الحقل. |
inputConstraint |
النتائج فقط. أي قيود إدخال مرتبطة بقيم الحقل. |
knownValueDescriptions[] |
النتائج فقط. إذا كان الحقل يحتوي على مجموعة من القيم المعروفة، سيقدّم هذا الحقل وصفًا لهذه القيم. |
nestedFieldDescriptions[] |
النتائج فقط. تقدِّم وصفًا للحقول المضمّنة في هذا الحقل، إذا كان الحقل عبارة عن نوع رسالة يحدِّد حقولاً متعددة. |
fieldDependencies[] |
النتائج فقط. توفّر هذه السياسة قائمة بالحقول والقيم. يجب أن يحتوي حقل واحد على الأقل من الحقول على القيمة المقابلة حتى يتم السماح بضبط هذا الحقل. |
requiredItems[] |
النتائج فقط. توفّر هذه السياسة قائمة بالحقول المطلوب ضبطها إذا كان هذا الحقل يحتوي على قيمة معيّنة. |
defaultValue |
النتائج فقط. الإعداد التلقائي للعميل في حال ترك السياسة بدون ضبط. |
name |
النتائج فقط. اسم الحقل. |
fieldDescription |
النتائج فقط. تمثّل هذه السمة وصف الحقل. |
fieldConstraints |
النتائج فقط. معلومات عن أي قيود إدخال مرتبطة بقيم الحقل. |
PolicySchemaFieldKnownValueDescription
توفِّر معلومات تفصيلية عن قيمة معروفة مسموح بها لحقل معيّن في PolicySchema.
تمثيل JSON |
---|
{ "value": string, "description": string } |
الحقول | |
---|---|
value |
النتائج فقط. إعادة عرض السلسلة للقيمة التي يمكن ضبطها للحقل. |
description |
النتائج فقط. وصف إضافي لهذه القيمة. |
PolicySchemaFieldDependencies
الحقل والقيمة التي يجب أن يحتوي عليها للسماح بضبط حقل آخر.
تمثيل JSON |
---|
{ "sourceField": string, "sourceFieldValue": string } |
الحقول | |
---|---|
sourceField |
حقل المصدر الذي يعتمد عليه هذا الحقل. |
sourceFieldValue |
القيمة التي يجب أن يحتوي عليها حقل المصدر ليتم السماح بتعيين هذا الحقل. |
PolicySchemaRequiredItems
الحقول التي ستصبح مطلوبة استنادًا إلى قيمة هذا الحقل.
تمثيل JSON |
---|
{ "fieldConditions": [ string ], "requiredFields": [ string ] } |
الحقول | |
---|---|
fieldConditions[] |
قيم الحقل التي تستدعي فرض الحقل المطلوب. يعني الحقل الفارغ حالة الحقل أن أي قيمة تم تعيينها لهذا الحقل ستؤدي إلى تفعيل فرض الحقل المطلوب. |
requiredFields[] |
الحقول المطلوبة نتيجة لظروف الحقل. |
FieldConstraints
معلومات حول أي قيود على النطاق.
تمثيل JSON |
---|
{ "numericRangeConstraint": { object ( |
الحقول | |
---|---|
numericRangeConstraint |
النطاق المسموح به للحقول الرقمية. |
uploadedFileConstraints |
القيود على الملف الذي تم تحميله لسياسة ملف وفي حال توفُّرها، تتطلّب هذه السياسة عنوان URL يمكن جلبه عن طريق تحميل ملف بالقيود المحدّدة في هذا النموذج الأوّلي. |
NumericRangeConstraint
قيد على الحدين العلوي و/أو السفلي، مع تعيين واحد على الأقل.
تمثيل JSON |
---|
{ "minimum": string, "maximum": string } |
الحقول | |
---|---|
minimum |
القيمة الصغرى. |
maximum |
الحدّ الأقصى للقيمة. |
UploadedFileConstraints
القيود على الملف الذي تم تحميله لسياسة ملف
تمثيل JSON |
---|
{
"supportedContentTypes": [
enum ( |
الحقول | |
---|---|
supportedContentTypes[] |
أنواع الملفات التي يمكن تحميلها لإحدى الإعدادات |
sizeLimitBytes |
الحد المسموح به لحجم الملفات المُحمَّلة لأحد الإعدادات، بالبايت. |
ContentType
أنواع الملفات التي يمكن تحميلها لإحدى الإعدادات
عمليات التعداد | |
---|---|
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 |
النتائج فقط. اسم الحقل المرتبط بالإشعار. |
noticeValue |
النتائج فقط. قيمة الحقل الذي يحتوي على إشعار. عند ضبط الحقل على هذه القيمة، قد يُطلب من المستخدم الإقرار برسالة الإشعار حتى يتم ضبط القيمة. |
noticeMessage |
النتائج فقط. ترتبط رسالة الإشعار بقيمة الحقل. |
acknowledgementRequired |
النتائج فقط. ما إذا كان المستخدم بحاجة إلى الإقرار برسالة الإشعار قبل ضبط القيمة. |
TargetResource
أنواع الموارد المستهدفة
عمليات التعداد | |
---|---|
TARGET_RESOURCE_UNSPECIFIED |
مورد مستهدف غير محدّد |
ORG_UNIT |
المورد المستهدف للوحدة التنظيمية. |
GROUP |
مورد هدف المجموعة |
PolicyApiLifecycle
تمثيل JSON |
---|
{ "policyApiLifecycleStage": enum ( |
الحقول | |
---|---|
policyApiLifecycleStage |
تشير هذه السمة إلى مرحلة دورة الحياة الحالية لواجهة برمجة التطبيقات Policy API. |
description |
وصف عن دورة الحياة الحالية |
endSupport |
تاريخ انتهاء صلاحية السياسة الحالية |
deprecatedInFavorOf[] |
في حال إيقاف هذه السياسة لصالح سياسة أخرى، يتم تحديد مساحات الاسم المؤهّلة بالكامل للسياسات الجديدة كما ستظهر في PolicyAPI. |
PolicyApiLifecycleEnum
عمليات التعداد | |
---|---|
API_UNSPECIFIED |
غير محدد |
API_PREVIEW |
لا تعمل السياسة بعد، ولكنها تمنح مطوّري البرامج تنبيهات بشأن تنسيق المحتوى. يمكن أن يتم نقل هذه المرحلة إلى API_DE المطابقةMNT أو API_CURRENT. |
API_DEVELOPMENT |
يمكن أن تؤدي السياسة إلى تغيير التنسيق بطريقة غير متوافقة مع الإصدارات السابقة (يعطّل التغيير). يمكن نقل هذه المرحلة إلى API_CURRENT أو API_DEPRECATED. يمكن استخدام هذه الميزة للسياسات التي تم إطلاقها فقط لأجهزة "تحويل النص إلى كلام" أو إطلاقها لعملاء محدَّدين للاستخدام في حالات الطوارئ. |
API_CURRENT |
السياسة بالتنسيق الرسمي. يمكن أن تغيّر السياسة التنسيق بطريقة متوافقة مع الأنظمة القديمة (تغيير غير مؤثِّر). مثال: يمكن أن تقدم هذه السياسة حقلاً جديدًا، ما يُعتبر تغييرًا غير مؤثِّر، عند استخدام أقنعة الحقول بشكل صحيح. يمكن نقل هذه المرحلة إلى API_DEPRECATED. |
API_DEPRECATED |
يُرجى التوقف عن استخدام هذه السياسة. تم إيقاف هذه السياسة نهائيًا، وقد تتم إزالتها في المستقبل. من المرجّح أنّه تم طرح سياسة جديدة بدلاً من هذه السياسة. |
التاريخ
تمثّل تاريخًا كاملاً أو جزئيًا في التقويم، مثل تاريخ الميلاد. تم تحديد الوقت من اليوم والمنطقة الزمنية في مكان آخر أو هما غير مهمين. التاريخ مرتبط بالتقويم الميلادي. يمكن أن يمثّل ذلك أحد الأنواع التالية:
- تاريخ كامل، مع قيم غير صفرية للسنة والشهر واليوم.
- شهر ويوم مع السنة صفر (على سبيل المثال، ذكرى سنوية).
- سنة من تلقاء نفسها، مع عدم تحديد شهر ويوم صفر.
- سنة وشهر بدون يوم (على سبيل المثال، تاريخ انتهاء صلاحية بطاقة الائتمان).
أنواع ذات صلة:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
تمثيل JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
الحقول | |
---|---|
year |
سنة من التاريخ. يجب أن تتراوح القيمة بين 1 و9999، أو 0 لتحديد تاريخ بدون سنة. |
month |
شهر من السنة يجب أن تتراوح القيمة من 1 إلى 12 أو 0 لتحديد عام بدون شهر ويوم. |
day |
يوم من الشهر. يجب أن تتراوح القيمة من 1 إلى 31 وأن تكون صالحة للسنة والشهر أو يجب أن تكون القيمة 0 لتحديد سنة بحد ذاتها أو عام وشهر لا يكون فيه اليوم مهمًا. |
الطُرق |
|
---|---|
|
احصل على مخطط سياسة معيّن للعميل من خلال اسم مورده. |
|
الحصول على قائمة بمخطّطات السياسات التي تتطابق مع قيمة فلتر محدّدة لعميل معيّن |