Class OrderBy (0.51.0)

public final class OrderBy extends GeneratedMessageV3 implements OrderByOrBuilder

Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering.

Protobuf type google.analytics.data.v1beta.OrderBy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OrderBy

Implements

OrderByOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DESC_FIELD_NUMBER

public static final int DESC_FIELD_NUMBER

Field Value
Type	Description
`int`

DIMENSION_FIELD_NUMBER

public static final int DIMENSION_FIELD_NUMBER

Field Value
Type	Description
`int`

METRIC_FIELD_NUMBER

public static final int METRIC_FIELD_NUMBER

Field Value
Type	Description
`int`

PIVOT_FIELD_NUMBER

public static final int PIVOT_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static OrderBy getDefaultInstance()

Returns
Type	Description
`OrderBy`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static OrderBy.Builder newBuilder()

Returns
Type	Description
`OrderBy.Builder`

newBuilder(OrderBy prototype)

public static OrderBy.Builder newBuilder(OrderBy prototype)

Parameter
Name	Description
`prototype`	`OrderBy`

Returns
Type	Description
`OrderBy.Builder`

parseDelimitedFrom(InputStream input)

public static OrderBy parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static OrderBy parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static OrderBy parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static OrderBy parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static OrderBy parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static OrderBy parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`OrderBy`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<OrderBy> parser()

Returns
Type	Description
`Parser<OrderBy>`

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 OrderBy getDefaultInstanceForType()

Returns
Type	Description
`OrderBy`

getDesc()

public boolean getDesc()

If true, sorts by descending order.

bool desc = 4;

Returns
Type	Description
`boolean`	The desc.

getDimension()

public OrderBy.DimensionOrderBy getDimension()

Sorts results by a dimension's values.

.google.analytics.data.v1beta.OrderBy.DimensionOrderBy dimension = 2;

Returns
Type	Description
`OrderBy.DimensionOrderBy`	The dimension.

getDimensionOrBuilder()

public OrderBy.DimensionOrderByOrBuilder getDimensionOrBuilder()

Sorts results by a dimension's values.

.google.analytics.data.v1beta.OrderBy.DimensionOrderBy dimension = 2;

Returns
Type	Description
`OrderBy.DimensionOrderByOrBuilder`

getMetric()

public OrderBy.MetricOrderBy getMetric()

Sorts results by a metric's values.

.google.analytics.data.v1beta.OrderBy.MetricOrderBy metric = 1;

Returns
Type	Description
`OrderBy.MetricOrderBy`	The metric.

getMetricOrBuilder()

public OrderBy.MetricOrderByOrBuilder getMetricOrBuilder()

Sorts results by a metric's values.

.google.analytics.data.v1beta.OrderBy.MetricOrderBy metric = 1;

Returns
Type	Description
`OrderBy.MetricOrderByOrBuilder`

getOneOrderByCase()

public OrderBy.OneOrderByCase getOneOrderByCase()

Returns
Type	Description
`OrderBy.OneOrderByCase`

getParserForType()

public Parser<OrderBy> getParserForType()

Returns
Type	Description
`Parser<OrderBy>`

Overrides

GeneratedMessageV3.getParserForType()

getPivot()

public OrderBy.PivotOrderBy getPivot()

Sorts results by a metric's values within a pivot column group.

.google.analytics.data.v1beta.OrderBy.PivotOrderBy pivot = 3;

Returns
Type	Description
`OrderBy.PivotOrderBy`	The pivot.

getPivotOrBuilder()

public OrderBy.PivotOrderByOrBuilder getPivotOrBuilder()

Sorts results by a metric's values within a pivot column group.

.google.analytics.data.v1beta.OrderBy.PivotOrderBy pivot = 3;

Returns
Type	Description
`OrderBy.PivotOrderByOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hasDimension()

public boolean hasDimension()

Sorts results by a dimension's values.

.google.analytics.data.v1beta.OrderBy.DimensionOrderBy dimension = 2;

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

hasMetric()

public boolean hasMetric()

Sorts results by a metric's values.

.google.analytics.data.v1beta.OrderBy.MetricOrderBy metric = 1;

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

hasPivot()

public boolean hasPivot()

Sorts results by a metric's values within a pivot column group.

.google.analytics.data.v1beta.OrderBy.PivotOrderBy pivot = 3;

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

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public OrderBy.Builder newBuilderForType()

Returns
Type	Description
`OrderBy.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OrderBy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`OrderBy.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public OrderBy.Builder toBuilder()

Returns
Type	Description
`OrderBy.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`