Class EventEditRule (0.58.0)

public final class EventEditRule extends GeneratedMessageV3 implements EventEditRuleOrBuilder

An Event Edit 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 Create rules, Event Edit Rules are applied in their defined order.

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

Protobuf type google.analytics.admin.v1alpha.EventEditRule

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_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

PROCESSING_ORDER_FIELD_NUMBER

public static final int PROCESSING_ORDER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EventEditRule getDefaultInstance()
Returns
Type Description
EventEditRule

getDescriptor()

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

newBuilder()

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

newBuilder(EventEditRule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public EventEditRule getDefaultInstanceForType()
Returns
Type Description
EventEditRule

getDisplayName()

public String getDisplayName()

Required. The display name of this event edit rule. Maximum of 255 characters.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of this event edit rule. Maximum of 255 characters.

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

Returns
Type Description
ByteString

The bytes for displayName.

getEventConditions(int index)

public MatchingCondition getEventConditions(int index)

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

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. Conditions on the source event must match for this rule to be applied. Must have at least one condition, and can have up to 10 max.

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

Returns
Type Description
int

getEventConditionsList()

public List<MatchingCondition> getEventConditionsList()

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

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. Conditions on the source event must match for this rule to be applied. Must have at least one condition, and can have up to 10 max.

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. Conditions on the source event must match for this rule to be applied. Must have at least one condition, and can have up to 10 max.

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()

Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}

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

Returns
Type Description
ByteString

The bytes for name.

getParameterMutations(int index)

public ParameterMutation getParameterMutations(int index)

Required. 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 = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ParameterMutation

getParameterMutationsCount()

public int getParameterMutationsCount()

Required. 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 = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getParameterMutationsList()

public List<ParameterMutation> getParameterMutationsList()

Required. 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 = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<ParameterMutation>

getParameterMutationsOrBuilder(int index)

public ParameterMutationOrBuilder getParameterMutationsOrBuilder(int index)

Required. 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 = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ParameterMutationOrBuilder

getParameterMutationsOrBuilderList()

public List<? extends ParameterMutationOrBuilder> getParameterMutationsOrBuilderList()

Required. 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 = 4 [(.google.api.field_behavior) = REQUIRED];

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

getParserForType()

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

getProcessingOrder()

public long getProcessingOrder()

Output only. The order for which this rule will be processed. Rules with an order value lower than this will be processed before this rule, rules with an order value higher than this will be processed after this rule. New event edit rules will be assigned an order value at the end of the order.

This value does not apply to event create rules.

int64 processing_order = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The processingOrder.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 EventEditRule.Builder newBuilderForType()
Returns
Type Description
EventEditRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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