Class ReportDefinition.Filter.FieldFilter.Builder (0.39.0)

public static final class ReportDefinition.Filter.FieldFilter.Builder extends GeneratedMessageV3.Builder<ReportDefinition.Filter.FieldFilter.Builder> implements ReportDefinition.Filter.FieldFilterOrBuilder

A filter on a specific field.

Protobuf type google.ads.admanager.v1.ReportDefinition.Filter.FieldFilter

Static Methods

getDescriptor()

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

Methods

addAllValues(Iterable<? extends ReportValue> values)

public ReportDefinition.Filter.FieldFilter.Builder addAllValues(Iterable<? extends ReportValue> values)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.ads.admanager.v1.ReportValue>
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addValues(ReportValue value)

public ReportDefinition.Filter.FieldFilter.Builder addValues(ReportValue value)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ReportValue
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

addValues(ReportValue.Builder builderForValue)

public ReportDefinition.Filter.FieldFilter.Builder addValues(ReportValue.Builder builderForValue)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue ReportValue.Builder
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

addValues(int index, ReportValue value)

public ReportDefinition.Filter.FieldFilter.Builder addValues(int index, ReportValue value)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value ReportValue
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

addValues(int index, ReportValue.Builder builderForValue)

public ReportDefinition.Filter.FieldFilter.Builder addValues(int index, ReportValue.Builder builderForValue)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue ReportValue.Builder
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

addValuesBuilder()

public ReportValue.Builder addValuesBuilder()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportValue.Builder

addValuesBuilder(int index)

public ReportValue.Builder addValuesBuilder(int index)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReportValue.Builder

build()

public ReportDefinition.Filter.FieldFilter build()
Returns
Type Description
ReportDefinition.Filter.FieldFilter

buildPartial()

public ReportDefinition.Filter.FieldFilter buildPartial()
Returns
Type Description
ReportDefinition.Filter.FieldFilter

clear()

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

clearField()

public ReportDefinition.Filter.FieldFilter.Builder clearField()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearMetricValueType()

public ReportDefinition.Filter.FieldFilter.Builder clearMetricValueType()

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOperation()

public ReportDefinition.Filter.FieldFilter.Builder clearOperation()

Required. The operation of this filter.

.google.ads.admanager.v1.ReportDefinition.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

clearSlice()

public ReportDefinition.Filter.FieldFilter.Builder clearSlice()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

clearTimePeriodIndex()

public ReportDefinition.Filter.FieldFilter.Builder clearTimePeriodIndex()

Optional. When using time period columns, use this to filter on a specific column.

optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

clearValues()

public ReportDefinition.Filter.FieldFilter.Builder clearValues()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

clone()

public ReportDefinition.Filter.FieldFilter.Builder clone()
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder
Overrides

getDefaultInstanceForType()

public ReportDefinition.Filter.FieldFilter getDefaultInstanceForType()
Returns
Type Description
ReportDefinition.Filter.FieldFilter

getDescriptorForType()

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

getField()

public ReportDefinition.Field getField()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.Field

The field.

getFieldBuilder()

public ReportDefinition.Field.Builder getFieldBuilder()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.Field.Builder

getFieldOrBuilder()

public ReportDefinition.FieldOrBuilder getFieldOrBuilder()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.FieldOrBuilder

getMetricValueType()

public ReportDefinition.MetricValueType getMetricValueType()

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.MetricValueType

The metricValueType.

getMetricValueTypeValue()

public int getMetricValueTypeValue()

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for metricValueType.

getOperation()

public ReportDefinition.Filter.Operation getOperation()

Required. The operation of this filter.

.google.ads.admanager.v1.ReportDefinition.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReportDefinition.Filter.Operation

The operation.

getOperationValue()

public int getOperationValue()

Required. The operation of this filter.

.google.ads.admanager.v1.ReportDefinition.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for operation.

getSlice()

public ReportDefinition.Slice getSlice()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.Slice

The slice.

getSliceBuilder()

public ReportDefinition.Slice.Builder getSliceBuilder()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.Slice.Builder

getSliceOrBuilder()

public ReportDefinition.SliceOrBuilder getSliceOrBuilder()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReportDefinition.SliceOrBuilder

getTimePeriodIndex()

public int getTimePeriodIndex()

Optional. When using time period columns, use this to filter on a specific column.

optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The timePeriodIndex.

getValues(int index)

public ReportValue getValues(int index)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReportValue

getValuesBuilder(int index)

public ReportValue.Builder getValuesBuilder(int index)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReportValue.Builder

getValuesBuilderList()

public List<ReportValue.Builder> getValuesBuilderList()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getValuesCount()

public int getValuesCount()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getValuesList()

public List<ReportValue> getValuesList()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<ReportValue>

getValuesOrBuilder(int index)

public ReportValueOrBuilder getValuesOrBuilder(int index)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReportValueOrBuilder

getValuesOrBuilderList()

public List<? extends ReportValueOrBuilder> getValuesOrBuilderList()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.ReportValueOrBuilder>

hasField()

public boolean hasField()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the field field is set.

hasMetricValueType()

public boolean hasMetricValueType()

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metricValueType field is set.

hasSlice()

public boolean hasSlice()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the slice field is set.

hasTimePeriodIndex()

public boolean hasTimePeriodIndex()

Optional. When using time period columns, use this to filter on a specific column.

optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the timePeriodIndex field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeField(ReportDefinition.Field value)

public ReportDefinition.Filter.FieldFilter.Builder mergeField(ReportDefinition.Field value)

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ReportDefinition.Field
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

mergeFrom(ReportDefinition.Filter.FieldFilter other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeSlice(ReportDefinition.Slice value)

public ReportDefinition.Filter.FieldFilter.Builder mergeSlice(ReportDefinition.Slice value)

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ReportDefinition.Slice
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeValues(int index)

public ReportDefinition.Filter.FieldFilter.Builder removeValues(int index)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

setField(ReportDefinition.Field value)

public ReportDefinition.Filter.FieldFilter.Builder setField(ReportDefinition.Field value)

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ReportDefinition.Field
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

setField(ReportDefinition.Field.Builder builderForValue)

public ReportDefinition.Filter.FieldFilter.Builder setField(ReportDefinition.Field.Builder builderForValue)

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue ReportDefinition.Field.Builder
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setMetricValueType(ReportDefinition.MetricValueType value)

public ReportDefinition.Filter.FieldFilter.Builder setMetricValueType(ReportDefinition.MetricValueType value)

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ReportDefinition.MetricValueType

The metricValueType to set.

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

setMetricValueTypeValue(int value)

public ReportDefinition.Filter.FieldFilter.Builder setMetricValueTypeValue(int value)

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for metricValueType to set.

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

setOperation(ReportDefinition.Filter.Operation value)

public ReportDefinition.Filter.FieldFilter.Builder setOperation(ReportDefinition.Filter.Operation value)

Required. The operation of this filter.

.google.ads.admanager.v1.ReportDefinition.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ReportDefinition.Filter.Operation

The operation to set.

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

setOperationValue(int value)

public ReportDefinition.Filter.FieldFilter.Builder setOperationValue(int value)

Required. The operation of this filter.

.google.ads.admanager.v1.ReportDefinition.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for operation to set.

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

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

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

setSlice(ReportDefinition.Slice value)

public ReportDefinition.Filter.FieldFilter.Builder setSlice(ReportDefinition.Slice value)

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ReportDefinition.Slice
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

setSlice(ReportDefinition.Slice.Builder builderForValue)

public ReportDefinition.Filter.FieldFilter.Builder setSlice(ReportDefinition.Slice.Builder builderForValue)

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ReportDefinition.Slice.Builder
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

setTimePeriodIndex(int value)

public ReportDefinition.Filter.FieldFilter.Builder setTimePeriodIndex(int value)

Optional. When using time period columns, use this to filter on a specific column.

optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The timePeriodIndex to set.

Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setValues(int index, ReportValue value)

public ReportDefinition.Filter.FieldFilter.Builder setValues(int index, ReportValue value)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value ReportValue
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder

setValues(int index, ReportValue.Builder builderForValue)

public ReportDefinition.Filter.FieldFilter.Builder setValues(int index, ReportValue.Builder builderForValue)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue ReportValue.Builder
Returns
Type Description
ReportDefinition.Filter.FieldFilter.Builder