Class ReportDefinition.Sort (0.46.0)

public static final class ReportDefinition.Sort extends GeneratedMessage implements ReportDefinition.SortOrBuilder

Represents a sorting in a report.

Protobuf type google.ads.admanager.v1.ReportDefinition.Sort

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ReportDefinition.Sort

Implements

ReportDefinition.SortOrBuilder

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

DESCENDING_FIELD_NUMBER

public static final int DESCENDING_FIELD_NUMBER

Field Value
Type	Description
`int`

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`

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`

Static Methods

getDefaultInstance()

public static ReportDefinition.Sort getDefaultInstance()

Returns
Type	Description
`ReportDefinition.Sort`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ReportDefinition.Sort.Builder newBuilder()

Returns
Type	Description
`ReportDefinition.Sort.Builder`

newBuilder(ReportDefinition.Sort prototype)

public static ReportDefinition.Sort.Builder newBuilder(ReportDefinition.Sort prototype)

Parameter
Name	Description
`prototype`	`ReportDefinition.Sort`

Returns
Type	Description
`ReportDefinition.Sort.Builder`

parseDelimitedFrom(InputStream input)

public static ReportDefinition.Sort parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ReportDefinition.Sort parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ReportDefinition.Sort parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ReportDefinition.Sort parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ReportDefinition.Sort parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ReportDefinition.Sort parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ReportDefinition.Sort`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ReportDefinition.Sort> parser()

Returns
Type	Description
`Parser<Sort>`

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.Sort getDefaultInstanceForType()

Returns
Type	Description
`ReportDefinition.Sort`

getDescending()

public boolean getDescending()

Optional. The sort order. If true the sort will be descending.

bool descending = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The descending.

getField()

public ReportDefinition.Field getField()

Required. A field (dimension or metric) to sort by.

.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. A field (dimension or metric) to sort by.

.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 sort on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 5 [(.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 sort on. Defaults to PRIMARY.

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

Returns
Type	Description
`int`	The enum numeric value on the wire for metricValueType.

getParserForType()

public Parser<ReportDefinition.Sort> getParserForType()

Returns
Type	Description
`Parser<Sort>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

getSlice()

public ReportDefinition.Slice getSlice()

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

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

Returns
Type	Description
`ReportDefinition.Slice`	The slice.

getSliceOrBuilder()

public ReportDefinition.SliceOrBuilder getSliceOrBuilder()

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

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

Returns
Type	Description
`ReportDefinition.SliceOrBuilder`

getTimePeriodIndex()

public int getTimePeriodIndex()

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

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

Returns
Type	Description
`int`	The timePeriodIndex.

hasField()

public boolean hasField()

Required. A field (dimension or metric) to sort by.

.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 sort on. Defaults to PRIMARY.

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

Returns
Type	Description
`boolean`	Whether the metricValueType field is set.

hasSlice()

public boolean hasSlice()

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

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 3 [(.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 sort on a specific column.

optional int32 time_period_index = 4 [(.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.Sort.Builder newBuilderForType()

Returns
Type	Description
`ReportDefinition.Sort.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ReportDefinition.Sort.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`ReportDefinition.Sort.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ReportDefinition.Sort.Builder toBuilder()

Returns
Type	Description
`ReportDefinition.Sort.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`

Class ReportDefinition.Sort (0.46.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Fields

DESCENDING_FIELD_NUMBER

FIELD_FIELD_NUMBER

METRIC_VALUE_TYPE_FIELD_NUMBER

SLICE_FIELD_NUMBER

TIME_PERIOD_INDEX_FIELD_NUMBER

Static Methods

getDefaultInstance()

getDescriptor()

newBuilder()

newBuilder(ReportDefinition.Sort prototype)

parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

Methods

equals(Object obj)

getDefaultInstanceForType()

getDescending()

getField()

getFieldOrBuilder()

getMetricValueType()

getMetricValueTypeValue()

getParserForType()

getSerializedSize()

getSlice()

getSliceOrBuilder()

getTimePeriodIndex()

hasField()

hasMetricValueType()

hasSlice()

hasTimePeriodIndex()

hashCode()

internalGetFieldAccessorTable()

isInitialized()

newBuilderForType()

newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

writeTo(CodedOutputStream output)

Class ReportDefinition.Sort (0.46.0)