Class OrderBy.Builder (0.57.0) 

public static final class OrderBy.Builder extends GeneratedMessageV3.Builder<OrderBy.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OrderBy.Builder

Implements

OrderByOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OrderBy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OrderBy.Builder
Overrides

build()

public OrderBy build()
Returns
Type Description
OrderBy

buildPartial()

public OrderBy buildPartial()
Returns
Type Description
OrderBy

clear()

public OrderBy.Builder clear()
Returns
Type Description
OrderBy.Builder
Overrides

clearDesc()

public OrderBy.Builder clearDesc()

If true, sorts by descending order.

bool desc = 4;

Returns
Type Description
OrderBy.Builder

This builder for chaining.

clearDimension()

public OrderBy.Builder clearDimension()

Sorts results by a dimension's values.

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

Returns
Type Description
OrderBy.Builder

clearField(Descriptors.FieldDescriptor field)

public OrderBy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
OrderBy.Builder
Overrides

clearMetric()

public OrderBy.Builder clearMetric()

Sorts results by a metric's values.

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

Returns
Type Description
OrderBy.Builder

clearOneOrderBy()

public OrderBy.Builder clearOneOrderBy()
Returns
Type Description
OrderBy.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public OrderBy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
OrderBy.Builder
Overrides

clearPivot()

public OrderBy.Builder clearPivot()

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

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

Returns
Type Description
OrderBy.Builder

clone()

public OrderBy.Builder clone()
Returns
Type Description
OrderBy.Builder
Overrides

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDimensionBuilder()

public OrderBy.DimensionOrderBy.Builder getDimensionBuilder()

Sorts results by a dimension's values.

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

Returns
Type Description
OrderBy.DimensionOrderBy.Builder

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.

getMetricBuilder()

public OrderBy.MetricOrderBy.Builder getMetricBuilder()

Sorts results by a metric's values.

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

Returns
Type Description
OrderBy.MetricOrderBy.Builder

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

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.

getPivotBuilder()

public OrderBy.PivotOrderBy.Builder getPivotBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDimension(OrderBy.DimensionOrderBy value)

public OrderBy.Builder mergeDimension(OrderBy.DimensionOrderBy value)

Sorts results by a dimension's values.

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

Parameter
Name Description
value OrderBy.DimensionOrderBy
Returns
Type Description
OrderBy.Builder

mergeFrom(OrderBy other)

public OrderBy.Builder mergeFrom(OrderBy other)
Parameter
Name Description
other OrderBy
Returns
Type Description
OrderBy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OrderBy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderBy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public OrderBy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
OrderBy.Builder
Overrides

mergeMetric(OrderBy.MetricOrderBy value)

public OrderBy.Builder mergeMetric(OrderBy.MetricOrderBy value)

Sorts results by a metric's values.

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

Parameter
Name Description
value OrderBy.MetricOrderBy
Returns
Type Description
OrderBy.Builder

mergePivot(OrderBy.PivotOrderBy value)

public OrderBy.Builder mergePivot(OrderBy.PivotOrderBy value)

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

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

Parameter
Name Description
value OrderBy.PivotOrderBy
Returns
Type Description
OrderBy.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OrderBy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OrderBy.Builder
Overrides

setDesc(boolean value)

public OrderBy.Builder setDesc(boolean value)

If true, sorts by descending order.

bool desc = 4;

Parameter
Name Description
value boolean

The desc to set.
Returns
Type Description
OrderBy.Builder

This builder for chaining.

setDimension(OrderBy.DimensionOrderBy value)

public OrderBy.Builder setDimension(OrderBy.DimensionOrderBy value)

Sorts results by a dimension's values.

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

Parameter
Name Description
value OrderBy.DimensionOrderBy
Returns
Type Description
OrderBy.Builder

setDimension(OrderBy.DimensionOrderBy.Builder builderForValue)

public OrderBy.Builder setDimension(OrderBy.DimensionOrderBy.Builder builderForValue)

Sorts results by a dimension's values.

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

Parameter
Name Description
builderForValue OrderBy.DimensionOrderBy.Builder
Returns
Type Description
OrderBy.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public OrderBy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OrderBy.Builder
Overrides

setMetric(OrderBy.MetricOrderBy value)

public OrderBy.Builder setMetric(OrderBy.MetricOrderBy value)

Sorts results by a metric's values.

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

Parameter
Name Description
value OrderBy.MetricOrderBy
Returns
Type Description
OrderBy.Builder

setMetric(OrderBy.MetricOrderBy.Builder builderForValue)

public OrderBy.Builder setMetric(OrderBy.MetricOrderBy.Builder builderForValue)

Sorts results by a metric's values.

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

Parameter
Name Description
builderForValue OrderBy.MetricOrderBy.Builder
Returns
Type Description
OrderBy.Builder

setPivot(OrderBy.PivotOrderBy value)

public OrderBy.Builder setPivot(OrderBy.PivotOrderBy value)

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

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

Parameter
Name Description
value OrderBy.PivotOrderBy
Returns
Type Description
OrderBy.Builder

setPivot(OrderBy.PivotOrderBy.Builder builderForValue)

public OrderBy.Builder setPivot(OrderBy.PivotOrderBy.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue OrderBy.PivotOrderBy.Builder
Returns
Type Description
OrderBy.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OrderBy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
OrderBy.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final OrderBy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OrderBy.Builder
Overrides