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

Class DataSourceTable

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as "Extract" in the Sheets editor.

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

Method Summary

Modifier and Type	Method and Description
DataSourceTable	clone()
List<DataSourceColumnReference>	getColumns() Columns selected for the data source table.
String	getColumnSelectionType() The type to select columns for the data source table.
DataExecutionStatus	getDataExecutionStatus() Output only.
String	getDataSourceId() The ID of the data source the data source table is associated with.
List<FilterSpec>	getFilterSpecs() Filter specifications in the data source table.
Integer	getRowLimit() The limit of rows to return.
List<SortSpec>	getSortSpecs() Sort specifications in the data source table.
DataSourceTable	set(String fieldName, Object value)
DataSourceTable	setColumns(List<DataSourceColumnReference> columns) Columns selected for the data source table.
DataSourceTable	setColumnSelectionType(String columnSelectionType) The type to select columns for the data source table.
DataSourceTable	setDataExecutionStatus(DataExecutionStatus dataExecutionStatus) Output only.
DataSourceTable	setDataSourceId(String dataSourceId) The ID of the data source the data source table is associated with.
DataSourceTable	setFilterSpecs(List<FilterSpec> filterSpecs) Filter specifications in the data source table.
DataSourceTable	setRowLimit(Integer rowLimit) The limit of rows to return.
DataSourceTable	setSortSpecs(List<SortSpec> sortSpecs) Sort specifications in the data source 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

DataSourceTable

public DataSourceTable()

Method Detail

getColumnSelectionType

public String getColumnSelectionType()

The type to select columns for the data source table. Defaults to SELECTED.

Returns:

value or null for none

setColumnSelectionType

public DataSourceTable setColumnSelectionType(String columnSelectionType)

The type to select columns for the data source table. Defaults to SELECTED.

Parameters:

columnSelectionType - columnSelectionType or null for none

getColumns

public List<DataSourceColumnReference> getColumns()

Columns selected for the data source table. The column_selection_type must be SELECTED.

Returns:

value or null for none

setColumns

public DataSourceTable setColumns(List<DataSourceColumnReference> columns)

Columns selected for the data source table. The column_selection_type must be SELECTED.

Parameters:

columns - columns or null for none

getDataExecutionStatus

public DataExecutionStatus getDataExecutionStatus()

Output only. The data execution status.

Returns:

value or null for none

setDataExecutionStatus

public DataSourceTable setDataExecutionStatus(DataExecutionStatus dataExecutionStatus)

Output only. The data execution status.

Parameters:

dataExecutionStatus - dataExecutionStatus or null for none

getDataSourceId

public String getDataSourceId()

The ID of the data source the data source table is associated with.

Returns:

value or null for none

setDataSourceId

public DataSourceTable setDataSourceId(String dataSourceId)

The ID of the data source the data source table is associated with.

Parameters:

dataSourceId - dataSourceId or null for none

getFilterSpecs

public List<FilterSpec> getFilterSpecs()

Filter specifications in the data source table.

Returns:

value or null for none

setFilterSpecs

public DataSourceTable setFilterSpecs(List<FilterSpec> filterSpecs)

Filter specifications in the data source table.

Parameters:

filterSpecs - filterSpecs or null for none

getRowLimit

public Integer getRowLimit()

The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit.

Returns:

value or null for none

setRowLimit

public DataSourceTable setRowLimit(Integer rowLimit)

The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit.

Parameters:

rowLimit - rowLimit or null for none

getSortSpecs

public List<SortSpec> getSortSpecs()

Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order.

Returns:

value or null for none

setSortSpecs

public DataSourceTable setSortSpecs(List<SortSpec> sortSpecs)

Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order.

Parameters:

sortSpecs - sortSpecs or null for none

set

public DataSourceTable set(String fieldName,
                           Object value)

Overrides:

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

clone

public DataSourceTable clone()

Overrides:

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