Class Filter.Builder (0.60.0)

public static final class Filter.Builder extends GeneratedMessageV3.Builder<Filter.Builder> implements FilterOrBuilder

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1beta.Filter

Implements

FilterOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Filter build()
Returns
Type Description
Filter

buildPartial()

public Filter buildPartial()
Returns
Type Description
Filter

clear()

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

clearBetweenFilter()

public Filter.Builder clearBetweenFilter()

A filter for two values.

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

Returns
Type Description
Filter.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearFieldName()

public Filter.Builder clearFieldName()

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
Filter.Builder

This builder for chaining.

clearInListFilter()

public Filter.Builder clearInListFilter()

A filter for in list values.

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

Returns
Type Description
Filter.Builder

clearNumericFilter()

public Filter.Builder clearNumericFilter()

A filter for numeric or date values.

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

Returns
Type Description
Filter.Builder

clearOneFilter()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearStringFilter()

public Filter.Builder clearStringFilter()

Strings related filter.

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

Returns
Type Description
Filter.Builder

clone()

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

getBetweenFilterBuilder()

public Filter.BetweenFilter.Builder getBetweenFilterBuilder()

A filter for two values.

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

Returns
Type Description
Filter.BetweenFilter.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getInListFilterBuilder()

public Filter.InListFilter.Builder getInListFilterBuilder()

A filter for in list values.

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

Returns
Type Description
Filter.InListFilter.Builder

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.

getNumericFilterBuilder()

public Filter.NumericFilter.Builder getNumericFilterBuilder()

A filter for numeric or date values.

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

Returns
Type Description
Filter.NumericFilter.Builder

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

getStringFilter()

public Filter.StringFilter getStringFilter()

Strings related filter.

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

Returns
Type Description
Filter.StringFilter

The stringFilter.

getStringFilterBuilder()

public Filter.StringFilter.Builder getStringFilterBuilder()

Strings related filter.

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

Returns
Type Description
Filter.StringFilter.Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBetweenFilter(Filter.BetweenFilter value)

public Filter.Builder mergeBetweenFilter(Filter.BetweenFilter value)

A filter for two values.

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

Parameter
Name Description
value Filter.BetweenFilter
Returns
Type Description
Filter.Builder

mergeFrom(Filter other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInListFilter(Filter.InListFilter value)

public Filter.Builder mergeInListFilter(Filter.InListFilter value)

A filter for in list values.

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

Parameter
Name Description
value Filter.InListFilter
Returns
Type Description
Filter.Builder

mergeNumericFilter(Filter.NumericFilter value)

public Filter.Builder mergeNumericFilter(Filter.NumericFilter value)

A filter for numeric or date values.

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

Parameter
Name Description
value Filter.NumericFilter
Returns
Type Description
Filter.Builder

mergeStringFilter(Filter.StringFilter value)

public Filter.Builder mergeStringFilter(Filter.StringFilter value)

Strings related filter.

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

Parameter
Name Description
value Filter.StringFilter
Returns
Type Description
Filter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBetweenFilter(Filter.BetweenFilter value)

public Filter.Builder setBetweenFilter(Filter.BetweenFilter value)

A filter for two values.

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

Parameter
Name Description
value Filter.BetweenFilter
Returns
Type Description
Filter.Builder

setBetweenFilter(Filter.BetweenFilter.Builder builderForValue)

public Filter.Builder setBetweenFilter(Filter.BetweenFilter.Builder builderForValue)

A filter for two values.

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

Parameter
Name Description
builderForValue Filter.BetweenFilter.Builder
Returns
Type Description
Filter.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setFieldName(String value)

public Filter.Builder setFieldName(String value)

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;

Parameter
Name Description
value String

The fieldName to set.

Returns
Type Description
Filter.Builder

This builder for chaining.

setFieldNameBytes(ByteString value)

public Filter.Builder setFieldNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fieldName to set.

Returns
Type Description
Filter.Builder

This builder for chaining.

setInListFilter(Filter.InListFilter value)

public Filter.Builder setInListFilter(Filter.InListFilter value)

A filter for in list values.

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

Parameter
Name Description
value Filter.InListFilter
Returns
Type Description
Filter.Builder

setInListFilter(Filter.InListFilter.Builder builderForValue)

public Filter.Builder setInListFilter(Filter.InListFilter.Builder builderForValue)

A filter for in list values.

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

Parameter
Name Description
builderForValue Filter.InListFilter.Builder
Returns
Type Description
Filter.Builder

setNumericFilter(Filter.NumericFilter value)

public Filter.Builder setNumericFilter(Filter.NumericFilter value)

A filter for numeric or date values.

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

Parameter
Name Description
value Filter.NumericFilter
Returns
Type Description
Filter.Builder

setNumericFilter(Filter.NumericFilter.Builder builderForValue)

public Filter.Builder setNumericFilter(Filter.NumericFilter.Builder builderForValue)

A filter for numeric or date values.

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

Parameter
Name Description
builderForValue Filter.NumericFilter.Builder
Returns
Type Description
Filter.Builder

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

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

setStringFilter(Filter.StringFilter value)

public Filter.Builder setStringFilter(Filter.StringFilter value)

Strings related filter.

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

Parameter
Name Description
value Filter.StringFilter
Returns
Type Description
Filter.Builder

setStringFilter(Filter.StringFilter.Builder builderForValue)

public Filter.Builder setStringFilter(Filter.StringFilter.Builder builderForValue)

Strings related filter.

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

Parameter
Name Description
builderForValue Filter.StringFilter.Builder
Returns
Type Description
Filter.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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