public static final class Report.Filter.FieldFilter.Builder extends GeneratedMessageV3.Builder<Report.Filter.FieldFilter.Builder> implements Report.Filter.FieldFilterOrBuilder
A filter on a specific field.
Protobuf type google.ads.admanager.v1.Report.Filter.FieldFilter
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Report.Filter.FieldFilter.BuilderImplements
Report.Filter.FieldFilterOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllValues(Iterable<? extends Report.Value> values)
public Report.Filter.FieldFilter.Builder addAllValues(Iterable<? extends Report.Value> values)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.ads.admanager.v1.Report.Value> |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Report.Filter.FieldFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
addValues(Report.Value value)
public Report.Filter.FieldFilter.Builder addValues(Report.Value value)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Report.Value |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
addValues(Report.Value.Builder builderForValue)
public Report.Filter.FieldFilter.Builder addValues(Report.Value.Builder builderForValue)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
Report.Value.Builder |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
addValues(int index, Report.Value value)
public Report.Filter.FieldFilter.Builder addValues(int index, Report.Value value)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Report.Value |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
addValues(int index, Report.Value.Builder builderForValue)
public Report.Filter.FieldFilter.Builder addValues(int index, Report.Value.Builder builderForValue)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Report.Value.Builder |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
addValuesBuilder()
public Report.Value.Builder addValuesBuilder()
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.Value.Builder |
addValuesBuilder(int index)
public Report.Value.Builder addValuesBuilder(int index)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Report.Value.Builder |
build()
public Report.Filter.FieldFilter build()
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter |
buildPartial()
public Report.Filter.FieldFilter buildPartial()
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter |
clear()
public Report.Filter.FieldFilter.Builder clear()
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
clearField()
public Report.Filter.FieldFilter.Builder clearField()
Required. The field to filter on.
.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
clearField(Descriptors.FieldDescriptor field)
public Report.Filter.FieldFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
clearMetricValueType()
public Report.Filter.FieldFilter.Builder clearMetricValueType()
Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.
optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Report.Filter.FieldFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
clearOperation()
public Report.Filter.FieldFilter.Builder clearOperation()
Required. The operation of this filter.
.google.ads.admanager.v1.Report.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
clearSlice()
public Report.Filter.FieldFilter.Builder clearSlice()
Optional. Use to filter on a specific slice of data.
optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
clearTimePeriodIndex()
public Report.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 |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
clearValues()
public Report.Filter.FieldFilter.Builder clearValues()
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
clone()
public Report.Filter.FieldFilter.Builder clone()
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
getDefaultInstanceForType()
public Report.Filter.FieldFilter getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getField()
public Report.Field getField()
Required. The field to filter on.
.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.Field |
The field. |
getFieldBuilder()
public Report.Field.Builder getFieldBuilder()
Required. The field to filter on.
.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.Field.Builder |
getFieldOrBuilder()
public Report.FieldOrBuilder getFieldOrBuilder()
Required. The field to filter on.
.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.FieldOrBuilder |
getMetricValueType()
public Report.MetricValueType getMetricValueType()
Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.
optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Report.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.Report.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 Report.Filter.Operation getOperation()
Required. The operation of this filter.
.google.ads.admanager.v1.Report.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Report.Filter.Operation |
The operation. |
getOperationValue()
public int getOperationValue()
Required. The operation of this filter.
.google.ads.admanager.v1.Report.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for operation. |
getSlice()
public Report.Slice getSlice()
Optional. Use to filter on a specific slice of data.
optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Report.Slice |
The slice. |
getSliceBuilder()
public Report.Slice.Builder getSliceBuilder()
Optional. Use to filter on a specific slice of data.
optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Report.Slice.Builder |
getSliceOrBuilder()
public Report.SliceOrBuilder getSliceOrBuilder()
Optional. Use to filter on a specific slice of data.
optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Report.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 Report.Value getValues(int index)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Report.Value |
getValuesBuilder(int index)
public Report.Value.Builder getValuesBuilder(int index)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Report.Value.Builder |
getValuesBuilderList()
public List<Report.Value.Builder> getValuesBuilderList()
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value 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.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int |
getValuesList()
public List<Report.Value> getValuesList()
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
List<Value> |
getValuesOrBuilder(int index)
public Report.ValueOrBuilder getValuesOrBuilder(int index)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Report.ValueOrBuilder |
getValuesOrBuilderList()
public List<? extends Report.ValueOrBuilder> getValuesOrBuilderList()
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
List<? extends com.google.ads.admanager.v1.Report.ValueOrBuilder> |
hasField()
public boolean hasField()
Required. The field to filter on.
.google.ads.admanager.v1.Report.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.Report.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.Report.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 |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeField(Report.Field value)
public Report.Filter.FieldFilter.Builder mergeField(Report.Field value)
Required. The field to filter on.
.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Report.Field |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
mergeFrom(Report.Filter.FieldFilter other)
public Report.Filter.FieldFilter.Builder mergeFrom(Report.Filter.FieldFilter other)
Parameter | |
---|---|
Name | Description |
other |
Report.Filter.FieldFilter |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Report.Filter.FieldFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Report.Filter.FieldFilter.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
mergeSlice(Report.Slice value)
public Report.Filter.FieldFilter.Builder mergeSlice(Report.Slice value)
Optional. Use to filter on a specific slice of data.
optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Report.Slice |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Report.Filter.FieldFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
removeValues(int index)
public Report.Filter.FieldFilter.Builder removeValues(int index)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setField(Report.Field value)
public Report.Filter.FieldFilter.Builder setField(Report.Field value)
Required. The field to filter on.
.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Report.Field |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setField(Report.Field.Builder builderForValue)
public Report.Filter.FieldFilter.Builder setField(Report.Field.Builder builderForValue)
Required. The field to filter on.
.google.ads.admanager.v1.Report.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
Report.Field.Builder |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Report.Filter.FieldFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setMetricValueType(Report.MetricValueType value)
public Report.Filter.FieldFilter.Builder setMetricValueType(Report.MetricValueType value)
Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.
optional .google.ads.admanager.v1.Report.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Report.MetricValueType The metricValueType to set. |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
setMetricValueTypeValue(int value)
public Report.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.Report.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 |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
setOperation(Report.Filter.Operation value)
public Report.Filter.FieldFilter.Builder setOperation(Report.Filter.Operation value)
Required. The operation of this filter.
.google.ads.admanager.v1.Report.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Report.Filter.Operation The operation to set. |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
setOperationValue(int value)
public Report.Filter.FieldFilter.Builder setOperationValue(int value)
Required. The operation of this filter.
.google.ads.admanager.v1.Report.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 |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Report.Filter.FieldFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setSlice(Report.Slice value)
public Report.Filter.FieldFilter.Builder setSlice(Report.Slice value)
Optional. Use to filter on a specific slice of data.
optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Report.Slice |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setSlice(Report.Slice.Builder builderForValue)
public Report.Filter.FieldFilter.Builder setSlice(Report.Slice.Builder builderForValue)
Optional. Use to filter on a specific slice of data.
optional .google.ads.admanager.v1.Report.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Report.Slice.Builder |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setTimePeriodIndex(int value)
public Report.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 |
Report.Filter.FieldFilter.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Report.Filter.FieldFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setValues(int index, Report.Value value)
public Report.Filter.FieldFilter.Builder setValues(int index, Report.Value value)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Report.Value |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |
setValues(int index, Report.Value.Builder builderForValue)
public Report.Filter.FieldFilter.Builder setValues(int index, Report.Value.Builder builderForValue)
Required. Values to filter to.
repeated .google.ads.admanager.v1.Report.Value values = 3 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Report.Value.Builder |
Returns | |
---|---|
Type | Description |
Report.Filter.FieldFilter.Builder |