Class SegmentFilter (0.55.0)

public final class SegmentFilter extends GeneratedMessageV3 implements SegmentFilterOrBuilder

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1alpha.SegmentFilter

Static Fields

BETWEEN_FILTER_FIELD_NUMBER

public static final int BETWEEN_FILTER_FIELD_NUMBER
Field Value
Type Description
int

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_NAME_FIELD_NUMBER
Field Value
Type Description
int

FILTER_SCOPING_FIELD_NUMBER

public static final int FILTER_SCOPING_FIELD_NUMBER
Field Value
Type Description
int

IN_LIST_FILTER_FIELD_NUMBER

public static final int IN_LIST_FILTER_FIELD_NUMBER
Field Value
Type Description
int

NUMERIC_FILTER_FIELD_NUMBER

public static final int NUMERIC_FILTER_FIELD_NUMBER
Field Value
Type Description
int

STRING_FILTER_FIELD_NUMBER

public static final int STRING_FILTER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SegmentFilter getDefaultInstance()
Returns
Type Description
SegmentFilter

getDescriptor()

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

newBuilder()

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

newBuilder(SegmentFilter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

getBetweenFilterOrBuilder()

public BetweenFilterOrBuilder getBetweenFilterOrBuilder()

A filter for between two values.

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

Returns
Type Description
BetweenFilterOrBuilder

getDefaultInstanceForType()

public SegmentFilter getDefaultInstanceForType()
Returns
Type Description
SegmentFilter

getFieldName()

public String getFieldName()

The dimension name or metric name.

string field_name = 1;

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

The dimension name or metric name.

string field_name = 1;

Returns
Type Description
ByteString

The bytes for fieldName.

getFilterScoping()

public SegmentFilterScoping getFilterScoping()

Specifies the scope for the filter.

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

Returns
Type Description
SegmentFilterScoping

The filterScoping.

getFilterScopingOrBuilder()

public SegmentFilterScopingOrBuilder getFilterScopingOrBuilder()

Specifies the scope for the filter.

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

Returns
Type Description
SegmentFilterScopingOrBuilder

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.

getInListFilterOrBuilder()

public InListFilterOrBuilder getInListFilterOrBuilder()

A filter for in list values.

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

Returns
Type Description
InListFilterOrBuilder

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.

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStringFilter()

public StringFilter getStringFilter()

Strings related filter.

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

Returns
Type Description
StringFilter

The stringFilter.

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.

hasFilterScoping()

public boolean hasFilterScoping()

Specifies the scope for the filter.

.google.analytics.data.v1alpha.SegmentFilterScoping 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.

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.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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