com.google.api.services.analyticsreporting.v4.model

Class OrderBy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsreporting.v4.model.OrderBy

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class OrderBy
extends GenericJson

Specifies the sorting options.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Analytics Reporting API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
OrderBy()

Method Summary

Modifier and Type	Method and Description
OrderBy	clone()
String	getFieldName() The field which to sort by.
String	getOrderType() The order type.
String	getSortOrder() The sorting order for the field.
OrderBy	set(String fieldName, Object value)
OrderBy	setFieldName(String fieldName) The field which to sort by.
OrderBy	setOrderType(String orderType) The order type.
OrderBy	setSortOrder(String sortOrder) The sorting order for the field.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

OrderBy

public OrderBy()

Method Detail

getFieldName

public String getFieldName()

The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` is not valid.

Returns:

value or null for none

setFieldName

public OrderBy setFieldName(String fieldName)

The field which to sort by. The default sort order is ascending. Example: `ga:browser`. Note, that you can only specify one field for sort here. For example, `ga:browser, ga:city` is not valid.

Parameters:

fieldName - fieldName or null for none

getOrderType

public String getOrderType()

The order type. The default orderType is `VALUE`.

Returns:

value or null for none

setOrderType

public OrderBy setOrderType(String orderType)

The order type. The default orderType is `VALUE`.

Parameters:

orderType - orderType or null for none

getSortOrder

public String getSortOrder()

The sorting order for the field.

Returns:

value or null for none

setSortOrder

public OrderBy setSortOrder(String sortOrder)

The sorting order for the field.

Parameters:

sortOrder - sortOrder or null for none

set

public OrderBy set(String fieldName,
                   Object value)

Overrides:

set in class GenericJson

clone

public OrderBy clone()

Overrides:

clone in class GenericJson