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

Class MoveDimensionRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Moves one or more rows or columns.

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

Method Summary

Modifier and Type	Method and Description
MoveDimensionRequest	clone()
Integer	getDestinationIndex() The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid.
DimensionRange	getSource() The source dimensions to move.
MoveDimensionRequest	set(String fieldName, Object value)
MoveDimensionRequest	setDestinationIndex(Integer destinationIndex) The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid.
MoveDimensionRequest	setSource(DimensionRange source) The source dimensions to move.

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

MoveDimensionRequest

public MoveDimensionRequest()

Method Detail

getDestinationIndex

public Integer getDestinationIndex()

The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move `"1"` and `"2"` to between `"3"` and `"4"`, the source would be `ROWS [1..3)`,and the destination index would be `"4"` (the zero-based index of row 5). The end result would be `A1..A5` of `0, 3, 1, 2, 4`.

Returns:

value or null for none

setDestinationIndex

public MoveDimensionRequest setDestinationIndex(Integer destinationIndex)

The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move `"1"` and `"2"` to between `"3"` and `"4"`, the source would be `ROWS [1..3)`,and the destination index would be `"4"` (the zero-based index of row 5). The end result would be `A1..A5` of `0, 3, 1, 2, 4`.

Parameters:

destinationIndex - destinationIndex or null for none

getSource

public DimensionRange getSource()

The source dimensions to move.

Returns:

value or null for none

setSource

public MoveDimensionRequest setSource(DimensionRange source)

The source dimensions to move.

Parameters:

source - source or null for none

set

public MoveDimensionRequest set(String fieldName,
                                Object value)

Overrides:

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

clone

public MoveDimensionRequest clone()

Overrides:

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