REST Resource: properties.dataStreams.eventCreateRules

Resource: EventCreateRule

An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined.

Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently.

Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.

JSON representation 
{
  "name": string,
  "destinationEvent": string,
  "eventConditions": [
    {
      object (MatchingCondition)
    }
  ],
  "sourceCopyParameters": boolean,
  "parameterMutations": [
    {
      object (ParameterMutation)
    }
  ]
}
Fields
name

string

Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{dataStream}/eventCreateRules/{eventCreateRule}
destinationEvent

string

Required. The name of the new event to be created.

This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter
eventConditions[]

object (MatchingCondition)

Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
sourceCopyParameters

boolean

If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
parameterMutations[]

object (ParameterMutation)

Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.

MatchingCondition

Defines a condition for when an Event Edit or Event Creation rule applies to an event.

JSON representation 
{
  "field": string,
  "comparisonType": enum (ComparisonType),
  "value": string,
  "negated": boolean
}
Fields
field

string

Required. The name of the field that is compared against for the condition. If 'eventName' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name.

This value cannot contain spaces.
comparisonType

enum (ComparisonType)

Required. The type of comparison to be applied to the value.
value

string

Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
negated

boolean

Whether or not the result of the comparison should be negated. For example, if negated is true, then 'equals' comparisons would function as 'not equals'.

ComparisonType

Comparison type for matching condition

Enums
COMPARISON_TYPE_UNSPECIFIED Unknown
EQUALS Equals, case sensitive
EQUALS_CASE_INSENSITIVE Equals, case insensitive
CONTAINS Contains, case sensitive
CONTAINS_CASE_INSENSITIVE Contains, case insensitive
STARTS_WITH Starts with, case sensitive
STARTS_WITH_CASE_INSENSITIVE Starts with, case insensitive
ENDS_WITH Ends with, case sensitive
ENDS_WITH_CASE_INSENSITIVE Ends with, case insensitive
GREATER_THAN Greater than
GREATER_THAN_OR_EQUAL Greater than or equal
LESS_THAN Less than
LESS_THAN_OR_EQUAL Less than or equal
REGULAR_EXPRESSION regular expression. Only supported for web streams.
REGULAR_EXPRESSION_CASE_INSENSITIVE regular expression, case insensitive. Only supported for web streams.

ParameterMutation

Defines an event parameter to mutate.

JSON representation 
{
  "parameter": string,
  "parameterValue": string
}
Fields
parameter

string

Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to 'eventName' to modify the eventName in place.
parameterValue

string

Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this help center article.

Methods

create

 Creates an EventCreateRule.

delete

 Deletes an EventCreateRule.

get

 Lookup for a single EventCreateRule.

list

 Lists EventCreateRules on a web data stream.

patch

 Updates an EventCreateRule.