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

Class PivotTable

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.PivotTable

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PivotTable
extends GenericJson

A pivot table.

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

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
PivotTable()

Method Summary

Modifier and Type	Method and Description
PivotTable	clone()
List<PivotGroup>	getColumns() Each column grouping in the pivot table.
Map<String,PivotFilterCriteria>	getCriteria() An optional mapping of filters per source column offset.
DataExecutionStatus	getDataExecutionStatus() Output only.
String	getDataSourceId() The ID of the data source the pivot table is reading data from.
List<PivotFilterSpec>	getFilterSpecs() The filters applied to the source columns before aggregating data for the pivot table.
List<PivotGroup>	getRows() Each row grouping in the pivot table.
GridRange	getSource() The range the pivot table is reading data from.
String	getValueLayout() Whether values should be listed horizontally (as columns) or vertically (as rows).
List<PivotValue>	getValues() A list of values to include in the pivot table.
PivotTable	set(String fieldName, Object value)
PivotTable	setColumns(List<PivotGroup> columns) Each column grouping in the pivot table.
PivotTable	setCriteria(Map<String,PivotFilterCriteria> criteria) An optional mapping of filters per source column offset.
PivotTable	setDataExecutionStatus(DataExecutionStatus dataExecutionStatus) Output only.
PivotTable	setDataSourceId(String dataSourceId) The ID of the data source the pivot table is reading data from.
PivotTable	setFilterSpecs(List<PivotFilterSpec> filterSpecs) The filters applied to the source columns before aggregating data for the pivot table.
PivotTable	setRows(List<PivotGroup> rows) Each row grouping in the pivot table.
PivotTable	setSource(GridRange source) The range the pivot table is reading data from.
PivotTable	setValueLayout(String valueLayout) Whether values should be listed horizontally (as columns) or vertically (as rows).
PivotTable	setValues(List<PivotValue> values) A list of values to include in the pivot table.

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

PivotTable

public PivotTable()

Method Detail

getColumns

public List<PivotGroup> getColumns()

Each column grouping in the pivot table.

Returns:

value or null for none

setColumns

public PivotTable setColumns(List<PivotGroup> columns)

Each column grouping in the pivot table.

Parameters:

columns - columns or null for none

getCriteria

public Map<String,PivotFilterCriteria> getCriteria()

An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. This field is deprecated in favor of filter_specs.

Returns:

value or null for none

setCriteria

public PivotTable setCriteria(Map<String,PivotFilterCriteria> criteria)

An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. This field is deprecated in favor of filter_specs.

Parameters:

criteria - criteria or null for none

getDataExecutionStatus

public DataExecutionStatus getDataExecutionStatus()

Output only. The data execution status for data source pivot tables.

Returns:

value or null for none

setDataExecutionStatus

public PivotTable setDataExecutionStatus(DataExecutionStatus dataExecutionStatus)

Output only. The data execution status for data source pivot tables.

Parameters:

dataExecutionStatus - dataExecutionStatus or null for none

getDataSourceId

public String getDataSourceId()

The ID of the data source the pivot table is reading data from.

Returns:

value or null for none

setDataSourceId

public PivotTable setDataSourceId(String dataSourceId)

The ID of the data source the pivot table is reading data from.

Parameters:

dataSourceId - dataSourceId or null for none

getFilterSpecs

public List<PivotFilterSpec> getFilterSpecs()

The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.

Returns:

value or null for none

setFilterSpecs

public PivotTable setFilterSpecs(List<PivotFilterSpec> filterSpecs)

The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.

Parameters:

filterSpecs - filterSpecs or null for none

getRows

public List<PivotGroup> getRows()

Each row grouping in the pivot table.

Returns:

value or null for none

setRows

public PivotTable setRows(List<PivotGroup> rows)

Each row grouping in the pivot table.

Parameters:

rows - rows or null for none

getSource

public GridRange getSource()

The range the pivot table is reading data from.

Returns:

value or null for none

setSource

public PivotTable setSource(GridRange source)

The range the pivot table is reading data from.

Parameters:

source - source or null for none

getValueLayout

public String getValueLayout()

Whether values should be listed horizontally (as columns) or vertically (as rows).

Returns:

value or null for none

setValueLayout

public PivotTable setValueLayout(String valueLayout)

Whether values should be listed horizontally (as columns) or vertically (as rows).

Parameters:

valueLayout - valueLayout or null for none

getValues

public List<PivotValue> getValues()

A list of values to include in the pivot table.

Returns:

value or null for none

setValues

public PivotTable setValues(List<PivotValue> values)

A list of values to include in the pivot table.

Parameters:

values - values or null for none

set

public PivotTable set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public PivotTable clone()

Overrides:

clone in class GenericJson