Class OrderBy.PivotOrderBy (0.56.0)

public static final class OrderBy.PivotOrderBy extends GeneratedMessageV3 implements OrderBy.PivotOrderByOrBuilder

Sorts by a pivot column group.

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

Static Fields

METRIC_NAME_FIELD_NUMBER

public static final int METRIC_NAME_FIELD_NUMBER
Field Value
Type Description
int

PIVOT_SELECTIONS_FIELD_NUMBER

public static final int PIVOT_SELECTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OrderBy.PivotOrderBy getDefaultInstance()
Returns
Type Description
OrderBy.PivotOrderBy

getDescriptor()

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

newBuilder()

public static OrderBy.PivotOrderBy.Builder newBuilder()
Returns
Type Description
OrderBy.PivotOrderBy.Builder

newBuilder(OrderBy.PivotOrderBy prototype)

public static OrderBy.PivotOrderBy.Builder newBuilder(OrderBy.PivotOrderBy prototype)
Parameter
Name Description
prototype OrderBy.PivotOrderBy
Returns
Type Description
OrderBy.PivotOrderBy.Builder

parseDelimitedFrom(InputStream input)

public static OrderBy.PivotOrderBy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy.PivotOrderBy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OrderBy.PivotOrderBy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OrderBy.PivotOrderBy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OrderBy.PivotOrderBy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrderBy.PivotOrderBy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OrderBy.PivotOrderBy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy.PivotOrderBy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OrderBy.PivotOrderBy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderBy.PivotOrderBy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OrderBy.PivotOrderBy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrderBy.PivotOrderBy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderBy.PivotOrderBy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OrderBy.PivotOrderBy> parser()
Returns
Type Description
Parser<PivotOrderBy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<OrderBy.PivotOrderBy> getParserForType()
Returns
Type Description
Parser<PivotOrderBy>
Overrides

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

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OrderBy.PivotOrderBy.Builder newBuilderForType()
Returns
Type Description
OrderBy.PivotOrderBy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OrderBy.PivotOrderBy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OrderBy.PivotOrderBy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OrderBy.PivotOrderBy.Builder toBuilder()
Returns
Type Description
OrderBy.PivotOrderBy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException