Class Filter (0.59.0) 

public final class Filter extends GeneratedMessageV3 implements FilterOrBuilder

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1beta.Filter

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Filter

Implements

FilterOrBuilder

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

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 Filter getDefaultInstance()
Returns
Type Description
Filter

getDescriptor()

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

newBuilder()

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

newBuilder(Filter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBetweenFilter()

public Filter.BetweenFilter getBetweenFilter()

A filter for two values.

.google.analytics.data.v1beta.Filter.BetweenFilter between_filter = 6;

Returns
Type Description
Filter.BetweenFilter

The betweenFilter.

getBetweenFilterOrBuilder()

public Filter.BetweenFilterOrBuilder getBetweenFilterOrBuilder()

A filter for two values.

.google.analytics.data.v1beta.Filter.BetweenFilter between_filter = 6;

Returns
Type Description
Filter.BetweenFilterOrBuilder

getDefaultInstanceForType()

public Filter getDefaultInstanceForType()
Returns
Type Description
Filter

getFieldName()

public String getFieldName()

The dimension name or metric name.

In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.

string field_name = 1;

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

The dimension name or metric name.

In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.

string field_name = 1;

Returns
Type Description
ByteString

The bytes for fieldName.

getInListFilter()

public Filter.InListFilter getInListFilter()

A filter for in list values.

.google.analytics.data.v1beta.Filter.InListFilter in_list_filter = 4;

Returns
Type Description
Filter.InListFilter

The inListFilter.

getInListFilterOrBuilder()

public Filter.InListFilterOrBuilder getInListFilterOrBuilder()

A filter for in list values.

.google.analytics.data.v1beta.Filter.InListFilter in_list_filter = 4;

Returns
Type Description
Filter.InListFilterOrBuilder

getNumericFilter()

public Filter.NumericFilter getNumericFilter()

A filter for numeric or date values.

.google.analytics.data.v1beta.Filter.NumericFilter numeric_filter = 5;

Returns
Type Description
Filter.NumericFilter

The numericFilter.

getNumericFilterOrBuilder()

public Filter.NumericFilterOrBuilder getNumericFilterOrBuilder()

A filter for numeric or date values.

.google.analytics.data.v1beta.Filter.NumericFilter numeric_filter = 5;

Returns
Type Description
Filter.NumericFilterOrBuilder

getOneFilterCase()

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStringFilter()

public Filter.StringFilter getStringFilter()

Strings related filter.

.google.analytics.data.v1beta.Filter.StringFilter string_filter = 3;

Returns
Type Description
Filter.StringFilter

The stringFilter.

getStringFilterOrBuilder()

public Filter.StringFilterOrBuilder getStringFilterOrBuilder()

Strings related filter.

.google.analytics.data.v1beta.Filter.StringFilter string_filter = 3;

Returns
Type Description
Filter.StringFilterOrBuilder

hasBetweenFilter()

public boolean hasBetweenFilter()

A filter for two values.

.google.analytics.data.v1beta.Filter.BetweenFilter between_filter = 6;

Returns
Type Description
boolean

Whether the betweenFilter field is set.

hasInListFilter()

public boolean hasInListFilter()

A filter for in list values.

.google.analytics.data.v1beta.Filter.InListFilter in_list_filter = 4;

Returns
Type Description
boolean

Whether the inListFilter field is set.

hasNumericFilter()

public boolean hasNumericFilter()

A filter for numeric or date values.

.google.analytics.data.v1beta.Filter.NumericFilter numeric_filter = 5;

Returns
Type Description
boolean

Whether the numericFilter field is set.

hasStringFilter()

public boolean hasStringFilter()

Strings related filter.

.google.analytics.data.v1beta.Filter.StringFilter string_filter = 3;

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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