REST Resource: customers.policySchemas

{
  "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,
  "supportedPlatforms": [
    enum (Platform)
  ]
}

string

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

string

Hanya output. Deskripsi skema kebijakan untuk konsumsi pengguna.

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.

object (FileDescriptorProto)

Definisi skema menggunakan deskriptor proto.

object (PolicySchemaFieldDescription)

Hanya output. Deskripsi mendetail tentang setiap kolom yang merupakan bagian dari skema. Kolom direkomendasikan untuk ditampilkan menurut urutan dalam daftar ini, bukan berdasarkan nomor kolom.

string

Hanya output. Batasan akses khusus yang terkait dengan kebijakan ini.

object (PolicySchemaNoticeDescription)

Hanya output. Pesan pemberitahuan khusus yang terkait dengan setelan nilai tertentu di kolom tertentu dalam skema.

string

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

string

Hanya output. Nama skema kebijakan yang sepenuhnya memenuhi syarat. Nilai ini digunakan untuk mengisi kolom policySchema di PolicyValue saat memanggil BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies atau BatchDeleteGroupPolicies.

enum (TargetResource)

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

object (PolicyApiLifecycle)

Hanya output. Informasi siklus proses saat ini.

string

Judul kategori tempat setelan berada.

enum (Platform)

Hanya output. Daftar ini menunjukkan bahwa kebijakan hanya akan berlaku untuk perangkat/pengguna di platform tersebut.

{
  "key": string,
  "keyDescription": string
}

string

Nama kunci.

string

Deskripsi kunci.

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

string

nama file, relatif terhadap akar pohon sumber

string

mis. "foo", "foo.bar", dll.

object (DescriptorProto)

Semua definisi tingkat atas dalam file ini.

object (EnumDescriptorProto)

string

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

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

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

string

object (FieldDescriptorProto)

object (DescriptorProto)

object (EnumDescriptorProto)

object (OneofDescriptorProto)

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

string

integer

enum (Label)

enum (Type)

Jika typeName disetel, ini tidak perlu disetel. Jika ini dan typeName ditetapkan, keduanya harus berupa salah satu dari TYPE_ENUM, TYPE_MESSAGE, atau TYPE_GROUP.

string

Untuk jenis pesan dan enum, ini adalah nama jenis. Jika nama diawali dengan '.', berarti nama tersebut sepenuhnya memenuhi syarat. Jika tidak, aturan pencakupan yang mirip C++ akan digunakan untuk menemukan jenis (yaitu pertama-tama jenis yang disusun bertingkat dalam pesan ini ditelusuri, lalu di dalam induk, hingga namespace root).

string

Untuk jenis 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 di-escape.

integer

Jika ditetapkan, memberikan indeks salah satu dalam daftar oneofDecl jenis yang memuat. Kolom ini adalah anggota dari opsi tersebut.

string

Nama JSON kolom ini. Nilai ditetapkan oleh compiler protokol. Jika pengguna telah menetapkan "jsonName" di kolom ini, nilai opsi tersebut akan digunakan. Jika tidak, data tersebut disimpulkan dari nama kolom dengan mengonversinya menjadi camelCase.

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 salah satu untuk memberi tahu klien proto3 lama bahwa kehadiran dilacak untuk kolom ini. yang satu ini dikenal sebagai satu, dan kolom ini harus merupakan satu-satunya anggotanya (setiap kolom opsional proto3 mendapatkan satu-satunya yang sintetis). Salah satu sintetis hanya ada di deskriptor, dan tidak menghasilkan API apa pun. Produk sintetis harus diurutkan setelah semua kata "asli" satu.

Untuk kolom pesan, proto3Optional tidak membuat perubahan semantik apa pun karena kolom pesan yang tidak berulang selalu melacak kehadiran. Namun, hal ini masih menunjukkan detail semantik tentang apakah pengguna menulis "opsional" atau tidak atau tidak. Ini dapat berguna untuk membulatkan file .proto. Agar konsisten, kami juga memberikan kolom pesan sintetis, meskipun tidak diwajibkan untuk melacak kehadiran. 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.

{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}

string

object (EnumValueDescriptorProto)

{
  "name": string,
  "number": integer
}

string

integer

{
  "name": string
}

string

{
  "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)
  }
}

string

Hanya output. Nama kolom untuk dikaitkan dengan deskripsi ini.

string

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

string

Hanya output. Batasan input apa pun yang terkait dengan nilai kolom.

object (PolicySchemaFieldKnownValueDescription)

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

object (PolicySchemaFieldDescription)

Hanya output. Memberikan deskripsi kolom yang disarangkan dalam kolom ini, jika kolom adalah jenis pesan yang menentukan beberapa kolom. Kolom direkomendasikan untuk ditampilkan menurut urutan dalam daftar ini, bukan berdasarkan nomor kolom.

object (PolicySchemaFieldDependencies)

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

object (PolicySchemaRequiredItems)

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

value (Value format)

Hanya output. Klien akan disetel ke default jika kebijakan tidak disetel.

string

Hanya output. Nama kolom.

string

Hanya output. Deskripsi kolom.

object (FieldConstraints)

Hanya output. Informasi tentang batasan input apa pun yang terkait dengan nilai untuk kolom.

{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}

string

Hanya output. Pengulangan string nilai yang dapat ditetapkan untuk kolom.

string

Hanya output. Deskripsi tambahan untuk nilai ini.

object (PolicySchemaFieldDependencies)

Hanya output. Kondisi kolom yang diperlukan agar nilai ini valid.

{
  "sourceField": string,
  "sourceFieldValue": string
}

string

Kolom sumber tempat kolom ini bergantung.

string

Nilai yang harus dimiliki kolom sumber agar kolom ini diizinkan untuk ditetapkan.

{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}

string

Nilai kolom yang memicu penerapan kolom wajib diisi. fieldConditions kosong menyiratkan bahwa nilai apa pun yang ditetapkan ke kolom ini akan memicu penerapan kolom yang diperlukan.

string

Kolom yang wajib diisi sebagai konsekuensi kondisi kolom.

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

object (NumericRangeConstraint)

Rentang yang diizinkan untuk bidang angka.

object (UploadedFileConstraints)

Batasan pada file kebijakan file yang diupload. Jika ada, kebijakan ini memerlukan URL yang dapat diambil dengan mengupload file dengan batasan yang ditentukan dalam proto ini.

{
  "minimum": string,
  "maximum": string
}

string (int64 format)

Nilai minimum.

string (int64 format)

Nilai maksimum.

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

enum (ContentType)

Jenis file yang dapat diupload untuk setelan.

string (int64 format)

Batas ukuran file yang diupload untuk sebuah setelan, dalam byte.

{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}

string

Hanya output. Nama kolom yang terkait dengan pemberitahuan.

string

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

string

Hanya output. Pesan pemberitahuan dikaitkan dengan nilai kolom.

boolean

Hanya output. Apakah pengguna perlu mengonfirmasi pesan pemberitahuan sebelum nilainya dapat ditetapkan.

{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}

string

Jika kebijakan ini tidak digunakan lagi dan digantikan dengan kebijakan lain, namespace kebijakan baru yang sepenuhnya memenuhi syarat seperti yang akan ditampilkan di PolicyAPI. Hanya dapat disetel jika policyApiLifecycleStage adalah API_DEPRECATED.

string

Sesuai dengan kebijakan yang tidak digunakan lagi, namespace kebijakan lama yang sepenuhnya memenuhi syarat dan tidak akan digunakan lagi karena diperkenalkannya kebijakan ini.

enum (PolicyApiLifecycleEnum)

Menunjukkan tahap siklus proses API kebijakan saat ini.

string

Deskripsi tentang siklus proses saat ini.

object (Date)

Tanggal dukungan berakhir untuk kebijakan saat ini. Mencoba mengubah kebijakan setelah tanggal dukungan akhirnya akan menghasilkan Permintaan Buruk (error 400). Hanya dapat disetel jika policyApiLifecycleStage adalah API_DEPRECATED.

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

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

integer

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

integer

Hari dalam sebulan. Harus dari 1 hingga 31 dan berlaku untuk tahun dan bulan, atau 0 untuk menentukan tahun saja atau tahun dan bulan jika hari dianggap tidak signifikan.