Class OrderBy.PivotOrderBy.PivotSelection.Builder (0.39.0)

public static final class OrderBy.PivotOrderBy.PivotSelection.Builder extends GeneratedMessageV3.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 | Pages/Sessions
 ---------|----------|----------------|----------|----------------
     US   |    2     |       2        |     3    |        1
 ---------|----------|----------------|----------|----------------
   Canada |    3     |       1        |     4    |        1
 ---------|----------|----------------|----------|----------------

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OrderBy.PivotOrderBy.PivotSelection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides

build()

public OrderBy.PivotOrderBy.PivotSelection build()
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection

buildPartial()

public OrderBy.PivotOrderBy.PivotSelection buildPartial()
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection

clear()

public OrderBy.PivotOrderBy.PivotSelection.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public OrderBy.PivotOrderBy.PivotSelection.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public OrderBy.PivotOrderBy.PivotSelection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides

clone()

public OrderBy.PivotOrderBy.PivotSelection.Builder clone()
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides

getDefaultInstanceForType()

public OrderBy.PivotOrderBy.PivotSelection getDefaultInstanceForType()
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDimensionName()

public String getDimensionName()

Must be a dimension name from the request.

string dimension_name = 1;

Returns
TypeDescription
String

The dimensionName.

getDimensionNameBytes()

public ByteString getDimensionNameBytes()

Must be a dimension name from the request.

string dimension_name = 1;

Returns
TypeDescription
ByteString

The bytes for dimensionName.

getDimensionValue()

public String getDimensionValue()

Order by only when the named dimension is this value.

string dimension_value = 2;

Returns
TypeDescription
String

The dimensionValue.

getDimensionValueBytes()

public ByteString getDimensionValueBytes()

Order by only when the named dimension is this value.

string dimension_value = 2;

Returns
TypeDescription
ByteString

The bytes for dimensionValue.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(OrderBy.PivotOrderBy.PivotSelection other)

public OrderBy.PivotOrderBy.PivotSelection.Builder mergeFrom(OrderBy.PivotOrderBy.PivotSelection other)
Parameter
NameDescription
otherOrderBy.PivotOrderBy.PivotSelection
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OrderBy.PivotOrderBy.PivotSelection.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public OrderBy.PivotOrderBy.PivotSelection.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OrderBy.PivotOrderBy.PivotSelection.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The dimensionName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for dimensionName to set.

Returns
TypeDescription
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
NameDescription
valueString

The dimensionValue to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for dimensionValue to set.

Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public OrderBy.PivotOrderBy.PivotSelection.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides

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

public OrderBy.PivotOrderBy.PivotSelection.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final OrderBy.PivotOrderBy.PivotSelection.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OrderBy.PivotOrderBy.PivotSelection.Builder
Overrides