Class FunnelParameterFilter.Builder (0.60.0)

public static final class FunnelParameterFilter.Builder extends GeneratedMessageV3.Builder<FunnelParameterFilter.Builder> implements FunnelParameterFilterOrBuilder

An expression to filter parameter values in a funnel.

Protobuf type google.analytics.data.v1alpha.FunnelParameterFilter

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FunnelParameterFilter build()
Returns
Type Description
FunnelParameterFilter

buildPartial()

public FunnelParameterFilter buildPartial()
Returns
Type Description
FunnelParameterFilter

clear()

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

clearBetweenFilter()

public FunnelParameterFilter.Builder clearBetweenFilter()

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Returns
Type Description
FunnelParameterFilter.Builder

clearEventParameterName()

public FunnelParameterFilter.Builder clearEventParameterName()

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

string event_parameter_name = 1;

Returns
Type Description
FunnelParameterFilter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearInListFilter()

public FunnelParameterFilter.Builder clearInListFilter()

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Returns
Type Description
FunnelParameterFilter.Builder

clearItemParameterName()

public FunnelParameterFilter.Builder clearItemParameterName()

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

string item_parameter_name = 2;

Returns
Type Description
FunnelParameterFilter.Builder

This builder for chaining.

clearNumericFilter()

public FunnelParameterFilter.Builder clearNumericFilter()

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Returns
Type Description
FunnelParameterFilter.Builder

clearOneFilter()

public FunnelParameterFilter.Builder clearOneFilter()
Returns
Type Description
FunnelParameterFilter.Builder

clearOneParameter()

public FunnelParameterFilter.Builder clearOneParameter()
Returns
Type Description
FunnelParameterFilter.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearStringFilter()

public FunnelParameterFilter.Builder clearStringFilter()

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Returns
Type Description
FunnelParameterFilter.Builder

clone()

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

getBetweenFilter()

public BetweenFilter getBetweenFilter()

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Returns
Type Description
BetweenFilter

The betweenFilter.

getBetweenFilterBuilder()

public BetweenFilter.Builder getBetweenFilterBuilder()

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Returns
Type Description
BetweenFilter.Builder

getBetweenFilterOrBuilder()

public BetweenFilterOrBuilder getBetweenFilterOrBuilder()

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Returns
Type Description
BetweenFilterOrBuilder

getDefaultInstanceForType()

public FunnelParameterFilter getDefaultInstanceForType()
Returns
Type Description
FunnelParameterFilter

getDescriptorForType()

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

getEventParameterName()

public String getEventParameterName()

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

string event_parameter_name = 1;

Returns
Type Description
String

The eventParameterName.

getEventParameterNameBytes()

public ByteString getEventParameterNameBytes()

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

string event_parameter_name = 1;

Returns
Type Description
ByteString

The bytes for eventParameterName.

getInListFilter()

public InListFilter getInListFilter()

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Returns
Type Description
InListFilter

The inListFilter.

getInListFilterBuilder()

public InListFilter.Builder getInListFilterBuilder()

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Returns
Type Description
InListFilter.Builder

getInListFilterOrBuilder()

public InListFilterOrBuilder getInListFilterOrBuilder()

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Returns
Type Description
InListFilterOrBuilder

getItemParameterName()

public String getItemParameterName()

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

string item_parameter_name = 2;

Returns
Type Description
String

The itemParameterName.

getItemParameterNameBytes()

public ByteString getItemParameterNameBytes()

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

string item_parameter_name = 2;

Returns
Type Description
ByteString

The bytes for itemParameterName.

getNumericFilter()

public NumericFilter getNumericFilter()

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Returns
Type Description
NumericFilter

The numericFilter.

getNumericFilterBuilder()

public NumericFilter.Builder getNumericFilterBuilder()

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Returns
Type Description
NumericFilter.Builder

getNumericFilterOrBuilder()

public NumericFilterOrBuilder getNumericFilterOrBuilder()

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Returns
Type Description
NumericFilterOrBuilder

getOneFilterCase()

public FunnelParameterFilter.OneFilterCase getOneFilterCase()
Returns
Type Description
FunnelParameterFilter.OneFilterCase

getOneParameterCase()

public FunnelParameterFilter.OneParameterCase getOneParameterCase()
Returns
Type Description
FunnelParameterFilter.OneParameterCase

getStringFilter()

public StringFilter getStringFilter()

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Returns
Type Description
StringFilter

The stringFilter.

getStringFilterBuilder()

public StringFilter.Builder getStringFilterBuilder()

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Returns
Type Description
StringFilter.Builder

getStringFilterOrBuilder()

public StringFilterOrBuilder getStringFilterOrBuilder()

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Returns
Type Description
StringFilterOrBuilder

hasBetweenFilter()

public boolean hasBetweenFilter()

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Returns
Type Description
boolean

Whether the betweenFilter field is set.

hasEventParameterName()

public boolean hasEventParameterName()

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

string event_parameter_name = 1;

Returns
Type Description
boolean

Whether the eventParameterName field is set.

hasInListFilter()

public boolean hasInListFilter()

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Returns
Type Description
boolean

Whether the inListFilter field is set.

hasItemParameterName()

public boolean hasItemParameterName()

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

string item_parameter_name = 2;

Returns
Type Description
boolean

Whether the itemParameterName field is set.

hasNumericFilter()

public boolean hasNumericFilter()

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Returns
Type Description
boolean

Whether the numericFilter field is set.

hasStringFilter()

public boolean hasStringFilter()

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Returns
Type Description
boolean

Whether the stringFilter field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBetweenFilter(BetweenFilter value)

public FunnelParameterFilter.Builder mergeBetweenFilter(BetweenFilter value)

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Parameter
Name Description
value BetweenFilter
Returns
Type Description
FunnelParameterFilter.Builder

mergeFrom(FunnelParameterFilter other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInListFilter(InListFilter value)

public FunnelParameterFilter.Builder mergeInListFilter(InListFilter value)

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Parameter
Name Description
value InListFilter
Returns
Type Description
FunnelParameterFilter.Builder

mergeNumericFilter(NumericFilter value)

public FunnelParameterFilter.Builder mergeNumericFilter(NumericFilter value)

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Parameter
Name Description
value NumericFilter
Returns
Type Description
FunnelParameterFilter.Builder

mergeStringFilter(StringFilter value)

public FunnelParameterFilter.Builder mergeStringFilter(StringFilter value)

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Parameter
Name Description
value StringFilter
Returns
Type Description
FunnelParameterFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBetweenFilter(BetweenFilter value)

public FunnelParameterFilter.Builder setBetweenFilter(BetweenFilter value)

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Parameter
Name Description
value BetweenFilter
Returns
Type Description
FunnelParameterFilter.Builder

setBetweenFilter(BetweenFilter.Builder builderForValue)

public FunnelParameterFilter.Builder setBetweenFilter(BetweenFilter.Builder builderForValue)

A filter for between two values.

.google.analytics.data.v1alpha.BetweenFilter between_filter = 7;

Parameter
Name Description
builderForValue BetweenFilter.Builder
Returns
Type Description
FunnelParameterFilter.Builder

setEventParameterName(String value)

public FunnelParameterFilter.Builder setEventParameterName(String value)

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

string event_parameter_name = 1;

Parameter
Name Description
value String

The eventParameterName to set.

Returns
Type Description
FunnelParameterFilter.Builder

This builder for chaining.

setEventParameterNameBytes(ByteString value)

public FunnelParameterFilter.Builder setEventParameterNameBytes(ByteString value)

This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency".

Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

string event_parameter_name = 1;

Parameter
Name Description
value ByteString

The bytes for eventParameterName to set.

Returns
Type Description
FunnelParameterFilter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setInListFilter(InListFilter value)

public FunnelParameterFilter.Builder setInListFilter(InListFilter value)

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Parameter
Name Description
value InListFilter
Returns
Type Description
FunnelParameterFilter.Builder

setInListFilter(InListFilter.Builder builderForValue)

public FunnelParameterFilter.Builder setInListFilter(InListFilter.Builder builderForValue)

A filter for in list values.

.google.analytics.data.v1alpha.InListFilter in_list_filter = 5;

Parameter
Name Description
builderForValue InListFilter.Builder
Returns
Type Description
FunnelParameterFilter.Builder

setItemParameterName(String value)

public FunnelParameterFilter.Builder setItemParameterName(String value)

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

string item_parameter_name = 2;

Parameter
Name Description
value String

The itemParameterName to set.

Returns
Type Description
FunnelParameterFilter.Builder

This builder for chaining.

setItemParameterNameBytes(ByteString value)

public FunnelParameterFilter.Builder setItemParameterNameBytes(ByteString value)

This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category".

Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.

Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the Measure ecommerce guide.

string item_parameter_name = 2;

Parameter
Name Description
value ByteString

The bytes for itemParameterName to set.

Returns
Type Description
FunnelParameterFilter.Builder

This builder for chaining.

setNumericFilter(NumericFilter value)

public FunnelParameterFilter.Builder setNumericFilter(NumericFilter value)

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Parameter
Name Description
value NumericFilter
Returns
Type Description
FunnelParameterFilter.Builder

setNumericFilter(NumericFilter.Builder builderForValue)

public FunnelParameterFilter.Builder setNumericFilter(NumericFilter.Builder builderForValue)

A filter for numeric or date values.

.google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;

Parameter
Name Description
builderForValue NumericFilter.Builder
Returns
Type Description
FunnelParameterFilter.Builder

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

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

setStringFilter(StringFilter value)

public FunnelParameterFilter.Builder setStringFilter(StringFilter value)

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Parameter
Name Description
value StringFilter
Returns
Type Description
FunnelParameterFilter.Builder

setStringFilter(StringFilter.Builder builderForValue)

public FunnelParameterFilter.Builder setStringFilter(StringFilter.Builder builderForValue)

Strings related filter.

.google.analytics.data.v1alpha.StringFilter string_filter = 4;

Parameter
Name Description
builderForValue StringFilter.Builder
Returns
Type Description
FunnelParameterFilter.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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