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

Class InsertDimensionRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class InsertDimensionRequest
extends GenericJson

Inserts rows or columns in a sheet at a particular index.

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

Method Summary

Modifier and Type	Method and Description
InsertDimensionRequest	clone()
Boolean	getInheritFromBefore() Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions.
DimensionRange	getRange() The dimensions to insert.
InsertDimensionRequest	set(String fieldName, Object value)
InsertDimensionRequest	setInheritFromBefore(Boolean inheritFromBefore) Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions.
InsertDimensionRequest	setRange(DimensionRange range) The dimensions to insert.

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

InsertDimensionRequest

public InsertDimensionRequest()

Method Detail

getInheritFromBefore

public Boolean getInheritFromBefore()

Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green).

Returns:

value or null for none

setInheritFromBefore

public InsertDimensionRequest setInheritFromBefore(Boolean inheritFromBefore)

Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green).

Parameters:

inheritFromBefore - inheritFromBefore or null for none

getRange

public DimensionRange getRange()

The dimensions to insert. Both the start and end indexes must be bounded.

Returns:

value or null for none

setRange

public InsertDimensionRequest setRange(DimensionRange range)

The dimensions to insert. Both the start and end indexes must be bounded.

Parameters:

range - range or null for none

set

public InsertDimensionRequest set(String fieldName,
                                  Object value)

Overrides:

set in class GenericJson

clone

public InsertDimensionRequest clone()

Overrides:

clone in class GenericJson