Class ReportDefinition.Filter.FieldFilter (0.44.0)

Version latest

• 0.44.0 (latest)
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.29.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class ReportDefinition.Filter.FieldFilter extends GeneratedMessage implements ReportDefinition.Filter.FieldFilterOrBuilder

A filter on a specific field.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ReportDefinition.Filter.FieldFilter

Implements

ReportDefinition.Filter.FieldFilterOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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 ReportDefinition.Filter.FieldFilter getDefaultInstance()

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ReportDefinition.Filter.FieldFilter.Builder newBuilder()

Returns
Type	Description
ReportDefinition.Filter.FieldFilter.Builder

newBuilder(ReportDefinition.Filter.FieldFilter prototype)

public static ReportDefinition.Filter.FieldFilter.Builder newBuilder(ReportDefinition.Filter.FieldFilter prototype)

Parameter
Name	Description
prototype	ReportDefinition.Filter.FieldFilter

Returns
Type	Description
ReportDefinition.Filter.FieldFilter.Builder

parseDelimitedFrom(InputStream input)

public static ReportDefinition.Filter.FieldFilter parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportDefinition.Filter.FieldFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ReportDefinition.Filter.FieldFilter parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReportDefinition.Filter.FieldFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReportDefinition.Filter.FieldFilter parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReportDefinition.Filter.FieldFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReportDefinition.Filter.FieldFilter parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportDefinition.Filter.FieldFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ReportDefinition.Filter.FieldFilter parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReportDefinition.Filter.FieldFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ReportDefinition.Filter.FieldFilter parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReportDefinition.Filter.FieldFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ReportDefinition.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

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public ReportDefinition.Filter.FieldFilter getDefaultInstanceForType()

Returns
Type	Description
ReportDefinition.Filter.FieldFilter

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.

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.

getParserForType()

public Parser<ReportDefinition.Filter.FieldFilter> getParserForType()

Returns
Type	Description
Parser<FieldFilter>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

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

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public ReportDefinition.Filter.FieldFilter.Builder newBuilderForType()

Returns
Type	Description
ReportDefinition.Filter.FieldFilter.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ReportDefinition.Filter.FieldFilter.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ReportDefinition.Filter.FieldFilter.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ReportDefinition.Filter.FieldFilter.Builder toBuilder()

Returns
Type	Description
ReportDefinition.Filter.FieldFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException