Class OrderBy.PivotOrderBy.Builder (0.63.0) 

public static final class OrderBy.PivotOrderBy.Builder extends GeneratedMessageV3.Builder<OrderBy.PivotOrderBy.Builder> implements OrderBy.PivotOrderByOrBuilder

Sorts by a pivot column group.

Protobuf type google.analytics.data.v1beta.OrderBy.PivotOrderBy

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OrderBy.PivotOrderBy.Builder

Static Methods

getDescriptor()

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

Methods

addAllPivotSelections(Iterable<? extends OrderBy.PivotOrderBy.PivotSelection> values)

public OrderBy.PivotOrderBy.Builder addAllPivotSelections(Iterable<? extends OrderBy.PivotOrderBy.PivotSelection> values)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection>
Returns
Type Description
OrderBy.PivotOrderBy.Builder

addPivotSelections(OrderBy.PivotOrderBy.PivotSelection value)

public OrderBy.PivotOrderBy.Builder addPivotSelections(OrderBy.PivotOrderBy.PivotSelection value)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

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

addPivotSelections(OrderBy.PivotOrderBy.PivotSelection.Builder builderForValue)

public OrderBy.PivotOrderBy.Builder addPivotSelections(OrderBy.PivotOrderBy.PivotSelection.Builder builderForValue)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

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

addPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection value)

public OrderBy.PivotOrderBy.Builder addPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection value)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameters
Name Description
index int
value OrderBy.PivotOrderBy.PivotSelection
Returns
Type Description
OrderBy.PivotOrderBy.Builder

addPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection.Builder builderForValue)

public OrderBy.PivotOrderBy.Builder addPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection.Builder builderForValue)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameters
Name Description
index int
builderForValue OrderBy.PivotOrderBy.PivotSelection.Builder
Returns
Type Description
OrderBy.PivotOrderBy.Builder

addPivotSelectionsBuilder()

public OrderBy.PivotOrderBy.PivotSelection.Builder addPivotSelectionsBuilder()

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

addPivotSelectionsBuilder(int index)

public OrderBy.PivotOrderBy.PivotSelection.Builder addPivotSelectionsBuilder(int index)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public OrderBy.PivotOrderBy build()
Returns
Type Description
OrderBy.PivotOrderBy

buildPartial()

public OrderBy.PivotOrderBy buildPartial()
Returns
Type Description
OrderBy.PivotOrderBy

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearMetricName()

public OrderBy.PivotOrderBy.Builder clearMetricName()

In the response to order by, order rows by this column. Must be a metric name from the request.

string metric_name = 1;

Returns
Type Description
OrderBy.PivotOrderBy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPivotSelections()

public OrderBy.PivotOrderBy.Builder clearPivotSelections()

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Returns
Type Description
OrderBy.PivotOrderBy.Builder

clone()

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

getDefaultInstanceForType()

public OrderBy.PivotOrderBy getDefaultInstanceForType()
Returns
Type Description
OrderBy.PivotOrderBy

getDescriptorForType()

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

getMetricName()

public String getMetricName()

In the response to order by, order rows by this column. Must be a metric name from the request.

string metric_name = 1;

Returns
Type Description
String

The metricName.

getMetricNameBytes()

public ByteString getMetricNameBytes()

In the response to order by, order rows by this column. Must be a metric name from the request.

string metric_name = 1;

Returns
Type Description
ByteString

The bytes for metricName.

getPivotSelections(int index)

public OrderBy.PivotOrderBy.PivotSelection getPivotSelections(int index)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection

getPivotSelectionsBuilder(int index)

public OrderBy.PivotOrderBy.PivotSelection.Builder getPivotSelectionsBuilder(int index)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

getPivotSelectionsBuilderList()

public List<OrderBy.PivotOrderBy.PivotSelection.Builder> getPivotSelectionsBuilderList()

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Returns
Type Description
List<Builder>

getPivotSelectionsCount()

public int getPivotSelectionsCount()

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Returns
Type Description
int

getPivotSelectionsList()

public List<OrderBy.PivotOrderBy.PivotSelection> getPivotSelectionsList()

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Returns
Type Description
List<PivotSelection>

getPivotSelectionsOrBuilder(int index)

public OrderBy.PivotOrderBy.PivotSelectionOrBuilder getPivotSelectionsOrBuilder(int index)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy.PivotOrderBy.PivotSelectionOrBuilder

getPivotSelectionsOrBuilderList()

public List<? extends OrderBy.PivotOrderBy.PivotSelectionOrBuilder> getPivotSelectionsOrBuilderList()

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Returns
Type Description
List<? extends com.google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelectionOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OrderBy.PivotOrderBy other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removePivotSelections(int index)

public OrderBy.PivotOrderBy.Builder removePivotSelections(int index)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameter
Name Description
index int
Returns
Type Description
OrderBy.PivotOrderBy.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setMetricName(String value)

public OrderBy.PivotOrderBy.Builder setMetricName(String value)

In the response to order by, order rows by this column. Must be a metric name from the request.

string metric_name = 1;

Parameter
Name Description
value String

The metricName to set.
Returns
Type Description
OrderBy.PivotOrderBy.Builder

This builder for chaining.

setMetricNameBytes(ByteString value)

public OrderBy.PivotOrderBy.Builder setMetricNameBytes(ByteString value)

In the response to order by, order rows by this column. Must be a metric name from the request.

string metric_name = 1;

Parameter
Name Description
value ByteString

The bytes for metricName to set.
Returns
Type Description
OrderBy.PivotOrderBy.Builder

This builder for chaining.

setPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection value)

public OrderBy.PivotOrderBy.Builder setPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection value)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameters
Name Description
index int
value OrderBy.PivotOrderBy.PivotSelection
Returns
Type Description
OrderBy.PivotOrderBy.Builder

setPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection.Builder builderForValue)

public OrderBy.PivotOrderBy.Builder setPivotSelections(int index, OrderBy.PivotOrderBy.PivotSelection.Builder builderForValue)

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.

repeated .google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection pivot_selections = 2;

Parameters
Name Description
index int
builderForValue OrderBy.PivotOrderBy.PivotSelection.Builder
Returns
Type Description
OrderBy.PivotOrderBy.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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