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

Class Spreadsheet

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Spreadsheet
extends GenericJson

Resource that represents a spreadsheet.

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

Method Summary

Modifier and Type	Method and Description
Spreadsheet	clone()
List<DataSource>	getDataSources() A list of external data sources connected with the spreadsheet.
List<DataSourceRefreshSchedule>	getDataSourceSchedules() Output only.
List<DeveloperMetadata>	getDeveloperMetadata() The developer metadata associated with a spreadsheet.
List<NamedRange>	getNamedRanges() The named ranges defined in a spreadsheet.
SpreadsheetProperties	getProperties() Overall properties of a spreadsheet.
List<Sheet>	getSheets() The sheets that are part of a spreadsheet.
String	getSpreadsheetId() The ID of the spreadsheet.
String	getSpreadsheetUrl() The url of the spreadsheet.
Spreadsheet	set(String fieldName, Object value)
Spreadsheet	setDataSources(List<DataSource> dataSources) A list of external data sources connected with the spreadsheet.
Spreadsheet	setDataSourceSchedules(List<DataSourceRefreshSchedule> dataSourceSchedules) Output only.
Spreadsheet	setDeveloperMetadata(List<DeveloperMetadata> developerMetadata) The developer metadata associated with a spreadsheet.
Spreadsheet	setNamedRanges(List<NamedRange> namedRanges) The named ranges defined in a spreadsheet.
Spreadsheet	setProperties(SpreadsheetProperties properties) Overall properties of a spreadsheet.
Spreadsheet	setSheets(List<Sheet> sheets) The sheets that are part of a spreadsheet.
Spreadsheet	setSpreadsheetId(String spreadsheetId) The ID of the spreadsheet.
Spreadsheet	setSpreadsheetUrl(String spreadsheetUrl) The url of the spreadsheet.

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

Spreadsheet

public Spreadsheet()

Method Detail

getDataSourceSchedules

public List<DataSourceRefreshSchedule> getDataSourceSchedules()

Output only. A list of data source refresh schedules.

Returns:

value or null for none

setDataSourceSchedules

public Spreadsheet setDataSourceSchedules(List<DataSourceRefreshSchedule> dataSourceSchedules)

Output only. A list of data source refresh schedules.

Parameters:

dataSourceSchedules - dataSourceSchedules or null for none

getDataSources

public List<DataSource> getDataSources()

A list of external data sources connected with the spreadsheet.

Returns:

value or null for none

setDataSources

public Spreadsheet setDataSources(List<DataSource> dataSources)

A list of external data sources connected with the spreadsheet.

Parameters:

dataSources - dataSources or null for none

getDeveloperMetadata

public List<DeveloperMetadata> getDeveloperMetadata()

The developer metadata associated with a spreadsheet.

Returns:

value or null for none

setDeveloperMetadata

public Spreadsheet setDeveloperMetadata(List<DeveloperMetadata> developerMetadata)

The developer metadata associated with a spreadsheet.

Parameters:

developerMetadata - developerMetadata or null for none

getNamedRanges

public List<NamedRange> getNamedRanges()

The named ranges defined in a spreadsheet.

Returns:

value or null for none

setNamedRanges

public Spreadsheet setNamedRanges(List<NamedRange> namedRanges)

The named ranges defined in a spreadsheet.

Parameters:

namedRanges - namedRanges or null for none

getProperties

public SpreadsheetProperties getProperties()

Overall properties of a spreadsheet.

Returns:

value or null for none

setProperties

public Spreadsheet setProperties(SpreadsheetProperties properties)

Overall properties of a spreadsheet.

Parameters:

properties - properties or null for none

getSheets

public List<Sheet> getSheets()

The sheets that are part of a spreadsheet.

Returns:

value or null for none

setSheets

public Spreadsheet setSheets(List<Sheet> sheets)

The sheets that are part of a spreadsheet.

Parameters:

sheets - sheets or null for none

getSpreadsheetId

public String getSpreadsheetId()

The ID of the spreadsheet. This field is read-only.

Returns:

value or null for none

setSpreadsheetId

public Spreadsheet setSpreadsheetId(String spreadsheetId)

The ID of the spreadsheet. This field is read-only.

Parameters:

spreadsheetId - spreadsheetId or null for none

getSpreadsheetUrl

public String getSpreadsheetUrl()

The url of the spreadsheet. This field is read-only.

Returns:

value or null for none

setSpreadsheetUrl

public Spreadsheet setSpreadsheetUrl(String spreadsheetUrl)

The url of the spreadsheet. This field is read-only.

Parameters:

spreadsheetUrl - spreadsheetUrl or null for none

set

public Spreadsheet set(String fieldName,
                       Object value)

Overrides:

set in class GenericJson

clone

public Spreadsheet clone()

Overrides:

clone in class GenericJson