Class SegmentParameterFilter (0.45.0)

public final class SegmentParameterFilter extends GeneratedMessageV3 implements SegmentParameterFilterOrBuilder

An expression to filter parameter values in a segment.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilter

Static Fields

BETWEEN_FILTER_FIELD_NUMBER

public static final int BETWEEN_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_PARAMETER_NAME_FIELD_NUMBER

public static final int EVENT_PARAMETER_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

FILTER_SCOPING_FIELD_NUMBER

public static final int FILTER_SCOPING_FIELD_NUMBER
Field Value
TypeDescription
int

IN_LIST_FILTER_FIELD_NUMBER

public static final int IN_LIST_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

ITEM_PARAMETER_NAME_FIELD_NUMBER

public static final int ITEM_PARAMETER_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NUMERIC_FILTER_FIELD_NUMBER

public static final int NUMERIC_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

STRING_FILTER_FIELD_NUMBER

public static final int STRING_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SegmentParameterFilter getDefaultInstance()
Returns
TypeDescription
SegmentParameterFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SegmentParameterFilter.Builder newBuilder()
Returns
TypeDescription
SegmentParameterFilter.Builder

newBuilder(SegmentParameterFilter prototype)

public static SegmentParameterFilter.Builder newBuilder(SegmentParameterFilter prototype)
Parameter
NameDescription
prototypeSegmentParameterFilter
Returns
TypeDescription
SegmentParameterFilter.Builder

parseDelimitedFrom(InputStream input)

public static SegmentParameterFilter parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SegmentParameterFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SegmentParameterFilter parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SegmentParameterFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SegmentParameterFilter parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SegmentParameterFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SegmentParameterFilter parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SegmentParameterFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SegmentParameterFilter parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SegmentParameterFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SegmentParameterFilter parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SegmentParameterFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SegmentParameterFilter
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SegmentParameterFilter> parser()
Returns
TypeDescription
Parser<SegmentParameterFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBetweenFilter()

public BetweenFilter getBetweenFilter()

A filter for between two values.

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

Returns
TypeDescription
BetweenFilter

The betweenFilter.

getBetweenFilterOrBuilder()

public BetweenFilterOrBuilder getBetweenFilterOrBuilder()

A filter for between two values.

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

Returns
TypeDescription
BetweenFilterOrBuilder

getDefaultInstanceForType()

public SegmentParameterFilter getDefaultInstanceForType()
Returns
TypeDescription
SegmentParameterFilter

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
TypeDescription
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
TypeDescription
ByteString

The bytes for eventParameterName.

getFilterScoping()

public SegmentParameterFilterScoping getFilterScoping()

Specifies the scope for the filter.

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

Returns
TypeDescription
SegmentParameterFilterScoping

The filterScoping.

getFilterScopingOrBuilder()

public SegmentParameterFilterScopingOrBuilder getFilterScopingOrBuilder()

Specifies the scope for the filter.

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

Returns
TypeDescription
SegmentParameterFilterScopingOrBuilder

getInListFilter()

public InListFilter getInListFilter()

A filter for in list values.

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

Returns
TypeDescription
InListFilter

The inListFilter.

getInListFilterOrBuilder()

public InListFilterOrBuilder getInListFilterOrBuilder()

A filter for in list values.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
NumericFilter

The numericFilter.

getNumericFilterOrBuilder()

public NumericFilterOrBuilder getNumericFilterOrBuilder()

A filter for numeric or date values.

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

Returns
TypeDescription
NumericFilterOrBuilder

getOneFilterCase()

public SegmentParameterFilter.OneFilterCase getOneFilterCase()
Returns
TypeDescription
SegmentParameterFilter.OneFilterCase

getOneParameterCase()

public SegmentParameterFilter.OneParameterCase getOneParameterCase()
Returns
TypeDescription
SegmentParameterFilter.OneParameterCase

getParserForType()

public Parser<SegmentParameterFilter> getParserForType()
Returns
TypeDescription
Parser<SegmentParameterFilter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStringFilter()

public StringFilter getStringFilter()

Strings related filter.

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

Returns
TypeDescription
StringFilter

The stringFilter.

getStringFilterOrBuilder()

public StringFilterOrBuilder getStringFilterOrBuilder()

Strings related filter.

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

Returns
TypeDescription
StringFilterOrBuilder

hasBetweenFilter()

public boolean hasBetweenFilter()

A filter for between two values.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the numericFilter field is set.

hasStringFilter()

public boolean hasStringFilter()

Strings related filter.

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

Returns
TypeDescription
boolean

Whether the stringFilter field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SegmentParameterFilter.Builder newBuilderForType()
Returns
TypeDescription
SegmentParameterFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SegmentParameterFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SegmentParameterFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SegmentParameterFilter.Builder toBuilder()
Returns
TypeDescription
SegmentParameterFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException