Class SegmentFilter (0.31.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
TypeDescription
int

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_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

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 SegmentFilter getDefaultInstance()
Returns
TypeDescription
SegmentFilter

getDescriptor()

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

newBuilder()

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

newBuilder(SegmentFilter prototype)

public static SegmentFilter.Builder newBuilder(SegmentFilter prototype)
Parameter
NameDescription
prototypeSegmentFilter
Returns
TypeDescription
SegmentFilter.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 SegmentFilter getDefaultInstanceForType()
Returns
TypeDescription
SegmentFilter

getFieldName()

public String getFieldName()

The dimension name or metric name.

string field_name = 1;

Returns
TypeDescription
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

The dimension name or metric name.

string field_name = 1;

Returns
TypeDescription
ByteString

The bytes for fieldName.

getFilterScoping()

public SegmentFilterScoping getFilterScoping()

Specifies the scope for the filter.

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

Returns
TypeDescription
SegmentFilterScoping

The filterScoping.

getFilterScopingOrBuilder()

public SegmentFilterScopingOrBuilder getFilterScopingOrBuilder()

Specifies the scope for the filter.

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

Returns
TypeDescription
SegmentFilterScopingOrBuilder

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

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

getParserForType()

public Parser<SegmentFilter> getParserForType()
Returns
TypeDescription
Parser<SegmentFilter>
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.

hasFilterScoping()

public boolean hasFilterScoping()

Specifies the scope for the filter.

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

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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