- Kaynak: PolicySchema
- AdditionalTargetKeyName
- FileDescriptorProto
- DescriptorProto
- FieldDescriptorProto
- Etiket
- Tür
- EnumDescriptorProto
- EnumValueDescriptorProto
- OneofDescriptorProto
- PolicySchemaFieldDescription
- PolicySchemaFieldKnownValueDescription
- PolicySchemaFieldDependencies
- PolicySchemaRequiredItems
- FieldConstraints
- NumericRangeConstraint
- UploadedFileConstraints
- ContentType
- PolicySchemaNoticeDescription
- TargetResource
- PolicyApiLifecycle
- PolicyApiLifecycleEnum
- Tarih
- Yöntemler
Kaynak: PolicySchema
Bir politika şemasını temsil eden kaynak.
JSON gösterimi |
---|
{ "name": string, "policyDescription": string, "additionalTargetKeyNames": [ { object ( |
Alanlar | |
---|---|
name |
Biçim: ad=customer/{customer}/policySchemas/{schema_namespace} |
policyDescription |
Yalnızca çıkış. Kullanıcı tüketimi için politika şemasıyla ilgili açıklama. |
additionalTargetKeyNames[] |
Yalnızca çıkış. Politika değerinin hedefini tanımlamak için kullanılacak ek anahtar adları. Bir |
definition |
Proto açıklayıcı kullanılan şema tanımı. |
fieldDescriptions[] |
Yalnızca çıkış. Şemanın parçası olan her alanın ayrıntılı açıklaması. |
accessRestrictions[] |
Yalnızca çıkış. Bu politikayla ilgili belirli erişim kısıtlamaları. |
notices[] |
Yalnızca çıkış. Şemadaki belirli alanlarda belirli değerlerin ayarlanmasıyla ilgili özel uyarı mesajları. |
supportUri |
Yalnızca çıkış. Bu şemayla ilgili ilgili destek makalesinin URI'si. |
schemaName |
Yalnızca çıkış. Politika şemasının tam adı. Bu değer, |
validTargetResources[] |
Yalnızca çıkış. Politika için geçerli hedef kaynaklar hakkında bilgi. |
policyApiLifecycle |
Yalnızca çıkış. Mevcut yaşam döngüsü bilgileri. |
categoryTitle |
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 |
Anahtar adı. |
keyDescription |
Anahtar açıklaması. |
FileDescriptorProto
Eksiksiz bir .proto dosyasını açıklar.
JSON gösterimi |
---|
{ "name": string, "package": string, "messageType": [ { object ( |
Alanlar | |
---|---|
name |
dosya adı, kaynak ağacının köküne göre |
package |
ör. "foo", "foo.bar" vb. |
messageType[] |
Bu dosyadaki tüm üst düzey tanımlar. |
enumType[] |
|
syntax |
Proto dosyasının söz dizimi. "proto2", "proto3" ve "editions" değerleri desteklenir.
|
DescriptorProto
Mesaj türünü açıklar.
JSON gösterimi |
---|
{ "name": string, "field": [ { object ( |
Alanlar | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
Bir iletideki alanı açıklar.
JSON gösterimi |
---|
{ "name": string, "number": integer, "label": enum ( |
Alanlar | |
---|---|
name |
|
number |
|
label |
|
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 |
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 |
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 |
Ayarlanırsa kapsayıcı türünün oneofDecl listesindekilerden birinin dizinini verir. Bu alan, söz konusu alanın üyesidir. |
jsonName |
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 |
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ı, |
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 ( |
Alanlar | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
Bir enum içindeki değeri tanımlar.
JSON gösterimi |
---|
{ "name": string, "number": integer } |
Alanlar | |
---|---|
name |
|
number |
|
OneofDescriptorProto
Bunlardan birini tanımlar.
JSON gösterimi |
---|
{ "name": string } |
Alanlar | |
---|---|
name |
|
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 ( |
Alanlar | |
---|---|
field |
Yalnızca çıkış. Bu açıklamayla ilişkili alanın adı. |
description |
Kullanımdan kaldırıldı. Bunun yerine name ve fieldDescription alanını kullanın. Alanın açıklaması. |
inputConstraint |
Yalnızca çıkış. Alanın değerleriyle ilişkili tüm giriş kısıtlamaları. |
knownValueDescriptions[] |
Yalnızca çıkış. Alanda bilinen bir değerler grubu varsa bu alan, bu değerler için bir açıklama sağlar. |
nestedFieldDescriptions[] |
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[] |
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[] |
Yalnızca çıkış. Bu alanda belirli bir değer varsa ayarlanması gereken alanların listesini sağlar. |
defaultValue |
Yalnızca çıkış. Politika ayarlanmazsa istemci varsayılanı. |
name |
Yalnızca çıkış. Alanın adı. |
fieldDescription |
Yalnızca çıkış. Alanın açıklaması. |
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 |
Yalnızca çıkış. Alan için ayarlanabilecek değerin dize yeniden öngörmesi. |
description |
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 |
Bu alanın bağlı olduğu kaynak alan. |
sourceFieldValue |
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[] |
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[] |
Alan koşullarının sonucu olarak zorunlu olan alanlar. |
FieldConstraints
Aralık kısıtlamalarıyla ilgili bilgiler.
JSON gösterimi |
---|
{ "numericRangeConstraint": { object ( |
Alanlar | |
---|---|
numericRangeConstraint |
Sayısal alanlar için izin verilen aralık. |
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 |
Minimum değer. |
maximum |
Maksimum değer. |
UploadedFileConstraints
Bir dosya politikasının yüklenen dosyasındaki kısıtlamalar.
JSON gösterimi |
---|
{
"supportedContentTypes": [
enum ( |
Alanlar | |
---|---|
supportedContentTypes[] |
Bir ayar için yüklenebilecek dosya türleri. |
sizeLimitBytes |
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 |
Yalnızca çıkış. Bildirimle ilişkili alan adı. |
noticeValue |
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 |
Yalnızca çıkış. Bildirim mesajı, alanın değeriyle ilişkilendirilir. |
acknowledgementRequired |
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 ( |
Alanlar | |
---|---|
policyApiLifecycleStage |
Politika API'sinin mevcut yaşam döngüsü aşamasını belirtmelidir. |
description |
Mevcut yaşam döngüsüyle ilgili açıklama. |
endSupport |
Mevcut politika için destek sunma tarihinin bitiş tarihi. |
deprecatedInFavorOf[] |
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:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
JSON gösterimi |
---|
{ "year": integer, "month": integer, "day": integer } |
Alanlar | |
---|---|
year |
Tarihin yılı. 1 ile 9999 arasında veya yıl içermeyen bir tarih belirtmek için 0 olmalıdır. |
month |
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 |
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 |
|
---|---|
|
Kaynak adına göre bir müşteri için belirli bir politika şeması alın. |
|
Belirli bir müşteri için belirtilen filtre değeriyle eşleşen politika şemalarının listesini alır. |