Sheet (Google Sheets API v4-rev20241008-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,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
  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

Sheet()

Constructors
Constructor and Description
`Sheet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Sheet`	`clone()`
`List<BandedRange>`	`getBandedRanges()` The banded (alternating colors) ranges on this sheet.
`BasicFilter`	`getBasicFilter()` The filter on this sheet, if any.
`List<EmbeddedChart>`	`getCharts()` The specifications of every chart on this sheet.
`List<DimensionGroup>`	`getColumnGroups()` All column groups on this sheet, ordered by increasing range start index, then by group depth.
`List<ConditionalFormatRule>`	`getConditionalFormats()` The conditional format rules in this sheet.
`List<GridData>`	`getData()` Data in the grid, if this is a grid sheet.
`List<DeveloperMetadata>`	`getDeveloperMetadata()` The developer metadata associated with a sheet.
`List<FilterView>`	`getFilterViews()` The filter views in this sheet.
`List<GridRange>`	`getMerges()` The ranges that are merged together.
`SheetProperties`	`getProperties()` The properties of the sheet.
`List<ProtectedRange>`	`getProtectedRanges()` The protected ranges in this sheet.
`List<DimensionGroup>`	`getRowGroups()` All row groups on this sheet, ordered by increasing range start index, then by group depth.
`List<Slicer>`	`getSlicers()` The slicers on this sheet.
`Sheet`	`set(String fieldName, Object value)`
`Sheet`	`setBandedRanges(List<BandedRange> bandedRanges)` The banded (alternating colors) ranges on this sheet.
`Sheet`	`setBasicFilter(BasicFilter basicFilter)` The filter on this sheet, if any.
`Sheet`	`setCharts(List<EmbeddedChart> charts)` The specifications of every chart on this sheet.
`Sheet`	`setColumnGroups(List<DimensionGroup> columnGroups)` All column groups on this sheet, ordered by increasing range start index, then by group depth.
`Sheet`	`setConditionalFormats(List<ConditionalFormatRule> conditionalFormats)` The conditional format rules in this sheet.
`Sheet`	`setData(List<GridData> data)` Data in the grid, if this is a grid sheet.
`Sheet`	`setDeveloperMetadata(List<DeveloperMetadata> developerMetadata)` The developer metadata associated with a sheet.
`Sheet`	`setFilterViews(List<FilterView> filterViews)` The filter views in this sheet.
`Sheet`	`setMerges(List<GridRange> merges)` The ranges that are merged together.
`Sheet`	`setProperties(SheetProperties properties)` The properties of the sheet.
`Sheet`	`setProtectedRanges(List<ProtectedRange> protectedRanges)` The protected ranges in this sheet.
`Sheet`	`setRowGroups(List<DimensionGroup> rowGroups)` All row groups on this sheet, ordered by increasing range start index, then by group depth.
`Sheet`	`setSlicers(List<Slicer> slicers)` The slicers on 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, 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
  - Sheet
```
public Sheet()
```
- Method Detail
  - getBandedRanges
```
public List<BandedRange> getBandedRanges()
```
    The banded (alternating colors) ranges on this sheet.
    
    Returns:
    
    value or null for none
  - setBandedRanges
```
public Sheet setBandedRanges(List<BandedRange> bandedRanges)
```
    The banded (alternating colors) ranges on this sheet.
    
    Parameters:
    
    bandedRanges - bandedRanges or null for none
  - 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 List<EmbeddedChart> getCharts()
```
    The specifications of every chart on this sheet.
    
    Returns:
    
    value or null for none
  - setCharts
```
public Sheet setCharts(List<EmbeddedChart> charts)
```
    The specifications of every chart on this sheet.
    
    Parameters:
    
    charts - charts or null for none
  - getColumnGroups
```
public List<DimensionGroup> getColumnGroups()
```
    All column groups on this sheet, ordered by increasing range start index, then by group depth.
    
    Returns:
    
    value or null for none
  - setColumnGroups
```
public Sheet setColumnGroups(List<DimensionGroup> columnGroups)
```
    All column groups on this sheet, ordered by increasing range start index, then by group depth.
    
    Parameters:
    
    columnGroups - columnGroups or null for none
  - getConditionalFormats
```
public List<ConditionalFormatRule> getConditionalFormats()
```
    The conditional format rules in this sheet.
    
    Returns:
    
    value or null for none
  - setConditionalFormats
```
public Sheet setConditionalFormats(List<ConditionalFormatRule> conditionalFormats)
```
    The conditional format rules in this sheet.
    
    Parameters:
    
    conditionalFormats - conditionalFormats or null for none
  - getData
```
public 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). For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values.
    
    Returns:
    
    value or null for none
  - setData
```
public Sheet setData(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). For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values.
    
    Parameters:
    
    data - data or null for none
  - getDeveloperMetadata
```
public List<DeveloperMetadata> getDeveloperMetadata()
```
    The developer metadata associated with a sheet.
    
    Returns:
    
    value or null for none
  - setDeveloperMetadata
```
public Sheet setDeveloperMetadata(List<DeveloperMetadata> developerMetadata)
```
    The developer metadata associated with a sheet.
    
    Parameters:
    
    developerMetadata - developerMetadata or null for none
  - getFilterViews
```
public List<FilterView> getFilterViews()
```
    The filter views in this sheet.
    
    Returns:
    
    value or null for none
  - setFilterViews
```
public Sheet setFilterViews(List<FilterView> filterViews)
```
    The filter views in this sheet.
    
    Parameters:
    
    filterViews - filterViews or null for none
  - getMerges
```
public List<GridRange> getMerges()
```
    The ranges that are merged together.
    
    Returns:
    
    value or null for none
  - setMerges
```
public Sheet setMerges(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 List<ProtectedRange> getProtectedRanges()
```
    The protected ranges in this sheet.
    
    Returns:
    
    value or null for none
  - setProtectedRanges
```
public Sheet setProtectedRanges(List<ProtectedRange> protectedRanges)
```
    The protected ranges in this sheet.
    
    Parameters:
    
    protectedRanges - protectedRanges or null for none
  - getRowGroups
```
public List<DimensionGroup> getRowGroups()
```
    All row groups on this sheet, ordered by increasing range start index, then by group depth.
    
    Returns:
    
    value or null for none
  - setRowGroups
```
public Sheet setRowGroups(List<DimensionGroup> rowGroups)
```
    All row groups on this sheet, ordered by increasing range start index, then by group depth.
    
    Parameters:
    
    rowGroups - rowGroups or null for none
  - getSlicers
```
public List<Slicer> getSlicers()
```
    The slicers on this sheet.
    
    Returns:
    
    value or null for none
  - setSlicers
```
public Sheet setSlicers(List<Slicer> slicers)
```
    The slicers on this sheet.
    
    Parameters:
    
    slicers - slicers or null for none
  - set
```
public Sheet set(String fieldName,
                 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

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

Methods inherited from interface java.util.Map

Constructor Detail

Sheet

Method Detail

getBandedRanges

setBandedRanges

getBasicFilter

setBasicFilter

getCharts

setCharts

getColumnGroups

setColumnGroups

getConditionalFormats

setConditionalFormats

getData

setData

getDeveloperMetadata

setDeveloperMetadata

getFilterViews

setFilterViews

getMerges

setMerges

getProperties

setProperties

getProtectedRanges

setProtectedRanges

getRowGroups

setRowGroups

getSlicers

setSlicers

set

clone