REST Resource: customers.policySchemas

Kaynak: PolicySchema

Bir politika şemasını temsil eden kaynak.

JSON gösterimi 
{
  "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
}
Alanlar
name

string

Biçim: ad=customer/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Yalnızca çıkış. Kullanıcı tüketimi için politika şemasıyla ilgili açıklama.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

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

object (FileDescriptorProto)

Proto açıklayıcı kullanılan şema tanımı.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Yalnızca çıkış. Şemanın parçası olan her alanın ayrıntılı açıklaması.
accessRestrictions[]

string

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

object (PolicySchemaNoticeDescription)

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

string

Yalnızca çıkış. Bu şemayla ilgili ilgili destek makalesinin URI'si.
schemaName

string

Yalnızca çıkış. Politika şemasının tam adı. Bu değer, orgunits.batchInherit orgunits.batchModify groups.batchModify veya groups.batchDelete çağrılırken PolicyValue içindeki policySchema alanını doldurmak için kullanılır.
validTargetResources[]

enum (TargetResource)

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

object (PolicyApiLifecycle)

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

string

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

AdditionalTargetKeyName

Politika değerinin hedefini tanımlamak için kullanılacak ek anahtar adları.

JSON gösterimi 
{
  "key": string,
  "keyDescription": string
}
Alanlar
key

string

Anahtar adı.
keyDescription

string

Anahtar açıklaması.

FileDescriptorProto

Eksiksiz bir .proto dosyasını açıklar.

JSON gösterimi 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string
}
Alanlar
name

string

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

string

ör. "foo", "foo.bar" vb.
messageType[]

object (DescriptorProto)

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

object (EnumDescriptorProto)
syntax

string

Proto dosyasının söz dizimi. "proto2", "proto3" ve "editions" değerleri desteklenir.

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

DescriptorProto

Mesaj türünü açıklar.

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

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Bir iletideki alanı açıklar.

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

string
number

integer
label

enum (Label)
type

enum (Type)

typeName ayarlanırsa bunun ayarlanması gerekmez. Hem bu hem de typeName ayarlanırsa bu, TYPE_ENUM, TYPE_MESSAGE veya TYPE_GROUP olmalıdır.
typeName

string

Bu, ileti ve numaralandırma türleri için türün adıdır. Ad, '.' ile başlıyorsa tam niteliklidir. 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 aranır, ardından üst öğe içinde kök ad alanına kadar kullanılır).
defaultValue

string

Sayısal türler için değerin orijinal metin temsilini içerir. Boole için "true" veya "false". Dizeler için, varsayılan metin içeriklerini içerir (hiçbir şekilde çıkış yapılmaz). Baytlar için ise C çıkışlı değerini içerir. 128'den büyük tüm baytlar çıkış yapılır.
oneofIndex

integer

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

string

Bu alanın JSON adı. Değer, protokol derleyici tarafından ayarlanır. Kullanıcı bu alanda bir "jsonName" seçeneği ayarladıysa bu seçeneğin değeri kullanılır. Aksi takdirde, alan adından deve örneğine dönüştürülerek çıkartılır.
proto3Optional

boolean

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

proto3Optional değerine ayarlandığında bu alan, eski proto3 istemcilerine bu alan için varlığın izlendiğini belirtmek üzere bir alana ait olmalıdır. Bu alan "sentetik" alan olarak bilinir ve bu alanın tek üyesi olmalıdır (isteğe bağlı her proto3 alanı kendi sentetik alan adına sahip olur). Sentetik olanlardan biri yalnızca açıklayıcıda bulunur ve herhangi bir API oluşturmaz. Sentetik öğeler, tüm "gerçek" öğelerden sonra sıralanmalıdır.

Yinelenmeyen mesaj alanları varlığı her zaman izlediğinden, mesaj alanlarında proto3Optional, herhangi bir anlamsal değişiklik oluşturmaz. Yine de kullanıcının "isteğe bağlı" yazıp yazmadığına ilişkin anlamsal ayrıntıyı gösterir. Bu, .proto dosyasını geri alırken yararlı olabilir. Kullanıcının varlığını izlemek için gerekli olmamasına rağmen, tutarlılık sağlamak amacıyla mesaj alanlarına da sentetik bir yöntem sunarız. Bu, özellikle ayrıştırıcı bir alanın ileti mi yoksa numaralama mı olduğunu belirleyemeyeceğinden her zaman sentetik bir alan oluşturması gerekir.

Proto2 isteğe bağlı alanları, LABEL_OPTIONAL ile zaten isteğe bağlı olarak gösterildiğinden bu işareti ayarlamaz.

Etiket

Sıralamalar
LABEL_OPTIONAL 0, hatalar için ayrılmıştır
LABEL_REQUIRED
LABEL_REPEATED

Tür

Sıralamalar
TYPE_DOUBLE 0, hatalar için ayrılmıştır. Sıra, geçmişe dönük nedenlerden dolayı tuhaf.
TYPE_FLOAT
TYPE_INT64 ZigZag kodlamalı değil. Negatif sayılar 10 bayt alır. Negatif değerler olasılığı varsa TYPE_SINT64 değerini kullanın.
TYPE_UINT64
TYPE_INT32 ZigZag kodlamalı değil. Negatif sayılar 10 bayt alır. Negatif değerler olasılığı varsa TYPE_SINT32 değerini kullanın.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Etiketle ayrılmış toplama. Grup türü kullanımdan kaldırıldı ve proto3'te desteklenmiyor. Ancak Proto3 uygulamalarının grup kablosu biçimini ayrıştırabilmesi ve grup alanlarını bilinmeyen alanlar olarak işleyebilmesi gerekir.
TYPE_MESSAGE Uzunlukla ayrılmış toplam.
TYPE_BYTES Sürüm 2'deki yenilikler.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 ZigZag kodlamasını kullanır.
TYPE_SINT64 ZigZag kodlamasını kullanır.

EnumDescriptorProto

Bir enum türünü açıklar.

JSON gösterimi 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Alanlar
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Bir enum içindeki değeri tanımlar.

JSON gösterimi 
{
  "name": string,
  "number": integer
}
Alanlar
name

string
number

integer

OneofDescriptorProto

Bunlardan birini tanımlar.

JSON gösterimi 
{
  "name": string
}
Alanlar
name

string

PolicySchemaFieldDescription

PolicySchema'nın parçası olan belirli bir alanla ilgili ayrıntılı bilgi sağlar.

JSON gösterimi 
{
  "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)
  }
}
Alanlar
field

string

Yalnızca çıkış. Bu açıklamayla ilişkili alanın adı.
description
(deprecated)

string

Kullanımdan kaldırıldı. Bunun yerine name ve fieldDescription alanını kullanın. Alanın açıklaması.
inputConstraint

string

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

object (PolicySchemaFieldKnownValueDescription)

Yalnızca çıkış. Alanda bilinen bir değerler grubu varsa bu alan, bu değerler için bir açıklama sağlar.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Yalnızca çıkış. Alan birden fazla alan tanımlayan bir mesaj türündeyse bu alanda iç içe yerleştirilmiş alanların açıklamasını sağlar.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

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

object (PolicySchemaRequiredItems)

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

value (Value format)

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

string

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

string

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

object (FieldConstraints)

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

PolicySchemaFieldKnownValueDescription

PolicySchema'daki belirli bir alan için izin verilen bilinen bir değer hakkında ayrıntılı bilgi sağlar.

JSON gösterimi 
{
  "value": string,
  "description": string
}
Alanlar
value

string

Yalnızca çıkış. Alan için ayarlanabilecek değerin dize yeniden öngörmesi.
description

string

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

PolicySchemaFieldDependencies

Başka bir alanın ayarlanmasına izin vermek için alan ve sahip olması gereken değer.

JSON gösterimi 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Alanlar
sourceField

string

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

string

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

PolicySchemaRequiredItems

Bu alanın değerine göre zorunlu hâle gelecek alanlar.

JSON gösterimi 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Alanlar
fieldConditions[]

string

Zorunlu alan yaptırımını tetikleyen alan değerleri. FieldConditions alanının boş olması, bu alana atanan herhangi bir değerin zorunlu alan yaptırımını tetikleyeceğini belirtir.
requiredFields[]

string

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

FieldConstraints

Aralık kısıtlamalarıyla ilgili bilgiler.

JSON gösterimi 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Alanlar
numericRangeConstraint

object (NumericRangeConstraint)

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

object (UploadedFileConstraints)

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

NumericRangeConstraint

En az birinin ayarlandığı, üst ve/veya alt sınırlardaki bir kısıtlama.

JSON gösterimi 
{
  "minimum": string,
  "maximum": string
}
Alanlar
minimum

string (int64 format)

Minimum değer.
maximum

string (int64 format)

Maksimum değer.

UploadedFileConstraints

Bir dosya politikasının yüklenen dosyasındaki kısıtlamalar.

JSON gösterimi 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Alanlar
supportedContentTypes[]

enum (ContentType)

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

string (int64 format)

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

ContentType

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

Sıralamalar
CONTENT_TYPE_UNSPECIFIED Belirtilmemiş içerik türü.
CONTENT_TYPE_PLAIN_TEXT Düz metin.
CONTENT_TYPE_HTML HTML'yi seçin.
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF GIF olarak kaydedildiğinden emin olun.
CONTENT_TYPE_IMAGE_PNG .PNG.
CONTENT_TYPE_JSON JSON biçiminde olmalıdır.
CONTENT_TYPE_ZIP Posta kodu.
CONTENT_TYPE_GZIP GZIP.
CONTENT_TYPE_CSV CSV dosyası olarak kaydedin.
CONTENT_TYPE_YAML YAML
CONTENT_TYPE_IMAGE_WEBP WEBP.

PolicySchemaNoticeDescription

PolicySchema'nın parçası olan bir alandaki belirli bir değerle ilgili özel bildirim mesajları sağlar.

JSON gösterimi 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Alanlar
field

string

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

string

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

string

Yalnızca çıkış. Bildirim mesajı, alanın değeriyle ilişkilendirilir.
acknowledgementRequired

boolean

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

TargetResource

Hedef kaynak türleri

Sıralamalar
TARGET_RESOURCE_UNSPECIFIED Belirtilmemiş hedef kaynak.
ORG_UNIT Kuruluş Birimi hedef kaynağı.
GROUP Hedef kaynağı gruplandırın.

PolicyApiLifecycle

JSON gösterimi 
{
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  },
  "deprecatedInFavorOf": [
    string
  ]
}
Alanlar
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Politika API'sinin mevcut yaşam döngüsü aşamasını belirtmelidir.
description

string

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

object (Date)

Mevcut politika için destek sunma tarihinin bitiş tarihi.
deprecatedInFavorOf[]

string

Bu politikanın kullanımdan kaldırılması ve yerine başka bir politikanın kullanılması durumunda yeni politikaların PolicyAPI'de gösterilecekleri tam nitelikli ad alanlarıdır.

PolicyApiLifecycleEnum

Sıralamalar
API_UNSPECIFIED belirtilmedi.
API_PREVIEW Politika henüz çalışmamaktadır ancak geliştiricilere biçim hakkında önceden uyarıda bulunuluyor. Bu aşama API_DEVELOPEMNT veya API_CURRENT'e aktarılabilir.
API_DEVELOPMENT Politika, biçimi geriye dönük olarak uyumsuz bir şekilde değiştirebilir (bozucu değişiklik). Bu aşama API_CURRENT veya API_DEPRECATED sürümüne aktarılabilir. Bu, yalnızca TT'lere sunulan veya acil durum kullanımı için belirli müşterilere sunulan politikalar için kullanılabilir.
API_CURRENT Resmi biçimdeki politika. Politika, biçimi geriye dönük uyumlu olarak değiştirebilir (kırıcı olmayan değişiklik). Örnek: Bu politika, alan maskeleri düzgün bir şekilde kullanıldığında, kesintisiz değişiklik olarak kabul edilen yeni bir alanı kullanıma sunabilir. Bu aşama API_DEPRECATED hizmetine aktarılabilir.
API_DEPRECATED Lütfen bu politikayı artık kullanmayın. Bu politikanın desteği sonlandırılmıştır ve gelecekte kaldırılacaktır. Büyük olasılıkla, bunun yerini alan yeni bir politika çıkarılmıştır.

Tarih

Takvim tarihinin tamamını veya bir kısmını (ör. doğum günü) temsil eder. Günün saati ve saat dilimi, başka bir yerde belirtilmiş veya önemsiz. Tarih, Miladi Takvim ile görecelidir. Aşağıdakilerden birini gösterebilir:

  • Sıfır olmayan yıl, ay ve gün değerleriyle tam tarih.
  • Sıfır yıllı bir ay ve gün (örneğin, yıl dönümü).
  • Tek başına bir yıl (sıfır ay ve sıfır gün).
  • Sıfır gün içeren bir yıl ve ay (örneğin, kredi kartı son kullanma tarihi).

İlgili türler:

JSON gösterimi 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Alanlar
year

integer

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

integer

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

integer

Ayın günü. 1 ile 31 arasında olup yıl ve ay için geçerli olmalıdır veya tek başına yıl ya da günün önemli olmadığı yıl ve ay belirtmek için 0 olmalıdır.

Yöntemler

get

 Kaynak adına göre bir müşteri için belirli bir politika şeması alın.

list

 Belirli bir müşteri için belirtilen filtre değeriyle eşleşen politika şemalarının listesini alır.