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

Biçim: name=customers/{customer}/policySchemas/{schema_namespace}

string

Yalnızca çıkış. Kullanıcı tüketimiyle ilgili politika şemasıyla ilgili açıklama.

object (AdditionalTargetKeyName)

Yalnızca çıkış. Politika değerinin hedefini belirlemek için kullanılacak ek anahtar adları. Bir policyTargetKey belirtirken, burada belirtilen ek anahtarların her birinin additionalTargetKeys haritasına dahil edilmesi gerekir.

object (FileDescriptorProto)

Proto açıklayıcıyı kullanan şema tanımı.

object (PolicySchemaFieldDescription)

Yalnızca çıkış. Şemanın parçası olan her alanın ayrıntılı açıklaması. Alanlar, alan numarasına göre değil, bu listedeki sıralamaya göre görüntülenmeleri önerilir.

string

Yalnızca çıkış. Bu politikayla ilgili belirli erişim kısıtlamaları.

object (PolicySchemaNoticeDescription)

Yalnızca çıkış. Şemadaki belirli alanlarda belirli değerlerin ayarlanmasıyla ilgili özel bildirim mesajları.

string

Yalnızca çıkış. Bu şema için ilgili destek makalesinin URI'si.

string

Yalnızca çıkış. Politika şemasının tam adı. Bu değer, BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies veya BatchDeleteGroupPolicies çağrılırken PolicyValue içindeki policySchema alanını doldurmak için kullanılır.

enum (TargetResource)

Yalnızca çıkış. Politika için geçerli hedef kaynaklar hakkında bilgi.

object (PolicyApiLifecycle)

Yalnızca çıkış. Mevcut yaşam döngüsü bilgileri.

string

Bir ayarın ait olduğu kategorinin başlığı.

enum (Platform)

Yalnızca çıkış. Liste, politikanın yalnızca bu platformlardaki cihazlara/kullanıcılara uygulanacağını belirtir.

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

string

Anahtar adı.

string

Anahtar açıklaması.

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

string

kaynak ağacın köküne göre dosya adı

string

ör. "foo", "foo.bar" vb.

object (DescriptorProto)

Bu dosyadaki tüm üst düzey tanımlar.

object (EnumDescriptorProto)

string

Proto dosyasının söz dizimi. Desteklenen değerler: "proto2", "proto3" ve "editions".

edition mevcutsa bu değer "editions" olmalıdır.

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

typeName ayarlanmışsa bunun ayarlanmasına gerek yoktur. Hem bu hem de typeName ayarlanırsa bu, TYPE_ENUM, TYPE_MESSAGE veya TYPE_GROUP değerlerinden biri olmalıdır.

string

Mesaj ve sıralama türleri için türün adıdır. Ad "." ile başlıyorsa tam olarak kabul edilmektedir. Aksi takdirde, türü bulmak için C++ benzeri kapsam kuralları kullanılır (yani, önce bu iletideki iç içe yerleştirilmiş türler, ardından kök ad alanına kadar üst öğe içinde aranır).

string

Sayısal türlerde, değerin orijinal metin gösterimini içerir. Booleler için "true" veya "false" olarak ayarlayın. Dizelerde, varsayılan metin içeriklerini içerir (hiçbir şekilde çıkış karaktersizdir). Baytlar için, kod dışına alınan C değerini içerir. 128 veya daha büyük tüm baytlar atlanır.

integer

Ayarlanırsa, kapsayıcı türünün oneofDecl listesindekilerden birinin dizinini verir. Bu alan, söz konusu alanın bir üyesidir.

string

Bu alanın JSON adı. Değer, protokol derleyici tarafından ayarlanır. Kullanıcı bir "jsonName" ayarlamışsa seçeneği sunulursa söz konusu seçeneğin değeri kullanılır. Aksi takdirde, alanın adından camelCase'e dönüştürülerek çıkarılır.

boolean

Doğru ise bu bir proto3 "isteğe bağlı"dır. Bir proto3 alanı isteğe bağlı olduğunda alan türünden bağımsız olarak varlığı izler.

proto3Optional değerine ayarlanırsa bu alan için varlığın izlendiğini eski proto3 istemcilerine bildirmek için bu alanın bir tanesine ait olması gerekir. Bu, "sentetik" olarak bilinir. biri ve bu alan kendi tek üyesi olmalıdır (isteğe bağlı her proto3 alanı kendi sentetik alanına sahiptir). Sentetikler yalnızca tanımlayıcıda bulunur ve herhangi bir API oluşturmaz. Yapay olanlar "gerçek"ten sonra sıralanmalıdır biri.

Tekrarlanmayan mesaj alanları varlığı her zaman izlediğinden, mesaj alanlarında proto3Optional herhangi bir anlam değişikliği oluşturmaz. Ancak yine de kullanıcının "isteğe bağlı" yazıp yazmadığına ilişkin anlamsal ayrıntıyı belirtir. hakkında bilgi edindiniz. Bu, .proto dosyasının gidişatı sırasında faydalı olabilir. Tutarlılık amacıyla, varlığı izlemek için gerekli olmasa da mesaj alanlarına sentetik bir alan ekliyoruz. Bu özellikle önemlidir, ayrıştırıcı bir alanın mesaj mı yoksa numaralandırma mı olduğunu belirleyemeyeceği için her zaman sentetik bir alan oluşturmalıdır.

Proto2'deki isteğe bağlı alanlar, zaten LABEL_OPTIONAL ile isteğe bağlı olduğunu belirttiği için bu işareti ayarlamaz.

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

Yalnızca çıkış. Bu açıklamayla ilişkilendirilen alanın adı.

string

Kullanımdan kaldırıldı. Bunun yerine name ve FieldDescription öğelerini kullanın. Alan için açıklama.

string

Yalnızca çıkış. Alanın değerleriyle ilişkili tüm giriş kısıtlamaları.

object (PolicySchemaFieldKnownValueDescription)

Yalnızca çıkış. Alanda bilinen bir değer grubu varsa bu alan, söz konusu değerler için bir açıklama sağlar.

object (PolicySchemaFieldDescription)

Yalnızca çıkış. Alan, birden çok alanı tanımlayan bir mesaj türüyse bu alanda iç içe yerleştirilmiş alanların açıklamasını sağlar. Alanlar, alan numarasına göre değil, bu listedeki sıralamaya göre görüntülenmeleri önerilir.

object (PolicySchemaFieldDependencies)

Yalnızca çıkış. Alanların ve değerlerin listesini sağlar. Bu alanın ayarlanmasına izin verilebilmesi için alanlardan en az birinin karşılık gelen değere sahip olması gerekir.

object (PolicySchemaRequiredItems)

Yalnızca çıkış. Bu alanda belirli bir değer varsa ayarlanması gereken alanların listesini sağlar.

value (Value format)

Yalnızca çıkış. Politika ayarlanmazsa istemci varsayılanı.

string

Yalnızca çıkış. Alanın adı.

string

Yalnızca çıkış. Alanın açıklaması.

object (FieldConstraints)

Yalnızca çıkış. Alana ilişkin değerlerle ilişkili herhangi bir giriş kısıtlaması hakkındaki bilgiler.

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

string

Yalnızca çıkış. Alan için ayarlanabilecek değerin dize gösterimi.

string

Yalnızca çıkış. Bu değer için ek açıklama.

object (PolicySchemaFieldDependencies)

Yalnızca çıkış. Bu değerin geçerli olması için alan koşulları gerekli.

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

string

Bu alanın bağlı olduğu kaynak alan.

string

Bu alanın ayarlanmasına izin verilmesi için kaynak alanda olması gereken değer.

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

string

Zorunlu alan yaptırımını tetikleyen alanın değerleri. Boş bir FieldConditions, bu alana atanan herhangi bir değerin zorunlu alan yaptırımını tetikleyeceği anlamına gelir.

string

Alan koşullarının sonucu olarak zorunlu olan alanlar.

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

object (NumericRangeConstraint)

Sayısal alanlar için izin verilen aralık.

object (UploadedFileConstraints)

Bir dosya politikasının yüklenen dosyasıyla ilgili kısıtlamalar. Varsa bu politika, bu protokolde belirtilen kısıtlamalara sahip bir dosya yükleyerek getirilebilecek bir URL gerektirir.

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

string (int64 format)

Minimum değer.

string (int64 format)

Maksimum değer.

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

enum (ContentType)

Bir ayar için yüklenebilecek dosya türleri.

string (int64 format)

Bir ayar için yüklenen dosyaların bayt cinsinden boyut sınırı.

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

string

Yalnızca çıkış. Bildirimle ilişkili alan adı.

string

Yalnızca çıkış. Bildirim içeren alanın değeri. Alan bu değere ayarlanırken değerin ayarlanması için kullanıcının bildirim mesajını onaylaması gerekebilir.

string

Yalnızca çıkış. Alanın değeriyle ilişkilendirilen bildirim mesajı.

boolean

Yalnızca çıkış. Değerin ayarlanabilmesi için kullanıcının bildirim mesajını onaylamasının gerekip gerekmediği.

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

string

Bu politikanın kullanımdan kaldırılması ve başka bir politikanın tercih edilmesi halinde, yeni politikaların PolicyAPI'de gösterileceği şekliyle tam nitelikli ad alanları. Yalnızca policyApiLifecycleStage API_DEPRECATED ise ayarlanabilir.

string

Kullanımdan kaldırılan InFavorOf'a karşılık olarak, bu politikanın yürürlüğe girmesi nedeniyle kullanımdan kaldırılacak eski politikaların tam nitelikli ad alanları.

enum (PolicyApiLifecycleEnum)

Policy API'nin mevcut yaşam döngüsü aşamasını belirtir.

string

Mevcut yaşam döngüsüyle ilgili açıklama.

object (Date)

Mevcut politikanın desteklenme tarihi. Bir politikayı, destek bitiş tarihinden sonra değiştirmeye çalışırsanız Hatalı İstek (400 hatası) alırsınız. Yalnızca policyApiLifecycleStage API_DEPRECATED ise ayarlanabilir.

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

integer

Tarihin yılı. 1 ile 9999 arasında veya yıl içermeyen bir tarihi belirtmek için 0 arasında olmalıdır.

integer

Bir yılın ayı. 1 ile 12 arasında veya ay ve gün içermeyen bir yılı belirtmek için 0 arasında olmalıdır.

integer

Ayın günü. 1 ile 31 arasında bir değer olmalı ve yıl ve ay için geçerlidir. Tek başına bir yılı ya da günün önemli olmadığı bir yılı ve ayı belirtmek için 0 değeri girilmelidir.