Class EventCreateRule.Builder (0.56.0) 

public static final class EventCreateRule.Builder extends GeneratedMessageV3.Builder<EventCreateRule.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EventCreateRule.Builder

Static Methods

getDescriptor()

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

Methods

addAllEventConditions(Iterable<? extends MatchingCondition> values)

public EventCreateRule.Builder addAllEventConditions(Iterable<? extends MatchingCondition> values)

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
values Iterable<? extends com.google.analytics.admin.v1alpha.MatchingCondition>
Returns
Type Description
EventCreateRule.Builder

addAllParameterMutations(Iterable<? extends ParameterMutation> values)

public EventCreateRule.Builder addAllParameterMutations(Iterable<? extends ParameterMutation> values)

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
values Iterable<? extends com.google.analytics.admin.v1alpha.ParameterMutation>
Returns
Type Description
EventCreateRule.Builder

addEventConditions(MatchingCondition value)

public EventCreateRule.Builder addEventConditions(MatchingCondition value)

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
value MatchingCondition
Returns
Type Description
EventCreateRule.Builder

addEventConditions(MatchingCondition.Builder builderForValue)

public EventCreateRule.Builder addEventConditions(MatchingCondition.Builder builderForValue)

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
builderForValue MatchingCondition.Builder
Returns
Type Description
EventCreateRule.Builder

addEventConditions(int index, MatchingCondition value)

public EventCreateRule.Builder addEventConditions(int index, MatchingCondition value)

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];

Parameters
Name Description
index int
value MatchingCondition
Returns
Type Description
EventCreateRule.Builder

addEventConditions(int index, MatchingCondition.Builder builderForValue)

public EventCreateRule.Builder addEventConditions(int index, MatchingCondition.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue MatchingCondition.Builder
Returns
Type Description
EventCreateRule.Builder

addEventConditionsBuilder()

public MatchingCondition.Builder addEventConditionsBuilder()

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
MatchingCondition.Builder

addEventConditionsBuilder(int index)

public MatchingCondition.Builder addEventConditionsBuilder(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.Builder

addParameterMutations(ParameterMutation value)

public EventCreateRule.Builder addParameterMutations(ParameterMutation value)

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
value ParameterMutation
Returns
Type Description
EventCreateRule.Builder

addParameterMutations(ParameterMutation.Builder builderForValue)

public EventCreateRule.Builder addParameterMutations(ParameterMutation.Builder builderForValue)

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
builderForValue ParameterMutation.Builder
Returns
Type Description
EventCreateRule.Builder

addParameterMutations(int index, ParameterMutation value)

public EventCreateRule.Builder addParameterMutations(int index, ParameterMutation value)

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;

Parameters
Name Description
index int
value ParameterMutation
Returns
Type Description
EventCreateRule.Builder

addParameterMutations(int index, ParameterMutation.Builder builderForValue)

public EventCreateRule.Builder addParameterMutations(int index, ParameterMutation.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ParameterMutation.Builder
Returns
Type Description
EventCreateRule.Builder

addParameterMutationsBuilder()

public ParameterMutation.Builder addParameterMutationsBuilder()

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
ParameterMutation.Builder

addParameterMutationsBuilder(int index)

public ParameterMutation.Builder addParameterMutationsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EventCreateRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EventCreateRule.Builder
Overrides

build()

public EventCreateRule build()
Returns
Type Description
EventCreateRule

buildPartial()

public EventCreateRule buildPartial()
Returns
Type Description
EventCreateRule

clear()

public EventCreateRule.Builder clear()
Returns
Type Description
EventCreateRule.Builder
Overrides

clearDestinationEvent()

public EventCreateRule.Builder clearDestinationEvent()

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
EventCreateRule.Builder

This builder for chaining.

clearEventConditions()

public EventCreateRule.Builder clearEventConditions()

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
EventCreateRule.Builder

clearField(Descriptors.FieldDescriptor field)

public EventCreateRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
EventCreateRule.Builder
Overrides

clearName()

public EventCreateRule.Builder clearName()

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
EventCreateRule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EventCreateRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
EventCreateRule.Builder
Overrides

clearParameterMutations()

public EventCreateRule.Builder clearParameterMutations()

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
EventCreateRule.Builder

clearSourceCopyParameters()

public EventCreateRule.Builder clearSourceCopyParameters()

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
EventCreateRule.Builder

This builder for chaining.

clone()

public EventCreateRule.Builder clone()
Returns
Type Description
EventCreateRule.Builder
Overrides

getDefaultInstanceForType()

public EventCreateRule getDefaultInstanceForType()
Returns
Type Description
EventCreateRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getEventConditionsBuilder(int index)

public MatchingCondition.Builder getEventConditionsBuilder(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.Builder

getEventConditionsBuilderList()

public List<MatchingCondition.Builder> getEventConditionsBuilderList()

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<Builder>

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

getParameterMutationsBuilder(int index)

public ParameterMutation.Builder getParameterMutationsBuilder(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.Builder

getParameterMutationsBuilderList()

public List<ParameterMutation.Builder> getParameterMutationsBuilderList()

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<Builder>

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>

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EventCreateRule other)

public EventCreateRule.Builder mergeFrom(EventCreateRule other)
Parameter
Name Description
other EventCreateRule
Returns
Type Description
EventCreateRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EventCreateRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EventCreateRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public EventCreateRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
EventCreateRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EventCreateRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EventCreateRule.Builder
Overrides

removeEventConditions(int index)

public EventCreateRule.Builder removeEventConditions(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
EventCreateRule.Builder

removeParameterMutations(int index)

public EventCreateRule.Builder removeParameterMutations(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
EventCreateRule.Builder

setDestinationEvent(String value)

public EventCreateRule.Builder setDestinationEvent(String value)

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];

Parameter
Name Description
value String

The destinationEvent to set.
Returns
Type Description
EventCreateRule.Builder

This builder for chaining.

setDestinationEventBytes(ByteString value)

public EventCreateRule.Builder setDestinationEventBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for destinationEvent to set.
Returns
Type Description
EventCreateRule.Builder

This builder for chaining.

setEventConditions(int index, MatchingCondition value)

public EventCreateRule.Builder setEventConditions(int index, MatchingCondition value)

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];

Parameters
Name Description
index int
value MatchingCondition
Returns
Type Description
EventCreateRule.Builder

setEventConditions(int index, MatchingCondition.Builder builderForValue)

public EventCreateRule.Builder setEventConditions(int index, MatchingCondition.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue MatchingCondition.Builder
Returns
Type Description
EventCreateRule.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public EventCreateRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EventCreateRule.Builder
Overrides

setName(String value)

public EventCreateRule.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
EventCreateRule.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EventCreateRule.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
EventCreateRule.Builder

This builder for chaining.

setParameterMutations(int index, ParameterMutation value)

public EventCreateRule.Builder setParameterMutations(int index, ParameterMutation value)

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;

Parameters
Name Description
index int
value ParameterMutation
Returns
Type Description
EventCreateRule.Builder

setParameterMutations(int index, ParameterMutation.Builder builderForValue)

public EventCreateRule.Builder setParameterMutations(int index, ParameterMutation.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue ParameterMutation.Builder
Returns
Type Description
EventCreateRule.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EventCreateRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
EventCreateRule.Builder
Overrides

setSourceCopyParameters(boolean value)

public EventCreateRule.Builder setSourceCopyParameters(boolean value)

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;

Parameter
Name Description
value boolean

The sourceCopyParameters to set.
Returns
Type Description
EventCreateRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EventCreateRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EventCreateRule.Builder
Overrides