REST Resource: properties.dataStreams.eventCreateRules

Ressource: EventCreateRule

Une règle de création d'événements définit les conditions qui déclencheront la création d'un tout nouvel événement en fonction des critères de correspondance d'un événement source. Des mutations supplémentaires des paramètres de l'événement source peuvent être définies.

Contrairement aux règles de modification d'événement, les règles de création d'événements n'ont pas d'ordre défini. Elles seront toutes exécutées indépendamment.

Vous ne pouvez pas utiliser les règles "Modification d'événement" et "Créer un événement" pour modifier un événement créé à partir d'une règle de création d'événement.

Représentation JSON
{
  "name": string,
  "destinationEvent": string,
  "eventConditions": [
    {
      object (MatchingCondition)
    }
  ],
  "sourceCopyParameters": boolean,
  "parameterMutations": [
    {
      object (ParameterMutation)
    }
  ]
}
Champs
name

string

Uniquement en sortie. Nom de la ressource EventCreateRule. Format: Properties/{property}/dataStreams/{dataStream}/eventCreateRules/{eventCreateRule}

destinationEvent

string

Obligatoire. Nom de l'événement à créer.

Cette valeur doit: * comporter moins de 40 caractères ; * ne contenir que des lettres, des chiffres ou des traits de soulignement (_) * commencer par une lettre.

eventConditions[]

object (MatchingCondition)

Obligatoire. Cette règle doit être appliquée avec au moins une condition et un maximum de 10 conditions au niveau de l'événement source.

sourceCopyParameters

boolean

Si la valeur est "true", les paramètres sources sont copiés dans le nouvel événement. Si cette règle est définie sur "false" ou si elle n'est pas configurée, les paramètres non internes ne sont pas copiés à partir de l'événement source. Les mutations de paramètres sont appliquées après la copie des paramètres.

parameterMutations[]

object (ParameterMutation)

Les mutations de paramètres définissent le comportement des paramètres sur le nouvel événement et sont appliquées dans l'ordre. Vous pouvez appliquer jusqu'à 20 mutations.

MatchingCondition

Définit une condition à utiliser lorsqu'une règle de modification ou de création d'événement s'applique à un événement.

Représentation JSON
{
  "field": string,
  "comparisonType": enum (ComparisonType),
  "value": string,
  "negated": boolean
}
Champs
field

string

Obligatoire. Nom du champ par rapport auquel la condition est comparée. Si "eventName" est spécifié, cette condition s'applique au nom de l'événement. Sinon, la condition s'appliquera à un paramètre portant le nom spécifié.

Cette valeur ne peut pas contenir d'espaces.

comparisonType

enum (ComparisonType)

Obligatoire. Type de comparaison à appliquer à la valeur.

value

string

Obligatoire. Valeur à laquelle la comparaison est effectuée pour cette condition. L'implémentation de l'environnement d'exécution peut effectuer une coercition de type de cette valeur afin d'évaluer cette condition en fonction du type de valeur de paramètre.

negated

boolean

Indique si le résultat de la comparaison doit être annulé. Par exemple, si negated est "true", les comparaisons "est égal(e) à" fonctionnent comme "est différent de".

ComparisonType

Type de comparaison pour la condition de correspondance

Enums
COMPARISON_TYPE_UNSPECIFIED Inconnu
EQUALS Égal à la casse
EQUALS_CASE_INSENSITIVE Égal à, non sensible à la casse
CONTAINS Contient (sensible à la casse)
CONTAINS_CASE_INSENSITIVE Contient, non sensible à la casse
STARTS_WITH Commence par (sensible à la casse)
STARTS_WITH_CASE_INSENSITIVE Commence par, non sensible à la casse
ENDS_WITH Se termine par (sensible à la casse)
ENDS_WITH_CASE_INSENSITIVE Se termine par, non sensible à la casse
GREATER_THAN Supérieur à
GREATER_THAN_OR_EQUAL Supérieur(e) ou égal(e) à
LESS_THAN Moins de
LESS_THAN_OR_EQUAL Inférieur(e) ou égal(e) à
REGULAR_EXPRESSION expression régulière. Uniquement compatible avec les flux Web.
REGULAR_EXPRESSION_CASE_INSENSITIVE expression régulière, non sensible à la casse. Uniquement compatible avec les flux Web.

ParameterMutation

Définit un paramètre d'événement à modifier.

Représentation JSON
{
  "parameter": string,
  "parameterValue": string
}
Champs
parameter

string

Obligatoire. Nom du paramètre à modifier. Cette valeur doit: * comporter moins de 40 caractères. * doit être unique parmi toutes les mutations de la règle ; * ne doit être composé que de lettres, de chiffres ou de traits de soulignement (_). Pour les règles de modification d'événement, le nom de l'événement peut également être défini sur "eventName" afin de modifier le nom de l'événement existant.

parameterValue

string

Obligatoire. Changement de valeur à effectuer. * Doit comporter moins de 100 caractères. * Pour spécifier une valeur constante pour le paramètre, utilisez la chaîne de la valeur. * Pour copier la valeur d'un autre paramètre, utilisez une syntaxe telle que "[[other_parameter]]". Pour en savoir plus, consultez cet article du Centre d'aide.

Méthodes

create

Crée une règle EventCreateRule.

delete

Supprime une règle EventCreateRule.

get

Recherche pour une seule règle EventCreateRule.

list

Répertorie les événements EventCreateRules sur un flux de données Web.

patch

Met à jour une règle EventCreateRule.