- แหล่งข้อมูล: 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 |
คำจำกัดความของสคีมาโดยใช้ Proto Descriptor |
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" และ "editions" หากมี |
DescriptorProto
อธิบายประเภทข้อความ
การแสดง JSON |
---|
{ "name": string, "field": [ { object ( |
ช่อง | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
อธิบายช่องภายในข้อความ
การแสดง JSON |
---|
{ "name": string, "number": integer, "label": enum ( |
ช่อง | |
---|---|
name |
|
number |
|
label |
|
type |
หากตั้งค่า typeName ไว้ คุณก็ไม่ต้องตั้งค่านี้ หากมีการตั้งค่าทั้ง 2 และ typeName ค่านี้จะต้องเป็น TYPE_ENUM, TYPE_MESSAGE หรือ TYPE_GROUP |
typeName |
สำหรับประเภทข้อความและ enum นี่เป็นชื่อของประเภท ถ้าชื่อขึ้นต้นด้วย '.' แสดงว่าถือเป็นค่าที่มีคุณสมบัติครบถ้วน ไม่เช่นนั้นระบบจะใช้กฎการกำหนดขอบเขตที่คล้ายกับ C++ เพื่อค้นหาประเภท (นั่นคือ ระบบจะค้นหาประเภทที่ฝังอยู่ภายในข้อความนี้ก่อน จากนั้นจึงค้นหาประเภทที่ซ้อนภายในระดับบนสุด ไปจนถึงเนมสเปซของรูท) |
defaultValue |
ส่วนประเภทตัวเลข จะมีการแสดงค่าต้นฉบับเป็นข้อความ สำหรับบูลีน ให้ใช้ "true" หรือ "false" สำหรับสตริง จะมีเนื้อหาข้อความเริ่มต้น (ไม่มีการกำหนดเป็นอักขระหลีกไม่ว่าในกรณีใดก็ตาม) ส่วนไบต์จะมีค่าที่กำหนดเป็นอักขระหลีก C ไบต์ทั้งหมด >= 128 จะใช้ Escape |
oneofIndex |
หากตั้งค่าไว้ จะแสดงดัชนีของ 1 ในรายการ oneofDecl ของประเภทที่มี ช่องนี้เป็นสมาชิกของช่องดังกล่าว |
jsonName |
ชื่อ JSON ของช่องนี้ ค่านี้กำหนดโดยคอมไพเลอร์โปรโตคอล หากผู้ใช้ตั้งค่าตัวเลือก "jsonName" ในช่องนี้ ระบบจะใช้ค่าของตัวเลือกนั้น หรือไม่เช่นนั้น จะอนุมานจากชื่อช่องโดยแปลงเป็น CamelCase |
proto3Optional |
หากเป็น "จริง" จะเป็นแบบ "ไม่บังคับ" เมื่อไม่จำเป็นต้องระบุช่อง proto3 จึงจะติดตามการมีอยู่ไม่ว่าจะเป็นช่องประเภทใดก็ตาม เมื่อ proto3Optional เป็นจริง ช่องนี้ต้องเป็นของค่าใดค่าหนึ่งเพื่อส่งสัญญาณให้ไคลเอ็นต์ proto3 เก่าทราบว่ามีการติดตามการมีอยู่สําหรับช่องนี้ ช่องนี้เรียกว่าช่อง "สังเคราะห์" และช่องนี้ต้องเป็นสมาชิกเพียงคนเดียว (ช่อง Proto3 แต่ละรายการที่ไม่บังคับจะมีช่องสังเคราะห์ของตนเอง) โดยมีรูปแบบสังเคราะห์อยู่ในข้อบ่งชี้เท่านั้น และไม่สร้าง API ใดๆ โดยต้องเรียงลำดับตามองค์ประกอบสังเคราะห์หลังจากรายการที่มี "จริง" ทั้งหมด สำหรับช่องข้อความ proto3Optional จะไม่สร้างการเปลี่ยนแปลงเชิงความหมาย เนื่องจากช่องข้อความที่ไม่ซ้ำกันจะติดตามการแสดงข้อมูลเสมอ อย่างไรก็ตาม สิ่งนี้ยังคงบ่งบอกรายละเอียดเชิงความหมายว่าผู้ใช้เขียนว่า "ไม่บังคับ" หรือไม่ ซึ่งจะเป็นประโยชน์ต่อการส่งผ่านไฟล์ .proto แบบไป-กลับ เพื่อความสอดคล้อง เรามีฟิลด์ข้อความสังเคราะห์ให้ฟิลด์ข้อความด้วย แม้ว่าจะไม่จำเป็นต้องติดตามการแสดงข้อมูลก็ตาม ข้อนี้มีความสำคัญอย่างยิ่ง เนื่องจากโปรแกรมแยกวิเคราะห์ไม่สามารถบอกได้ว่าฟิลด์เป็นข้อความหรือ enum จึงต้องสร้างฟิลด์สังเคราะห์ขึ้นเสมอ ช่องที่ไม่บังคับของ Proto2 ไม่ได้ตั้งค่าแฟล็กนี้ เนื่องจากช่องเหล่านี้ระบุด้วย |
ป้ายกำกับ
Enum | |
---|---|
LABEL_OPTIONAL |
0 สงวนไว้สำหรับข้อผิดพลาด |
LABEL_REQUIRED |
|
LABEL_REPEATED |
ประเภท
Enum | |
---|---|
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
อธิบายประเภท enum
การแสดง JSON |
---|
{
"name": string,
"value": [
{
object ( |
ช่อง | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
อธิบายค่าภายใน enum
การแสดง 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 |
เลิกใช้งานแล้ว แต่ให้ใช้ name และ fieldDescription แทน คำอธิบายสำหรับช่องนี้ |
inputConstraint |
เอาต์พุตเท่านั้น ข้อจำกัดอินพุตใดๆ ที่เชื่อมโยงกับค่าสำหรับช่อง |
knownValueDescriptions[] |
เอาต์พุตเท่านั้น หากช่องนี้มีชุดค่าที่รู้จัก ช่องนี้จะมีคำอธิบายสำหรับค่าเหล่านี้ |
nestedFieldDescriptions[] |
เอาต์พุตเท่านั้น ระบุคำอธิบายของช่องที่ฝังในช่องนี้ หากช่องดังกล่าวเป็นประเภทข้อความที่ระบุหลายช่อง |
fieldDependencies[] |
เอาต์พุตเท่านั้น ระบุรายการฟิลด์และค่า ช่องอย่างน้อย 1 ช่องต้องมีค่าที่เกี่ยวข้อง ระบบจึงจะตั้งค่าช่องนี้ได้ |
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[] |
ค่าของช่องที่ทำให้เกิดการบังคับใช้ช่องที่ต้องกรอก fieldConditions ที่ว่างเปล่าหมายความว่าค่าใดๆ ที่กำหนดให้กับช่องนี้จะทำให้เกิดการบังคับใช้ช่องที่ต้องกรอก |
requiredFields[] |
ฟิลด์ที่จำเป็นซึ่งเป็นผลมาจากเงื่อนไขฟิลด์ |
FieldConstraints
ข้อมูลเกี่ยวกับข้อจํากัดของช่วง
การแสดง JSON |
---|
{ "numericRangeConstraint": { object ( |
ช่อง | |
---|---|
numericRangeConstraint |
ช่วงที่อนุญาตสำหรับช่องตัวเลข |
uploadedFileConstraints |
ข้อจำกัดของนโยบายไฟล์ที่อัปโหลด หากมี นโยบายนี้ต้องใช้ URL ที่ดึงข้อมูลได้โดยการอัปโหลดไฟล์ที่มีข้อจำกัดที่ระบุไว้ในโปรโตนี้ |
NumericRangeConstraint
ขีดจำกัดบนขอบเขตบนและ/หรือล่าง โดยมีการตั้งค่าอย่างน้อย 1 ขอบเขต
การแสดง JSON |
---|
{ "minimum": string, "maximum": string } |
ช่อง | |
---|---|
minimum |
ค่าต่ำสุด |
maximum |
ค่าสูงสุด |
UploadedFileConstraints
ข้อจำกัดของนโยบายไฟล์ที่อัปโหลด
การแสดง JSON |
---|
{
"supportedContentTypes": [
enum ( |
ช่อง | |
---|---|
supportedContentTypes[] |
ประเภทไฟล์ที่สามารถอัปโหลดสำหรับการตั้งค่าได้ |
sizeLimitBytes |
ขีดจำกัดขนาดของไฟล์ที่อัปโหลดสำหรับการตั้งค่าเป็นไบต์ |
ContentType
ประเภทไฟล์ที่สามารถอัปโหลดสำหรับการตั้งค่าได้
Enum | |
---|---|
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
ประเภททรัพยากรเป้าหมาย
Enum | |
---|---|
TARGET_RESOURCE_UNSPECIFIED |
ทรัพยากรเป้าหมายที่ไม่ได้ระบุ |
ORG_UNIT |
ทรัพยากรเป้าหมายของหน่วยขององค์กร |
GROUP |
จัดกลุ่มทรัพยากรเป้าหมาย |
PolicyApiLifecycle
การแสดง JSON |
---|
{ "policyApiLifecycleStage": enum ( |
ช่อง | |
---|---|
policyApiLifecycleStage |
ระบุขั้นของวงจรปัจจุบันของ API นโยบาย |
description |
คำอธิบายเกี่ยวกับวงจรปัจจุบัน |
endSupport |
สิ้นสุดวันที่ให้การสนับสนุนสำหรับนโยบายปัจจุบัน |
deprecatedInFavorOf[] |
ในกรณีที่เลิกใช้งานนโยบายนี้เพื่อใช้นโยบายอื่นแทน ระบบจะใช้เนมสเปซที่ตรงตามเกณฑ์ทั้งหมดของนโยบายใหม่ตามที่จะแสดงใน PolicyAPI |
PolicyApiLifecycleEnum
Enum | |
---|---|
API_UNSPECIFIED |
ไม่ได้ระบุ |
API_PREVIEW |
นโยบายยังไม่ได้ทำงาน แต่แจ้งให้นักพัฒนาแอปทราบล่วงหน้าเกี่ยวกับรูปแบบ ขั้นตอนนี้สามารถโอนไปยัง API_DEVELOPEMNT หรือ API_CURRENT ได้ |
API_DEVELOPMENT |
นโยบายอาจเปลี่ยนรูปแบบที่เข้ากันไม่ได้แบบย้อนหลัง (การเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบ) ขั้นตอนนี้สามารถโอนไปยัง API_CURRENT หรือ API_DEPRECATED ได้ ข้อมูลนี้สามารถใช้สำหรับนโยบายที่เปิดตัวใน TT เท่านั้น หรือเปิดแก่ลูกค้าบางรายสำหรับการใช้งานในกรณีฉุกเฉิน |
API_CURRENT |
นโยบายในรูปแบบอย่างเป็นทางการ นโยบายสามารถเปลี่ยนรูปแบบที่เข้ากันได้แบบย้อนหลัง (การเปลี่ยนแปลงที่ไม่เปลี่ยนแปลง) เช่น นโยบายนี้อาจเพิ่มช่องใหม่ ซึ่งถือว่าเป็นการเปลี่ยนแปลงที่ไม่ทำให้เกิดความเสียหาย เมื่อมีการใช้มาสก์ฟิลด์อย่างเหมาะสม ขั้นตอนนี้สามารถโอนไปยัง API_DEPRECATED ได้ |
API_DEPRECATED |
โปรดหยุดใช้นโยบายนี้ เราเลิกใช้งานนโยบายนี้แล้ว และอาจ/ถูกนำออกในอนาคต น่าจะเป็นนโยบายใหม่มาแทนที่นโยบายนี้ |
วันที่
แสดงวันที่ในปฏิทินทั้งหมดหรือบางส่วน เช่น วันเกิด มีการระบุเวลาของวันและเขตเวลาไว้ที่อื่นหรือไม่มีนัยสำคัญ วันที่จะสัมพันธ์กับปฏิทินเกรกอเรียน ซึ่งอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้
- วันที่แบบเต็มพร้อมค่าปี เดือน และวันที่ไม่ใช่ 0
- เดือนและวัน 1 ปี (เช่น วันครบรอบ)
- 1 ปีเท่านั้น โดยมี 0 เดือนกับ 0 วัน
- ปีและเดือนที่มี 0 วัน (เช่น วันที่หมดอายุของบัตรเครดิต)
ประเภทที่เกี่ยวข้อง
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 เพื่อระบุปีอย่างเดียว หรือปีและเดือนที่วันไม่สำคัญ |
วิธีการ |
|
---|---|
|
สร้างสคีมานโยบายเฉพาะสำหรับลูกค้าตามชื่อทรัพยากร |
|
รับรายการสคีมานโยบายที่ตรงกับค่าตัวกรองที่ระบุสำหรับลูกค้ารายหนึ่งๆ |