Class OrderBy (0.21.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

Implements

OrderByOrBuilder

Static Fields

DESC_FIELD_NUMBER

public static final int DESC_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSION_FIELD_NUMBER

public static final int DIMENSION_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_FIELD_NUMBER

public static final int METRIC_FIELD_NUMBER
Field Value
TypeDescription
int

PIVOT_FIELD_NUMBER

public static final int PIVOT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OrderBy getDefaultInstance()
Returns
TypeDescription
OrderBy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static OrderBy.Builder newBuilder()
Returns
TypeDescription
OrderBy.Builder

newBuilder(OrderBy prototype)

public static OrderBy.Builder newBuilder(OrderBy prototype)
Parameter
NameDescription
prototypeOrderBy
Returns
TypeDescription
OrderBy.Builder

parseDelimitedFrom(InputStream input)

public static OrderBy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static OrderBy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OrderBy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OrderBy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static OrderBy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static OrderBy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrderBy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderBy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<OrderBy> parser()
Returns
TypeDescription
Parser<OrderBy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public OrderBy getDefaultInstanceForType()
Returns
TypeDescription
OrderBy

getDesc()

public boolean getDesc()

If true, sorts by descending order.

bool desc = 4;

Returns
TypeDescription
boolean

The desc.

getDimension()

public OrderBy.DimensionOrderBy getDimension()

Sorts results by a dimension's values.

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

Returns
TypeDescription
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
TypeDescription
OrderBy.DimensionOrderByOrBuilder

getMetric()

public OrderBy.MetricOrderBy getMetric()

Sorts results by a metric's values.

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

Returns
TypeDescription
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
TypeDescription
OrderBy.MetricOrderByOrBuilder

getOneOrderByCase()

public OrderBy.OneOrderByCase getOneOrderByCase()
Returns
TypeDescription
OrderBy.OneOrderByCase

getParserForType()

public Parser<OrderBy> getParserForType()
Returns
TypeDescription
Parser<OrderBy>
Overrides

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
TypeDescription
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
TypeDescription
OrderBy.PivotOrderByOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasDimension()

public boolean hasDimension()

Sorts results by a dimension's values.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the pivot field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public OrderBy.Builder newBuilderForType()
Returns
TypeDescription
OrderBy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OrderBy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
OrderBy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public OrderBy.Builder toBuilder()
Returns
TypeDescription
OrderBy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException