Class Report.Filter.FieldFilter (0.11.0) 

public static final class Report.Filter.FieldFilter extends GeneratedMessageV3 implements Report.Filter.FieldFilterOrBuilder

A filter on a specific field.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Report.Filter.FieldFilter

Static Fields

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

METRIC_VALUE_TYPE_FIELD_NUMBER

public static final int METRIC_VALUE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_FIELD_NUMBER

public static final int OPERATION_FIELD_NUMBER
Field Value
Type Description
int

SLICE_FIELD_NUMBER

public static final int SLICE_FIELD_NUMBER
Field Value
Type Description
int

TIME_PERIOD_INDEX_FIELD_NUMBER

public static final int TIME_PERIOD_INDEX_FIELD_NUMBER
Field Value
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Report.Filter.FieldFilter getDefaultInstance()
Returns
Type Description
Report.Filter.FieldFilter

getDescriptor()

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

newBuilder()

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

newBuilder(Report.Filter.FieldFilter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

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.

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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

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.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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