Sheet (Google Sheets API v4 (Rev. 20) 1.21.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sheets.v4.model.Sheet

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Sheet
extends com.google.api.client.json.GenericJson
```
A sheet in 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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Sheet()

Constructors
Constructor and Description
`Sheet()`

Method Summary

Methods
Modifier and Type	Method and Description
`Sheet`	`clone()`
`BasicFilter`	`getBasicFilter()` The filter on this sheet, if any.
`java.util.List<EmbeddedChart>`	`getCharts()` The specifications of every chart on this sheet.
`java.util.List<ConditionalFormatRule>`	`getConditionalFormats()` The conditional format rules in this sheet.
`java.util.List<GridData>`	`getData()` Data in the grid, if this is a grid sheet.
`java.util.List<FilterView>`	`getFilterViews()` The filter views in this sheet.
`java.util.List<GridRange>`	`getMerges()` The ranges that are merged together.
`SheetProperties`	`getProperties()` The properties of the sheet.
`java.util.List<ProtectedRange>`	`getProtectedRanges()` The protected ranges in this sheet.
`Sheet`	`set(java.lang.String fieldName, java.lang.Object value)`
`Sheet`	`setBasicFilter(BasicFilter basicFilter)` The filter on this sheet, if any.
`Sheet`	`setCharts(java.util.List<EmbeddedChart> charts)` The specifications of every chart on this sheet.
`Sheet`	`setConditionalFormats(java.util.List<ConditionalFormatRule> conditionalFormats)` The conditional format rules in this sheet.
`Sheet`	`setData(java.util.List<GridData> data)` Data in the grid, if this is a grid sheet.
`Sheet`	`setFilterViews(java.util.List<FilterView> filterViews)` The filter views in this sheet.
`Sheet`	`setMerges(java.util.List<GridRange> merges)` The ranges that are merged together.
`Sheet`	`setProperties(SheetProperties properties)` The properties of the sheet.
`Sheet`	`setProtectedRanges(java.util.List<ProtectedRange> protectedRanges)` The protected ranges in this sheet.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Sheet
```
public Sheet()
```
- Method Detail
  - getBasicFilter
```
public BasicFilter getBasicFilter()
```
    The filter on this sheet, if any.
    
    Returns:
    value or null for none
  - setBasicFilter
```
public Sheet setBasicFilter(BasicFilter basicFilter)
```
    The filter on this sheet, if any.
    
    Parameters:
    basicFilter - basicFilter or null for none
  - getCharts
```
public java.util.List<EmbeddedChart> getCharts()
```
    The specifications of every chart on this sheet.
    
    Returns:
    value or null for none
  - setCharts
```
public Sheet setCharts(java.util.List<EmbeddedChart> charts)
```
    The specifications of every chart on this sheet.
    
    Parameters:
    charts - charts or null for none
  - getConditionalFormats
```
public java.util.List<ConditionalFormatRule> getConditionalFormats()
```
    The conditional format rules in this sheet.
    
    Returns:
    value or null for none
  - setConditionalFormats
```
public Sheet setConditionalFormats(java.util.List<ConditionalFormatRule> conditionalFormats)
```
    The conditional format rules in this sheet.
    
    Parameters:
    conditionalFormats - conditionalFormats or null for none
  - getData
```
public java.util.List<GridData> getData()
```
    Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D).
    
    Returns:
    value or null for none
  - setData
```
public Sheet setData(java.util.List<GridData> data)
```
    Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D).
    
    Parameters:
    data - data or null for none
  - getFilterViews
```
public java.util.List<FilterView> getFilterViews()
```
    The filter views in this sheet.
    
    Returns:
    value or null for none
  - setFilterViews
```
public Sheet setFilterViews(java.util.List<FilterView> filterViews)
```
    The filter views in this sheet.
    
    Parameters:
    filterViews - filterViews or null for none
  - getMerges
```
public java.util.List<GridRange> getMerges()
```
    The ranges that are merged together.
    
    Returns:
    value or null for none
  - setMerges
```
public Sheet setMerges(java.util.List<GridRange> merges)
```
    The ranges that are merged together.
    
    Parameters:
    merges - merges or null for none
  - getProperties
```
public SheetProperties getProperties()
```
    The properties of the sheet.
    
    Returns:
    value or null for none
  - setProperties
```
public Sheet setProperties(SheetProperties properties)
```
    The properties of the sheet.
    
    Parameters:
    properties - properties or null for none
  - getProtectedRanges
```
public java.util.List<ProtectedRange> getProtectedRanges()
```
    The protected ranges in this sheet.
    
    Returns:
    value or null for none
  - setProtectedRanges
```
public Sheet setProtectedRanges(java.util.List<ProtectedRange> protectedRanges)
```
    The protected ranges in this sheet.
    
    Parameters:
    protectedRanges - protectedRanges or null for none
  - set
```
public Sheet set(java.lang.String fieldName,
        java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Sheet clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Sheets API v4 (revision 20)

Class Sheet

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Sheet

Method Detail

getBasicFilter

setBasicFilter

getCharts

setCharts

getConditionalFormats

setConditionalFormats

getData

setData

getFilterViews

setFilterViews

getMerges

setMerges

getProperties

setProperties

getProtectedRanges

setProtectedRanges

set

clone