Class OrderBy.PivotOrderBy.PivotSelection.Builder (0.94.0)

public static final class OrderBy.PivotOrderBy.PivotSelection.Builder extends GeneratedMessage.Builder<OrderBy.PivotOrderBy.PivotSelection.Builder> implements OrderBy.PivotOrderBy.PivotSelectionOrBuilder

A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value.

For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome.

---------|----------|----------------|----------|----------------

Chrome Chrome Safari Safari
Country Sessions Pages/Sessions Sessions
--------- ---------- ---------------- ----------
US 2 2 3
--------- ---------- ---------------- ----------
Canada 3 1 4
--------- ---------- ---------------- ----------

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

Static Methods

getDescriptor()

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

Methods

build()

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

buildPartial()

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

clear()

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

clearDimensionName()

public OrderBy.PivotOrderBy.PivotSelection.Builder clearDimensionName()

Must be a dimension name from the request.

string dimension_name = 1;

Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.

clearDimensionValue()

public OrderBy.PivotOrderBy.PivotSelection.Builder clearDimensionValue()

Order by only when the named dimension is this value.

string dimension_value = 2;

Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.

getDefaultInstanceForType()

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

getDescriptorForType()

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

getDimensionName()

public String getDimensionName()

Must be a dimension name from the request.

string dimension_name = 1;

Returns
Type Description
String

The dimensionName.

getDimensionNameBytes()

public ByteString getDimensionNameBytes()

Must be a dimension name from the request.

string dimension_name = 1;

Returns
Type Description
ByteString

The bytes for dimensionName.

getDimensionValue()

public String getDimensionValue()

Order by only when the named dimension is this value.

string dimension_value = 2;

Returns
Type Description
String

The dimensionValue.

getDimensionValueBytes()

public ByteString getDimensionValueBytes()

Order by only when the named dimension is this value.

string dimension_value = 2;

Returns
Type Description
ByteString

The bytes for dimensionValue.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OrderBy.PivotOrderBy.PivotSelection other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDimensionName(String value)

public OrderBy.PivotOrderBy.PivotSelection.Builder setDimensionName(String value)

Must be a dimension name from the request.

string dimension_name = 1;

Parameter
Name Description
value String

The dimensionName to set.

Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.

setDimensionNameBytes(ByteString value)

public OrderBy.PivotOrderBy.PivotSelection.Builder setDimensionNameBytes(ByteString value)

Must be a dimension name from the request.

string dimension_name = 1;

Parameter
Name Description
value ByteString

The bytes for dimensionName to set.

Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.

setDimensionValue(String value)

public OrderBy.PivotOrderBy.PivotSelection.Builder setDimensionValue(String value)

Order by only when the named dimension is this value.

string dimension_value = 2;

Parameter
Name Description
value String

The dimensionValue to set.

Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.

setDimensionValueBytes(ByteString value)

public OrderBy.PivotOrderBy.PivotSelection.Builder setDimensionValueBytes(ByteString value)

Order by only when the named dimension is this value.

string dimension_value = 2;

Parameter
Name Description
value ByteString

The bytes for dimensionValue to set.

Returns
Type Description
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.