Class SegmentParameterFilter.Builder (0.55.0)

public static final class SegmentParameterFilter.Builder extends GeneratedMessageV3.Builder<SegmentParameterFilter.Builder> implements SegmentParameterFilterOrBuilder

An expression to filter parameter values in a segment.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilter

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SegmentParameterFilter build()
Returns
Type Description
SegmentParameterFilter

buildPartial()

public SegmentParameterFilter buildPartial()
Returns
Type Description
SegmentParameterFilter

clear()

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

clearBetweenFilter()

public SegmentParameterFilter.Builder clearBetweenFilter()

A filter for between two values.

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

Returns
Type Description
SegmentParameterFilter.Builder

clearEventParameterName()

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFilterScoping()

public SegmentParameterFilter.Builder clearFilterScoping()

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Returns
Type Description
SegmentParameterFilter.Builder

clearInListFilter()

public SegmentParameterFilter.Builder clearInListFilter()

A filter for in list values.

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

Returns
Type Description
SegmentParameterFilter.Builder

clearItemParameterName()

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

This builder for chaining.

clearNumericFilter()

public SegmentParameterFilter.Builder clearNumericFilter()

A filter for numeric or date values.

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

Returns
Type Description
SegmentParameterFilter.Builder

clearOneFilter()

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

clearOneParameter()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearStringFilter()

public SegmentParameterFilter.Builder clearStringFilter()

Strings related filter.

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

Returns
Type Description
SegmentParameterFilter.Builder

clone()

public SegmentParameterFilter.Builder clone()
Returns
Type Description
SegmentParameterFilter.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 SegmentParameterFilter getDefaultInstanceForType()
Returns
Type Description
SegmentParameterFilter

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.

getFilterScoping()

public SegmentParameterFilterScoping getFilterScoping()

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Returns
Type Description
SegmentParameterFilterScoping

The filterScoping.

getFilterScopingBuilder()

public SegmentParameterFilterScoping.Builder getFilterScopingBuilder()

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Returns
Type Description
SegmentParameterFilterScoping.Builder

getFilterScopingOrBuilder()

public SegmentParameterFilterScopingOrBuilder getFilterScopingOrBuilder()

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Returns
Type Description
SegmentParameterFilterScopingOrBuilder

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 SegmentParameterFilter.OneFilterCase getOneFilterCase()
Returns
Type Description
SegmentParameterFilter.OneFilterCase

getOneParameterCase()

public SegmentParameterFilter.OneParameterCase getOneParameterCase()
Returns
Type Description
SegmentParameterFilter.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.

hasFilterScoping()

public boolean hasFilterScoping()

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Returns
Type Description
boolean

Whether the filterScoping 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 SegmentParameterFilter.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
SegmentParameterFilter.Builder

mergeFilterScoping(SegmentParameterFilterScoping value)

public SegmentParameterFilter.Builder mergeFilterScoping(SegmentParameterFilterScoping value)

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Parameter
Name Description
value SegmentParameterFilterScoping
Returns
Type Description
SegmentParameterFilter.Builder

mergeFrom(SegmentParameterFilter other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInListFilter(InListFilter value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

mergeNumericFilter(NumericFilter value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

mergeStringFilter(StringFilter value)

public SegmentParameterFilter.Builder mergeStringFilter(StringFilter value)

Strings related filter.

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

Parameter
Name Description
value StringFilter
Returns
Type Description
SegmentParameterFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBetweenFilter(BetweenFilter value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

setBetweenFilter(BetweenFilter.Builder builderForValue)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

setEventParameterName(String value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

This builder for chaining.

setEventParameterNameBytes(ByteString value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilterScoping(SegmentParameterFilterScoping value)

public SegmentParameterFilter.Builder setFilterScoping(SegmentParameterFilterScoping value)

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Parameter
Name Description
value SegmentParameterFilterScoping
Returns
Type Description
SegmentParameterFilter.Builder

setFilterScoping(SegmentParameterFilterScoping.Builder builderForValue)

public SegmentParameterFilter.Builder setFilterScoping(SegmentParameterFilterScoping.Builder builderForValue)

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;

Parameter
Name Description
builderForValue SegmentParameterFilterScoping.Builder
Returns
Type Description
SegmentParameterFilter.Builder

setInListFilter(InListFilter value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

setInListFilter(InListFilter.Builder builderForValue)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

setItemParameterName(String value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

This builder for chaining.

setItemParameterNameBytes(ByteString value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

This builder for chaining.

setNumericFilter(NumericFilter value)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

setNumericFilter(NumericFilter.Builder builderForValue)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

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

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

setStringFilter(StringFilter value)

public SegmentParameterFilter.Builder setStringFilter(StringFilter value)

Strings related filter.

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

Parameter
Name Description
value StringFilter
Returns
Type Description
SegmentParameterFilter.Builder

setStringFilter(StringFilter.Builder builderForValue)

public SegmentParameterFilter.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
SegmentParameterFilter.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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