Class EventCreateRule (0.56.0)

public final class EventCreateRule extends GeneratedMessageV3 implements EventCreateRuleOrBuilder

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.

Protobuf type google.analytics.admin.v1alpha.EventCreateRule

Static Fields

DESTINATION_EVENT_FIELD_NUMBER

public static final int DESTINATION_EVENT_FIELD_NUMBER
Field Value
Type Description
int

EVENT_CONDITIONS_FIELD_NUMBER

public static final int EVENT_CONDITIONS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARAMETER_MUTATIONS_FIELD_NUMBER

public static final int PARAMETER_MUTATIONS_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_COPY_PARAMETERS_FIELD_NUMBER

public static final int SOURCE_COPY_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EventCreateRule getDefaultInstance()
Returns
Type Description
EventCreateRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EventCreateRule.Builder newBuilder()
Returns
Type Description
EventCreateRule.Builder

newBuilder(EventCreateRule prototype)

public static EventCreateRule.Builder newBuilder(EventCreateRule prototype)
Parameter
Name Description
prototype EventCreateRule
Returns
Type Description
EventCreateRule.Builder

parseDelimitedFrom(InputStream input)

public static EventCreateRule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EventCreateRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventCreateRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventCreateRule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EventCreateRule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EventCreateRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EventCreateRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventCreateRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EventCreateRule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EventCreateRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EventCreateRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventCreateRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EventCreateRule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EventCreateRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EventCreateRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventCreateRule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EventCreateRule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EventCreateRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EventCreateRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventCreateRule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EventCreateRule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EventCreateRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EventCreateRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventCreateRule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EventCreateRule> parser()
Returns
Type Description
Parser<EventCreateRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public EventCreateRule getDefaultInstanceForType()
Returns
Type Description
EventCreateRule

getDestinationEvent()

public String getDestinationEvent()

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

string destination_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The destinationEvent.

getDestinationEventBytes()

public ByteString getDestinationEventBytes()

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

string destination_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for destinationEvent.

getEventConditions(int index)

public MatchingCondition getEventConditions(int index)

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.

repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
MatchingCondition

getEventConditionsCount()

public int getEventConditionsCount()

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.

repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getEventConditionsList()

public List<MatchingCondition> getEventConditionsList()

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.

repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<MatchingCondition>

getEventConditionsOrBuilder(int index)

public MatchingConditionOrBuilder getEventConditionsOrBuilder(int index)

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.

repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
MatchingConditionOrBuilder

getEventConditionsOrBuilderList()

public List<? extends MatchingConditionOrBuilder> getEventConditionsOrBuilderList()

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.

repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.analytics.admin.v1alpha.MatchingConditionOrBuilder>

getName()

public String getName()

Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParameterMutations(int index)

public ParameterMutation getParameterMutations(int index)

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

repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;

Parameter
Name Description
index int
Returns
Type Description
ParameterMutation

getParameterMutationsCount()

public int getParameterMutationsCount()

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

repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;

Returns
Type Description
int

getParameterMutationsList()

public List<ParameterMutation> getParameterMutationsList()

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

repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;

Returns
Type Description
List<ParameterMutation>

getParameterMutationsOrBuilder(int index)

public ParameterMutationOrBuilder getParameterMutationsOrBuilder(int index)

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

repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;

Parameter
Name Description
index int
Returns
Type Description
ParameterMutationOrBuilder

getParameterMutationsOrBuilderList()

public List<? extends ParameterMutationOrBuilder> getParameterMutationsOrBuilderList()

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

repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;

Returns
Type Description
List<? extends com.google.analytics.admin.v1alpha.ParameterMutationOrBuilder>

getParserForType()

public Parser<EventCreateRule> getParserForType()
Returns
Type Description
Parser<EventCreateRule>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCopyParameters()

public boolean getSourceCopyParameters()

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.

bool source_copy_parameters = 4;

Returns
Type Description
boolean

The sourceCopyParameters.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EventCreateRule.Builder newBuilderForType()
Returns
Type Description
EventCreateRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EventCreateRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EventCreateRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EventCreateRule.Builder toBuilder()
Returns
Type Description
EventCreateRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException