- Ressource: PolicySchema
- AdditionalTargetKeyName
- FileDescriptorProto
- DescriptorProto
- FieldDescriptorProto
- Libellé
- Type
- EnumDescriptorProto
- EnumValueDescriptorProto
- OneofDescriptorProto
- PolicySchemaFieldDescription
- PolicySchemaFieldKnownValueDescription
- PolicySchemaFieldDependencies
- PolicySchemaRequiredItems
- FieldConstraints
- NumericRangeConstraint
- UploadedFileConstraints
- ContentType
- PolicySchemaNoticeDescription
- TargetResource
- PolicyApiLifecycle
- PolicyApiLifecycleEnum
- Date
- Méthodes
Ressource: PolicySchema
Ressource représentant un schéma de stratégie.
Représentation JSON |
---|
{ "name": string, "policyDescription": string, "additionalTargetKeyNames": [ { object ( |
Champs | |
---|---|
name |
Format: name=customers/{customer}/policySchemas/{schema_namespace} |
policyDescription |
Uniquement en sortie. Description du schéma de stratégie pour l'utilisation par les utilisateurs. |
additionalTargetKeyNames[] |
Uniquement en sortie. Noms de clé supplémentaires permettant d'identifier la cible de la valeur de la règle. Lorsque vous spécifiez un |
definition |
Définition du schéma à l'aide du descripteur proto. |
fieldDescriptions[] |
Uniquement en sortie. Description détaillée de chaque champ faisant partie du schéma. |
accessRestrictions[] |
Uniquement en sortie. Restrictions d'accès spécifiques liées à cette règle. |
notices[] |
Uniquement en sortie. Messages d'avis spéciaux concernant la définition de certaines valeurs dans certains champs du schéma. |
supportUri |
Uniquement en sortie. URI de l'article d'aide associé à ce schéma. |
schemaName |
Uniquement en sortie. Nom complet du schéma de stratégie. Cette valeur est utilisée pour remplir le champ |
validTargetResources[] |
Uniquement en sortie. Informations sur les ressources cibles applicables au règlement. |
policyApiLifecycle |
Uniquement en sortie. Informations actuelles sur le cycle de vie. |
categoryTitle |
Titre de la catégorie à laquelle appartient un paramètre. |
AdditionalTargetKeyName
Noms de clé supplémentaires permettant d'identifier la cible de la valeur de la règle.
Représentation JSON |
---|
{ "key": string, "keyDescription": string } |
Champs | |
---|---|
key |
Nom de la clé. |
keyDescription |
Description de la clé |
FileDescriptorProto
Décrit un fichier .proto complet.
Représentation JSON |
---|
{ "name": string, "package": string, "messageType": [ { object ( |
Champs | |
---|---|
name |
par rapport à la racine de l'arborescence source |
package |
Exemple : "foo", "foo.bar", etc. |
messageType[] |
Toutes les définitions de premier niveau dans ce fichier. |
enumType[] |
|
syntax |
La syntaxe du fichier proto. Les valeurs acceptées sont "proto2", "proto3" et "editions". Si |
DescriptorProto
Décrit un type de message.
Représentation JSON |
---|
{ "name": string, "field": [ { object ( |
Champs | |
---|---|
name |
|
field[] |
|
nestedType[] |
|
enumType[] |
|
oneofDecl[] |
|
FieldDescriptorProto
Décrit un champ dans un message.
Représentation JSON |
---|
{ "name": string, "number": integer, "label": enum ( |
Champs | |
---|---|
name |
|
number |
|
label |
|
type |
Si le typeName est défini, vous n'avez pas besoin de le faire. Si cet élément ainsi que typeName sont tous les deux définis, il doit s'agir de TYPE_ENUM, TYPE_MESSAGE ou TYPE_GROUP. |
typeName |
Pour les types "message" et "énumération", il s'agit du nom du type. Si le nom commence par un point, cela signifie qu'il est complet. Sinon, des règles de champ d'application de type C++ sont utilisées pour trouver le type (en d'autres termes, la recherche est effectuée d'abord sur les types imbriqués dans ce message, puis dans le parent, jusqu'à l'espace de noms racine). |
defaultValue |
Pour les types numériques, contient la représentation textuelle d'origine de la valeur. Pour les valeurs booléennes, "true" ou "false". Pour les chaînes, contient le contenu du texte par défaut (sans échappement). Pour les octets, contient la valeur avec échappement C. Tous les octets >= 128 sont échappés. |
oneofIndex |
Si cet indicateur est défini, il donne l'index d'un élément oneof dans la liste oneofDecl du type conteneur. Ce champ est membre de celui-ci. |
jsonName |
Nom JSON de ce champ. La valeur est définie par le compilateur de protocole. Si l'utilisateur a défini une option"jsonName" dans ce champ, la valeur de cette option sera utilisée. Sinon, il est déduit du nom du champ en le convertissant en camelCase. |
proto3Optional |
Si la valeur est "true", il s'agit d'un proto3 "facultatif". Lorsqu'un champ proto3 est facultatif, il suit la présence quel que soit le type de champ. Lorsque proto3Optional est défini sur "true", ce champ doit appartenir à un oneof pour signaler aux anciens clients proto3 que la présence est suivie pour ce champ. Ce champ est appelé "oneof" "synthétique" et ce champ doit être son seul membre (chaque champ facultatif proto3 possède sa propre propriété synthétique). Les oneofs synthétiques n'existent que dans le descripteur et ne génèrent aucune API. Les oneofs synthétiques doivent être triés après tous les oneof « réels ». Pour les champs de message, proto3Optional ne crée aucun changement sémantique, car les champs de message non répétés suivent toujours la présence. Cependant, il indique toujours le détail sémantique qui indique si l'utilisateur a écrit "facultatif" ou non. Cela peut être utile pour effectuer un aller-retour du fichier .proto. Par souci de cohérence, nous attribuons également une valeur synthétique aux champs de message, même s'il n'est pas nécessaire pour suivre la présence. Ce point est particulièrement important, car l'analyseur ne peut pas savoir si un champ est un message ou une énumération. Il doit donc toujours créer une propriété synthétique. Les champs facultatifs Proto2 ne définissent pas cet indicateur, car ils indiquent déjà facultatifs avec |
Libellé
Enums | |
---|---|
LABEL_OPTIONAL |
0 est réservé aux erreurs |
LABEL_REQUIRED |
|
LABEL_REPEATED |
Type
Enums | |
---|---|
TYPE_DOUBLE |
0 est réservé aux erreurs. L'ordre est bizarre pour des raisons historiques. |
TYPE_FLOAT |
|
TYPE_INT64 |
L'encodage en ZigZag n'est pas activé. Les nombres négatifs prennent 10 octets. Utilisez TYPE_SINT64 si des valeurs négatives sont probables. |
TYPE_UINT64 |
|
TYPE_INT32 |
L'encodage en ZigZag n'est pas activé. Les nombres négatifs prennent 10 octets. Utilisez TYPE_SINT32 si des valeurs négatives sont probables. |
TYPE_FIXED64 |
|
TYPE_FIXED32 |
|
TYPE_BOOL |
|
TYPE_STRING |
|
TYPE_GROUP |
Agrégat délimité par des tags. Le type de groupe est obsolète et n'est pas compatible avec proto3. Toutefois, les implémentations Proto3 doivent toujours pouvoir analyser le format de communication de groupe et traiter les champs de groupe comme des champs inconnus. |
TYPE_MESSAGE |
Agrégat délimité par la longueur. |
TYPE_BYTES |
Nouveautés de la version 2. |
TYPE_UINT32 |
|
TYPE_ENUM |
|
TYPE_SFIXED32 |
|
TYPE_SFIXED64 |
|
TYPE_SINT32 |
Utilise l'encodage ZigZag. |
TYPE_SINT64 |
Utilise l'encodage ZigZag. |
EnumDescriptorProto
Décrit un type d'énumération.
Représentation JSON |
---|
{
"name": string,
"value": [
{
object ( |
Champs | |
---|---|
name |
|
value[] |
|
EnumValueDescriptorProto
Décrit une valeur dans une énumération.
Représentation JSON |
---|
{ "name": string, "number": integer } |
Champs | |
---|---|
name |
|
number |
|
OneofDescriptorProto
Décrit un oneof.
Représentation JSON |
---|
{ "name": string } |
Champs | |
---|---|
name |
|
PolicySchemaFieldDescription
Fournit des informations détaillées pour un champ particulier faisant partie d'un PolicySchema.
Représentation JSON |
---|
{ "field": string, "description": string, "inputConstraint": string, "knownValueDescriptions": [ { object ( |
Champs | |
---|---|
field |
Uniquement en sortie. Nom du champ associé à cette description. |
description |
Obsolète. Utilisez plutôt "name" et "fieldDescription". Description du champ. |
inputConstraint |
Uniquement en sortie. Toutes les contraintes d'entrée associées aux valeurs du champ. |
knownValueDescriptions[] |
Uniquement en sortie. Si le champ est associé à un ensemble de valeurs connues, ce champ fournit une description de ces valeurs. |
nestedFieldDescriptions[] |
Uniquement en sortie. Fournit la description des champs imbriqués dans ce champ, s'il s'agit d'un type de message définissant plusieurs champs. |
fieldDependencies[] |
Uniquement en sortie. Fournit une liste de champs et de valeurs. Pour que ce champ puisse être défini, au moins l'un des champs doit comporter la valeur correspondante. |
requiredItems[] |
Uniquement en sortie. Fournit une liste des champs qui doivent être définis si ce champ a une certaine valeur. |
defaultValue |
Uniquement en sortie. Valeur par défaut du client si la règle n'est pas configurée. |
name |
Uniquement en sortie. Nom du champ. |
fieldDescription |
Uniquement en sortie. Description du champ. |
fieldConstraints |
Uniquement en sortie. Informations sur les contraintes d'entrée associées aux valeurs du champ. |
PolicySchemaFieldKnownValueDescription
Fournit des informations détaillées sur une valeur connue autorisée pour un champ particulier dans un PolicySchema.
Représentation JSON |
---|
{ "value": string, "description": string } |
Champs | |
---|---|
value |
Uniquement en sortie. Représentation (chaîne) de la valeur pouvant être définie pour le champ. |
description |
Uniquement en sortie. Description supplémentaire pour cette valeur. |
PolicySchemaFieldDependencies
Vous devez renseigner le champ et sa valeur pour qu'un autre champ puisse être défini.
Représentation JSON |
---|
{ "sourceField": string, "sourceFieldValue": string } |
Champs | |
---|---|
sourceField |
Champ source dont dépend ce champ. |
sourceFieldValue |
Valeur que le champ source doit contenir pour que ce champ puisse être défini. |
PolicySchemaRequiredItems
Champs qui deviendront obligatoires en fonction de la valeur de ce champ.
Représentation JSON |
---|
{ "fieldConditions": [ string ], "requiredFields": [ string ] } |
Champs | |
---|---|
fieldConditions[] |
Valeur(s) du champ ayant entraîné une mesure d'application des champs obligatoires. Si le champ "fieldConditions" est vide, toute valeur attribuée à ce champ entraînera l'application du champ obligatoire. |
requiredFields[] |
Champs obligatoires en raison des conditions des champs. |
FieldConstraints
Informations sur les contraintes de plage.
Représentation JSON |
---|
{ "numericRangeConstraint": { object ( |
Champs | |
---|---|
numericRangeConstraint |
Plage autorisée pour les champs numériques. |
uploadedFileConstraints |
Contraintes sur le fichier importé d'une règle de fichier. Si cette règle est présente, elle nécessite une URL qui peut être récupérée en important un fichier avec les contraintes spécifiées dans ce fichier .proto. |
NumericRangeConstraint
Contrainte de limite supérieure et/ou inférieure, avec au moins une contrainte définie.
Représentation JSON |
---|
{ "minimum": string, "maximum": string } |
Champs | |
---|---|
minimum |
Valeur minimale. |
maximum |
Valeur maximale. |
UploadedFileConstraints
Contraintes sur le fichier importé d'une règle de fichier.
Représentation JSON |
---|
{
"supportedContentTypes": [
enum ( |
Champs | |
---|---|
supportedContentTypes[] |
Types de fichiers pouvant être importés pour un paramètre. |
sizeLimitBytes |
Taille maximale des fichiers importés pour un paramètre, en octets. |
ContentType
Types de fichiers pouvant être importés pour un paramètre.
Enums | |
---|---|
CONTENT_TYPE_UNSPECIFIED |
Type de contenu non spécifié. |
CONTENT_TYPE_PLAIN_TEXT |
Texte brut. |
CONTENT_TYPE_HTML |
HTML. |
CONTENT_TYPE_IMAGE_JPEG |
JPEG. |
CONTENT_TYPE_IMAGE_GIF |
GIF. |
CONTENT_TYPE_IMAGE_PNG |
PNG |
CONTENT_TYPE_JSON |
JSON. |
CONTENT_TYPE_ZIP |
ZIP. |
CONTENT_TYPE_GZIP |
GZIP. |
CONTENT_TYPE_CSV |
CSV. |
CONTENT_TYPE_YAML |
YAML. |
CONTENT_TYPE_IMAGE_WEBP |
WEBP. |
PolicySchemaNoticeDescription
Fournit des messages d'avertissement spéciaux concernant une valeur particulière d'un champ faisant partie d'un PolicySchema.
Représentation JSON |
---|
{ "field": string, "noticeValue": string, "noticeMessage": string, "acknowledgementRequired": boolean } |
Champs | |
---|---|
field |
Uniquement en sortie. Nom de champ associé à la notification. |
noticeValue |
Uniquement en sortie. Valeur du champ contenant une notification. Lorsque le champ est défini sur cette valeur, l'utilisateur peut être invité à confirmer la réception du message de notification pour que la valeur puisse être définie. |
noticeMessage |
Uniquement en sortie. Le message d'avertissement est associé à la valeur du champ. |
acknowledgementRequired |
Uniquement en sortie. Indique si l'utilisateur doit accuser réception du message de notification avant de pouvoir définir la valeur. |
TargetResource
Types de ressources cibles
Enums | |
---|---|
TARGET_RESOURCE_UNSPECIFIED |
Ressource cible non spécifiée. |
ORG_UNIT |
Ressource cible de l'unité organisationnelle. |
GROUP |
Ressource cible du groupe. |
PolicyApiLifecycle
Représentation JSON |
---|
{ "policyApiLifecycleStage": enum ( |
Champs | |
---|---|
policyApiLifecycleStage |
Indiquer le stade de cycle de vie actuel de l'API Policy. |
description |
Description du cycle de vie actuel. |
endSupport |
Date de fin d'application du règlement actuel. |
deprecatedInFavorOf[] |
Dans le cas où cette règle serait abandonnée au profit d'une autre, les espaces de noms complets des nouvelles règles, tels qu'ils seront affichés dans PolicyAPI. |
PolicyApiLifecycleEnum
Enums | |
---|---|
API_UNSPECIFIED |
non spécifié. |
API_PREVIEW |
Les règles ne fonctionnent pas encore, mais elles donnent aux développeurs des informations sur le format. Cette étape peut être transférée vers API_DEVELOPEMNT ou API_CURRENT. |
API_DEVELOPMENT |
La règle peut modifier le format de manière incompatible avec les versions antérieures (modification destructive). Cette étape peut être transférée vers API_CURRENT ou API_DEPRECATED. Vous pouvez l'utiliser pour les règles lancées uniquement pour les synthèses vocales ou auprès de certains clients pour une utilisation en urgence. |
API_CURRENT |
Règle dans son format officiel. La règle peut changer de format de manière rétrocompatible (modification non destructive). Exemple: cette règle peut introduire un nouveau champ, qui est considéré comme une modification non destructive, lorsque les masques de champ sont correctement utilisés. Cette étape peut être transférée vers API_DEPRECATED. |
API_DEPRECATED |
Veuillez cesser d'utiliser cette règle. Cette règle est obsolète et pourra ou sera supprimée à l'avenir. Il est très probable qu’une nouvelle politique ait été introduite pour remplacer celle-ci. |
Date
Représente une date calendaire complète ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs ou ne sont pas significatifs. La date est relative au calendrier grégorien. Il peut s'agir de l'un des éléments suivants:
- Date complète, avec des valeurs d'année, de mois et de jour non nulles.
- Jour et mois, avec une année nulle (un anniversaire, par exemple).
- Une année seule, avec un mois et un jour zéro.
- Année et mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).
Types associés:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Représentation JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Champs | |
---|---|
year |
Année de la date. La valeur doit être comprise entre 1 et 9999, ou égale à 0 pour indiquer une date sans année. |
month |
Mois de l'année. La valeur doit être comprise entre 1 et 12, ou 0 pour indiquer une année sans mois ni jour. |
day |
Jour du mois. Doit être compris entre 1 et 31, et valide pour l'année et le mois, ou la valeur 0 pour indiquer une année seule, ou une année et un mois où le jour n'est pas significatif. |
Méthodes |
|
---|---|
|
Obtenez un schéma de stratégie spécifique pour un client grâce à son nom de ressource. |
|
Récupère la liste des schémas de règle correspondant à une valeur de filtre spécifiée pour un client donné. |