- Referensi: Skema Kebijakan
- AdditionalTargetKeyName
- FileDescriptorProto
- DescriptorProto
- FieldDescriptorProto
- Label
- Jenis
- EnumDescriptorProto
- EnumValueDescriptorProto
- OneofDescriptorProto
- PolicySchemaFieldDescription
- PolicySchemaFieldKnownValueDescription
- PolicySchemaFieldDependencies
- PolicySchemaRequiredItems
- FieldConstraints
- NumericRangeConstraint
- UploadedFileConstraints
- ContentType
- PolicySchemaNoticeDescription
- TargetResource
- PolicyApiLifecycle
- PolicyApiLifecycleEnum
- Tanggal
- Metode
Resource: PolicySchema
Resource yang merepresentasikan skema kebijakan.
Representasi JSON |
---|
{ "name": string, "policyDescription": string, "additionalTargetKeyNames": [ { object ( |
Kolom | |
---|---|
name |
Format: name=customers/{customer}/policySchemas/{schema_namespace} |
policyDescription |
Hanya output. Deskripsi tentang skema kebijakan untuk konsumsi pengguna. |
additionalTargetKeyNames[] |
Hanya output. Nama kunci tambahan yang akan digunakan untuk mengidentifikasi target nilai kebijakan. Saat menentukan |
definition |
Definisi skema menggunakan deskriptor proto. |
fieldDescriptions[] |
Hanya output. Deskripsi mendetail dari setiap kolom yang merupakan bagian dari skema. |
accessRestrictions[] |
Hanya output. Pembatasan akses khusus yang terkait dengan kebijakan ini. |
notices[] |
Hanya output. Pesan pemberitahuan khusus terkait penetapan nilai tertentu di kolom tertentu dalam skema. |
supportUri |
Hanya output. URI ke artikel dukungan terkait untuk skema ini. |
schemaName |
Hanya output. Nama skema kebijakan yang sepenuhnya memenuhi syarat. Nilai ini digunakan untuk mengisi kolom |
validTargetResources[] |
Hanya output. Informasi tentang resource target yang berlaku untuk kebijakan. |
policyApiLifecycle |
Hanya output. Informasi siklus proses saat ini. |
categoryTitle |
Judul kategori untuk setelan. |
AdditionalTargetKeyName
Nama kunci tambahan yang akan digunakan untuk mengidentifikasi target nilai kebijakan.
Representasi JSON |
---|
{ "key": string, "keyDescription": string } |
Kolom | |
---|---|
key |
Nama kunci. |
keyDescription |
Deskripsi kunci. |
FileDescriptorProto
Menjelaskan file .proto yang lengkap.
Representasi JSON |
---|
{ "name": string, "package": string, "messageType": [ { object ( |
Kolom | |
---|---|
name |
nama file, relatif terhadap akar pohon sumber |
package |
mis. "foo", "foo.bar", dll. |
messageType[] |
Semua definisi tingkat atas dalam file ini. |
enumType[] |
|
syntax |
Sintaksis file proto. Nilai yang didukung adalah "proto2", "proto3", dan "editions". Jika |
DescriptorProto
Menjelaskan jenis pesan.
Representasi JSON |
---|
{ "name": string, "field": [ { object ( |
Kolom | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
Menjelaskan kolom dalam pesan.
Representasi JSON |
---|
{ "name": string, "number": integer, "label": enum ( |
Kolom | |
---|---|
name |
|
number |
|
label |
|
type |
Jika typeName ditetapkan, kolom ini tidak perlu ditetapkan. Jika kolom ini dan typeName ditetapkan, kolom ini harus berupa salah satu dari TYPE_ENUM, TYPE_MESSAGE, atau TYPE_GROUP. |
typeName |
Untuk jenis pesan dan enum, ini adalah nama jenisnya. Jika nama diawali dengan '.', berarti nama tersebut sepenuhnya memenuhi syarat. Jika tidak, aturan cakupan seperti C++ digunakan untuk menemukan jenis (yaitu pertama, jenis bertingkat dalam pesan ini ditelusuri, kemudian dalam induk, hingga namespace root). |
defaultValue |
Untuk tipe numerik, berisi representasi teks asli dari nilai. Untuk boolean, "true" atau "false". Untuk string, berisi konten teks default (tidak di-escape dengan cara apa pun). Untuk byte, berisi nilai escape C. Semua byte >= 128 akan di-escape. |
oneofIndex |
Jika ditetapkan, akan memberikan indeks oneof dalam daftar oneofDecl jenis yang memuatnya. Kolom ini adalah anggota dari salah satu kolom tersebut. |
jsonName |
Nama JSON kolom ini. Nilai ditetapkan oleh compiler protokol. Jika pengguna telah menetapkan opsi "jsonName" di kolom ini, nilai opsi tersebut akan digunakan. Jika tidak, data akan disimpulkan dari nama kolom dengan mengonversinya menjadi camelCase. |
proto3Optional |
Jika true (benar), ini adalah proto3 "opsional". Jika kolom proto3 bersifat opsional, kolom tersebut akan melacak kehadiran terlepas dari jenis kolomnya. Jika proto3Optional bernilai benar, kolom ini harus menjadi milik oneof untuk memberi tahu klien proto3 lama bahwa kehadirannya dilacak untuk kolom ini. Kolom ini dikenal sebagai salah satu objek "sintetik", dan kolom ini harus menjadi satu-satunya anggotanya (setiap kolom opsional proto3 mendapatkan kolom sintetisnya sendiri). Salah satu dari sintetis hanya ada dalam deskriptor, dan tidak menghasilkan API apa pun. Salah satu foto sintetis harus dipesan setelah semua yang "sungguhan". Untuk kolom pesan, proto3Optional tidak membuat perubahan semantik apa pun, karena kolom pesan yang tidak berulang selalu melacak kehadiran. Namun, kode ini masih menunjukkan detail semantik terkait apakah pengguna menulis "opsional" atau tidak. Hal ini dapat berguna untuk bolak-balik {i>file<i} .proto. Agar konsisten, kami juga memberikan kolom pesan yang sintetis, meskipun tidak diperlukan untuk melacak keberadaannya. Hal ini sangat penting karena parser tidak dapat mengetahui apakah kolom merupakan pesan atau enum, sehingga parser harus selalu membuat yang sintetis. Kolom opsional Proto2 tidak menetapkan tanda ini, karena sudah menunjukkan opsional dengan |
Label
Enum | |
---|---|
LABEL_OPTIONAL |
0 disimpan untuk error |
LABEL_REQUIRED |
|
LABEL_REPEATED |
Jenis
Enum | |
---|---|
TYPE_DOUBLE |
0 dicadangkan untuk error. Pesanan aneh karena alasan historis. |
TYPE_FLOAT |
|
TYPE_INT64 |
Tidak dienkode ZigZag. Angka negatif memerlukan 10 byte. Gunakan TYPE_SINT64 jika kemungkinan nilai negatif. |
TYPE_UINT64 |
|
TYPE_INT32 |
Tidak dienkode ZigZag. Angka negatif memerlukan 10 byte. Gunakan TYPE_SINT32 jika kemungkinan nilai negatif. |
TYPE_FIXED64 |
|
TYPE_FIXED32 |
|
TYPE_BOOL |
|
TYPE_STRING |
|
TYPE_GROUP |
Agregat yang dibatasi tag. Jenis grup tidak digunakan lagi dan tidak didukung di proto3. Namun, implementasi Proto3 harus tetap dapat mengurai format wire grup dan memperlakukan kolom grup sebagai kolom yang tidak diketahui. |
TYPE_MESSAGE |
Agregat yang dibatasi panjang. |
TYPE_BYTES |
Yang baru di versi 2. |
TYPE_UINT32 |
|
TYPE_ENUM |
|
TYPE_SFIXED32 |
|
TYPE_SFIXED64 |
|
TYPE_SINT32 |
Menggunakan encoding ZigZag. |
TYPE_SINT64 |
Menggunakan encoding ZigZag. |
EnumDescriptorProto
Menjelaskan jenis enum.
Representasi JSON |
---|
{
"name": string,
"value": [
{
object ( |
Kolom | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
Menjelaskan nilai dalam enum.
Representasi JSON |
---|
{ "name": string, "number": integer } |
Kolom | |
---|---|
name |
|
number |
|
OneofDescriptorProto
Menjelaskan salah satunya.
Representasi JSON |
---|
{ "name": string } |
Kolom | |
---|---|
name |
|
PolicySchemaFieldDescription
Memberikan informasi mendetail untuk kolom tertentu yang merupakan bagian dari PolicySchema.
Representasi JSON |
---|
{ "field": string, "description": string, "inputConstraint": string, "knownValueDescriptions": [ { object ( |
Kolom | |
---|---|
field |
Hanya output. Nama kolom yang dikaitkan dengan deskripsi ini. |
description |
Tidak digunakan lagi. Sebagai gantinya, gunakan name dan fieldDescription. Deskripsi untuk kolom. |
inputConstraint |
Hanya output. Batasan input apa pun yang terkait dengan nilai untuk kolom. |
knownValueDescriptions[] |
Hanya output. Jika kolom memiliki kumpulan nilai yang diketahui, kolom ini akan memberikan deskripsi untuk nilai tersebut. |
nestedFieldDescriptions[] |
Hanya output. Memberikan deskripsi kolom bertingkat di kolom ini, jika kolom berupa jenis pesan yang menentukan beberapa kolom. |
fieldDependencies[] |
Hanya output. Memberikan daftar kolom dan nilai. Setidaknya salah satu kolom harus memiliki nilai yang sesuai agar kolom ini dapat ditetapkan. |
requiredItems[] |
Hanya output. Memberikan daftar kolom yang harus ditetapkan jika kolom ini memiliki nilai tertentu. |
defaultValue |
Hanya output. Klien default jika kebijakan tidak disetel. |
name |
Hanya output. Nama kolom. |
fieldDescription |
Hanya output. Deskripsi kolom. |
fieldConstraints |
Hanya output. Informasi tentang batasan input yang terkait dengan nilai untuk kolom. |
PolicySchemaFieldKnownValueDescription
Memberikan informasi mendetail tentang nilai yang diketahui yang diizinkan untuk kolom tertentu dalam PolicySchema.
Representasi JSON |
---|
{ "value": string, "description": string } |
Kolom | |
---|---|
value |
Hanya output. Representasi string nilai yang dapat ditetapkan untuk kolom. |
description |
Hanya output. Deskripsi tambahan untuk nilai ini. |
PolicySchemaFieldDependencies
Kolom dan nilai yang harus dimiliki agar kolom lain dapat ditetapkan.
Representasi JSON |
---|
{ "sourceField": string, "sourceFieldValue": string } |
Kolom | |
---|---|
sourceField |
Kolom sumber yang menjadi dependensi kolom ini. |
sourceFieldValue |
Nilai yang harus dimiliki kolom sumber agar kolom ini dapat ditetapkan. |
PolicySchemaRequiredItems
Kolom yang akan wajib diisi berdasarkan nilai kolom ini.
Representasi JSON |
---|
{ "fieldConditions": [ string ], "requiredFields": [ string ] } |
Kolom | |
---|---|
fieldConditions[] |
Nilai kolom yang memicu penerapan kolom yang diwajibkan. fieldConditions kosong menyiratkan bahwa nilai apa pun yang ditetapkan ke kolom ini akan memicu penerapan kolom yang wajib diisi. |
requiredFields[] |
Kolom yang wajib diisi sebagai konsekuensi dari kondisi kolom. |
FieldConstraints
Informasi tentang batasan rentang.
Representasi JSON |
---|
{ "numericRangeConstraint": { object ( |
Kolom | |
---|---|
numericRangeConstraint |
Rentang yang diizinkan untuk bidang angka. |
uploadedFileConstraints |
Batasan pada file yang diupload dari kebijakan file. Jika ada, kebijakan ini memerlukan URL yang bisa diambil dengan mengupload file dengan batasan yang ditentukan dalam proto ini. |
NumericRangeConstraint
Batasan pada batas atas dan/atau bawah, dengan minimal satu batasan ditetapkan.
Representasi JSON |
---|
{ "minimum": string, "maximum": string } |
Kolom | |
---|---|
minimum |
Nilai minimum. |
maximum |
Nilai maksimum. |
UploadedFileConstraints
Batasan pada file yang diupload dari kebijakan file.
Representasi JSON |
---|
{
"supportedContentTypes": [
enum ( |
Kolom | |
---|---|
supportedContentTypes[] |
Jenis file yang dapat diupload untuk setelan. |
sizeLimitBytes |
Batas ukuran file yang diupload untuk suatu setelan, dalam byte. |
ContentType
Jenis file yang dapat diupload untuk setelan.
Enum | |
---|---|
CONTENT_TYPE_UNSPECIFIED |
Jenis konten tidak ditentukan. |
CONTENT_TYPE_PLAIN_TEXT |
Teks biasa. |
CONTENT_TYPE_HTML |
HTML. |
CONTENT_TYPE_IMAGE_JPEG |
JPEG. |
CONTENT_TYPE_IMAGE_GIF |
GIF. |
CONTENT_TYPE_IMAGE_PNG |
PNG. |
CONTENT_TYPE_JSON |
. |
CONTENT_TYPE_ZIP |
kode pos. |
CONTENT_TYPE_GZIP |
GZIP. |
CONTENT_TYPE_CSV |
CSV. |
CONTENT_TYPE_YAML |
YAML. |
CONTENT_TYPE_IMAGE_WEBP |
WEBP. |
PolicySchemaNoticeDescription
Memberikan pesan pemberitahuan khusus yang terkait dengan nilai tertentu dalam kolom yang merupakan bagian dari PolicySchema.
Representasi JSON |
---|
{ "field": string, "noticeValue": string, "noticeMessage": string, "acknowledgementRequired": boolean } |
Kolom | |
---|---|
field |
Hanya output. Nama kolom yang terkait dengan pemberitahuan. |
noticeValue |
Hanya output. Nilai kolom yang memiliki pemberitahuan. Saat menetapkan kolom ke nilai ini, pengguna mungkin perlu mengonfirmasi pesan pemberitahuan agar nilai dapat ditetapkan. |
noticeMessage |
Hanya output. Pesan pemberitahuan yang terkait dengan nilai kolom. |
acknowledgementRequired |
Hanya output. Apakah pengguna perlu mengonfirmasi pesan pemberitahuan sebelum nilai dapat ditetapkan. |
TargetResource
Jenis resource target
Enum | |
---|---|
TARGET_RESOURCE_UNSPECIFIED |
Resource target tidak ditentukan. |
ORG_UNIT |
Resource target Unit Organisasi. |
GROUP |
Mengelompokkan resource target. |
PolicyApiLifecycle
Representasi JSON |
---|
{ "policyApiLifecycleStage": enum ( |
Kolom | |
---|---|
policyApiLifecycleStage |
Menunjukkan tahap siklus proses API kebijakan saat ini. |
description |
Deskripsi tentang siklus proses saat ini. |
endSupport |
Tanggal akhir dukungan untuk kebijakan saat ini. |
deprecatedInFavorOf[] |
Jika kebijakan ini tidak digunakan lagi dan digantikan dengan kebijakan lain, namespace kebijakan baru yang sepenuhnya memenuhi syarat akan ditampilkan di PolicyAPI. |
PolicyApiLifecycleEnum
Enum | |
---|---|
API_UNSPECIFIED |
tidak ditentukan. |
API_PREVIEW |
Kebijakan belum berfungsi, tetapi kami akan memberi tahu developer mengenai formatnya. Tahap ini dapat ditransfer ke API_DEVELOPEMNT atau API_CURRENT. |
API_DEVELOPMENT |
Kebijakan dapat mengubah format dengan cara yang tidak kompatibel dengan versi sebelumnya (perubahan yang dapat menyebabkan gangguan). Tahap ini dapat ditransfer ke API_CURRENT atau API_DEPRECATED. Ini dapat digunakan untuk kebijakan yang diluncurkan hanya untuk TT atau diluncurkan ke pelanggan tertentu untuk penggunaan darurat. |
API_CURRENT |
Kebijakan dalam format resmi. Kebijakan dapat mengubah format dengan cara yang kompatibel dengan versi sebelumnya (perubahan yang tidak menyebabkan gangguan). Contoh: kebijakan ini dapat memperkenalkan kolom baru, yang dianggap sebagai perubahan yang tidak dapat menyebabkan gangguan, jika mask kolom digunakan dengan benar. Tahap ini dapat ditransfer ke API_DEPRECATED. |
API_DEPRECATED |
Berhenti menggunakan kebijakan ini. Kebijakan ini tidak digunakan lagi dan mungkin/akan dihapus pada masa mendatang. Kemungkinan besar kebijakan baru telah diterapkan untuk menggantikan kebijakan ini. |
Tanggal
Mewakili seluruh atau sebagian tanggal kalender, seperti ulang tahun. Waktu dan zona waktu ditentukan di tempat lain atau tidak signifikan. Tanggal tersebut relatif terhadap Kalender Gregorian. Ini dapat mewakili salah satu hal berikut:
- Tanggal lengkap, dengan nilai tahun, bulan, dan hari bukan nol.
- Bulan dan hari, dengan nol tahun (misalnya, hari jadi).
- Satu tahun saja, dengan bulan nol dan hari nol.
- Tahun dan bulan, dengan nol hari (misalnya, tanggal habis masa berlaku kartu kredit).
Jenis terkait:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Representasi JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Kolom | |
---|---|
year |
Tahun dari tanggal. Harus dari 1 hingga 9999, atau 0 untuk menentukan tanggal tanpa tahun. |
month |
Bulan dalam setahun. Harus dari 1 hingga 12, atau 0 untuk menentukan tahun tanpa bulan dan hari. |
day |
Hari dalam sebulan. Harus dari 1 sampai 31 dan berlaku untuk tahun dan bulan, atau 0 untuk menentukan tahun saja atau tahun dan bulan jika hari dianggap tidak signifikan. |
Metode |
|
---|---|
|
Dapatkan skema kebijakan spesifik untuk pelanggan berdasarkan nama resource-nya. |
|
Mendapatkan daftar skema kebijakan yang cocok dengan nilai filter yang ditentukan untuk pelanggan tertentu. |