com.google.api.services.sheets.v4.model

Class SortSpec

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.sheets.v4.model.SortSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SortSpec
extends com.google.api.client.json.GenericJson

A sort order associated with a specific column or row.

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 Google Sheets 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

com.google.api.client.util.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
SortSpec()

Method Summary

Modifier and Type	Method and Description
SortSpec	clone()
Color	getBackgroundColor() The background fill color to sort by; cells with this fill color are sorted to the top.
ColorStyle	getBackgroundColorStyle() The background fill color to sort by; cells with this fill color are sorted to the top.
DataSourceColumnReference	getDataSourceColumnReference() Reference to a data source column.
Integer	getDimensionIndex() The dimension the sort should be applied to.
Color	getForegroundColor() The foreground color to sort by; cells with this foreground color are sorted to the top.
ColorStyle	getForegroundColorStyle() The foreground color to sort by; cells with this foreground color are sorted to the top.
String	getSortOrder() The order data should be sorted.
SortSpec	set(String fieldName, Object value)
SortSpec	setBackgroundColor(Color backgroundColor) The background fill color to sort by; cells with this fill color are sorted to the top.
SortSpec	setBackgroundColorStyle(ColorStyle backgroundColorStyle) The background fill color to sort by; cells with this fill color are sorted to the top.
SortSpec	setDataSourceColumnReference(DataSourceColumnReference dataSourceColumnReference) Reference to a data source column.
SortSpec	setDimensionIndex(Integer dimensionIndex) The dimension the sort should be applied to.
SortSpec	setForegroundColor(Color foregroundColor) The foreground color to sort by; cells with this foreground color are sorted to the top.
SortSpec	setForegroundColorStyle(ColorStyle foregroundColorStyle) The foreground color to sort by; cells with this foreground color are sorted to the top.
SortSpec	setSortOrder(String sortOrder) The order data should be sorted.

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

SortSpec

public SortSpec()

Method Detail

getBackgroundColor

public Color getBackgroundColor()

The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.

Returns:

value or null for none

setBackgroundColor

public SortSpec setBackgroundColor(Color backgroundColor)

The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color. Deprecated: Use background_color_style.

Parameters:

backgroundColor - backgroundColor or null for none

getBackgroundColorStyle

public ColorStyle getBackgroundColorStyle()

The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.

Returns:

value or null for none

setBackgroundColorStyle

public SortSpec setBackgroundColorStyle(ColorStyle backgroundColorStyle)

The background fill color to sort by; cells with this fill color are sorted to the top. Mutually exclusive with foreground_color, and must be an RGB-type color. If background_color is also set, this field takes precedence.

Parameters:

backgroundColorStyle - backgroundColorStyle or null for none

getDataSourceColumnReference

public DataSourceColumnReference getDataSourceColumnReference()

Reference to a data source column.

Returns:

value or null for none

setDataSourceColumnReference

public SortSpec setDataSourceColumnReference(DataSourceColumnReference dataSourceColumnReference)

Reference to a data source column.

Parameters:

dataSourceColumnReference - dataSourceColumnReference or null for none

getDimensionIndex

public Integer getDimensionIndex()

The dimension the sort should be applied to.

Returns:

value or null for none

setDimensionIndex

public SortSpec setDimensionIndex(Integer dimensionIndex)

The dimension the sort should be applied to.

Parameters:

dimensionIndex - dimensionIndex or null for none

getForegroundColor

public Color getForegroundColor()

The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.

Returns:

value or null for none

setForegroundColor

public SortSpec setForegroundColor(Color foregroundColor)

The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color. Deprecated: Use foreground_color_style.

Parameters:

foregroundColor - foregroundColor or null for none

getForegroundColorStyle

public ColorStyle getForegroundColorStyle()

The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.

Returns:

value or null for none

setForegroundColorStyle

public SortSpec setForegroundColorStyle(ColorStyle foregroundColorStyle)

The foreground color to sort by; cells with this foreground color are sorted to the top. Mutually exclusive with background_color, and must be an RGB-type color. If foreground_color is also set, this field takes precedence.

Parameters:

foregroundColorStyle - foregroundColorStyle or null for none

getSortOrder

public String getSortOrder()

The order data should be sorted.

Returns:

value or null for none

setSortOrder

public SortSpec setSortOrder(String sortOrder)

The order data should be sorted.

Parameters:

sortOrder - sortOrder or null for none

set

public SortSpec set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SortSpec clone()

Overrides:

clone in class com.google.api.client.json.GenericJson