REST Resource: customers.policySchemas

Resource: PolicySchema

Resource yang merepresentasikan skema kebijakan.

Representasi 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
}
Kolom
name

string

Format: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Hanya output. Deskripsi tentang skema kebijakan untuk konsumsi pengguna.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Hanya output. Nama kunci tambahan yang akan digunakan untuk mengidentifikasi target nilai kebijakan. Saat menentukan policyTargetKey, setiap kunci tambahan yang ditentukan di sini harus disertakan dalam peta additionalTargetKeys.
definition

object (FileDescriptorProto)

Definisi skema menggunakan deskriptor proto.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Hanya output. Deskripsi mendetail dari setiap kolom yang merupakan bagian dari skema.
accessRestrictions[]

string

Hanya output. Pembatasan akses khusus yang terkait dengan kebijakan ini.
notices[]

object (PolicySchemaNoticeDescription)

Hanya output. Pesan pemberitahuan khusus terkait penetapan nilai tertentu di kolom tertentu dalam skema.
supportUri

string

Hanya output. URI ke artikel dukungan terkait untuk skema ini.
schemaName

string

Hanya output. Nama skema kebijakan yang sepenuhnya memenuhi syarat. Nilai ini digunakan untuk mengisi kolom policySchema di PolicyValue saat memanggil orgunits.batchInherit orgunits.batchModify groups.batchModify atau groups.batchDelete.
validTargetResources[]

enum (TargetResource)

Hanya output. Informasi tentang resource target yang berlaku untuk kebijakan.
policyApiLifecycle

object (PolicyApiLifecycle)

Hanya output. Informasi siklus proses saat ini.
categoryTitle

string

Judul kategori untuk setelan.

AdditionalTargetKeyName

Nama kunci tambahan yang akan digunakan untuk mengidentifikasi target nilai kebijakan.

Representasi JSON 
{
  "key": string,
  "keyDescription": string
}
Kolom
key

string

Nama kunci.
keyDescription

string

Deskripsi kunci.

FileDescriptorProto

Menjelaskan file .proto yang lengkap.

Representasi JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
Kolom
name

string

nama file, relatif terhadap akar pohon sumber
package

string

mis. "foo", "foo.bar", dll.
messageType[]

object (DescriptorProto)

Semua definisi tingkat atas dalam file ini.
enumType[]

object (EnumDescriptorProto)
syntax

string

Sintaksis file proto. Nilai yang didukung adalah "proto2", "proto3", dan "editions".

Jika edition ada, nilai ini harus berupa "edisi".

DescriptorProto

Menjelaskan jenis pesan.

Representasi JSON 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Kolom
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Menjelaskan kolom dalam pesan.

Representasi JSON 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Kolom
name

string
number

integer
label

enum (Label)
type

enum (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

string

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

string

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

integer

Jika ditetapkan, akan memberikan indeks oneof dalam daftar oneofDecl jenis yang memuatnya. Kolom ini adalah anggota dari salah satu kolom tersebut.
jsonName

string

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

boolean

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_OPTIONAL.

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 (EnumValueDescriptorProto)
    }
  ]
}
Kolom
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Menjelaskan nilai dalam enum.

Representasi JSON 
{
  "name": string,
  "number": integer
}
Kolom
name

string
number

integer

OneofDescriptorProto

Menjelaskan salah satunya.

Representasi JSON 
{
  "name": string
}
Kolom
name

string

PolicySchemaFieldDescription

Memberikan informasi mendetail untuk kolom tertentu yang merupakan bagian dari PolicySchema.

Representasi 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)
  }
}
Kolom
field

string

Hanya output. Nama kolom yang dikaitkan dengan deskripsi ini.
description
(deprecated)

string

Tidak digunakan lagi. Sebagai gantinya, gunakan name dan fieldDescription. Deskripsi untuk kolom.
inputConstraint

string

Hanya output. Batasan input apa pun yang terkait dengan nilai untuk kolom.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Hanya output. Jika kolom memiliki kumpulan nilai yang diketahui, kolom ini akan memberikan deskripsi untuk nilai tersebut.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Hanya output. Memberikan deskripsi kolom bertingkat di kolom ini, jika kolom berupa jenis pesan yang menentukan beberapa kolom.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Hanya output. Memberikan daftar kolom dan nilai. Setidaknya salah satu kolom harus memiliki nilai yang sesuai agar kolom ini dapat ditetapkan.
requiredItems[]

object (PolicySchemaRequiredItems)

Hanya output. Memberikan daftar kolom yang harus ditetapkan jika kolom ini memiliki nilai tertentu.
defaultValue

value (Value format)

Hanya output. Klien default jika kebijakan tidak disetel.
name

string

Hanya output. Nama kolom.
fieldDescription

string

Hanya output. Deskripsi kolom.
fieldConstraints

object (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

string

Hanya output. Representasi string nilai yang dapat ditetapkan untuk kolom.
description

string

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

string

Kolom sumber yang menjadi dependensi kolom ini.
sourceFieldValue

string

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[]

string

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[]

string

Kolom yang wajib diisi sebagai konsekuensi dari kondisi kolom.

FieldConstraints

Informasi tentang batasan rentang.

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

object (NumericRangeConstraint)

Rentang yang diizinkan untuk bidang angka.
uploadedFileConstraints

object (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

string (int64 format)

Nilai minimum.
maximum

string (int64 format)

Nilai maksimum.

UploadedFileConstraints

Batasan pada file yang diupload dari kebijakan file.

Representasi JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Kolom
supportedContentTypes[]

enum (ContentType)

Jenis file yang dapat diupload untuk setelan.
sizeLimitBytes

string (int64 format)

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

string

Hanya output. Nama kolom yang terkait dengan pemberitahuan.
noticeValue

string

Hanya output. Nilai kolom yang memiliki pemberitahuan. Saat menetapkan kolom ke nilai ini, pengguna mungkin perlu mengonfirmasi pesan pemberitahuan agar nilai dapat ditetapkan.
noticeMessage

string

Hanya output. Pesan pemberitahuan yang terkait dengan nilai kolom.
acknowledgementRequired

boolean

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 (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
Kolom
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Menunjukkan tahap siklus proses API kebijakan saat ini.
description

string

Deskripsi tentang siklus proses saat ini.
endSupport

object (Date)

Tanggal akhir dukungan untuk kebijakan saat ini.
deprecatedInFavorOf[]

string

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:

Representasi JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Kolom
year

integer

Tahun dari tanggal. Harus dari 1 hingga 9999, atau 0 untuk menentukan tanggal tanpa tahun.
month

integer

Bulan dalam setahun. Harus dari 1 hingga 12, atau 0 untuk menentukan tahun tanpa bulan dan hari.
day

integer

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

get

 Dapatkan skema kebijakan spesifik untuk pelanggan berdasarkan nama resource-nya.

list

 Mendapatkan daftar skema kebijakan yang cocok dengan nilai filter yang ditentukan untuk pelanggan tertentu.