target.apidocs.com.google.api.services.sheets.v4.model.DuplicateSheetRequest.html Maven / Gradle / Ivy







DuplicateSheetRequest (Google Sheets API v4-rev20230526-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class DuplicateSheetRequest
extends com.google.api.client.json.GenericJson
Duplicates the contents of a sheet.

  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


DuplicateSheetRequest() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


DuplicateSheetRequest
clone() 


Integer
getInsertSheetIndex()
The zero-based index where the new sheet should be inserted.



Integer
getNewSheetId()
If set, the ID of the new sheet.



String
getNewSheetName()
The name of the new sheet.



Integer
getSourceSheetId()
The sheet to duplicate.



DuplicateSheetRequest
set(String fieldName,
   Object value) 


DuplicateSheetRequest
setInsertSheetIndex(Integer insertSheetIndex)
The zero-based index where the new sheet should be inserted.



DuplicateSheetRequest
setNewSheetId(Integer newSheetId)
If set, the ID of the new sheet.



DuplicateSheetRequest
setNewSheetName(String newSheetName)
The name of the new sheet.



DuplicateSheetRequest
setSourceSheetId(Integer sourceSheetId)
The sheet to duplicate.







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





DuplicateSheetRequest
public DuplicateSheetRequest()









Method Detail





getInsertSheetIndex
public Integer getInsertSheetIndex()
The zero-based index where the new sheet should be inserted. The index of all sheets after this
 are incremented.

Returns:
value or null for none








setInsertSheetIndex
public DuplicateSheetRequest setInsertSheetIndex(Integer insertSheetIndex)
The zero-based index where the new sheet should be inserted. The index of all sheets after this
 are incremented.

Parameters:
insertSheetIndex - insertSheetIndex or null for none








getNewSheetId
public Integer getNewSheetId()
If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict
 with any existing sheet ID. If set, it must be non-negative.

Returns:
value or null for none








setNewSheetId
public DuplicateSheetRequest setNewSheetId(Integer newSheetId)
If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict
 with any existing sheet ID. If set, it must be non-negative.

Parameters:
newSheetId - newSheetId or null for none








getNewSheetName
public String getNewSheetName()
The name of the new sheet. If empty, a new name is chosen for you.

Returns:
value or null for none








setNewSheetName
public DuplicateSheetRequest setNewSheetName(String newSheetName)
The name of the new sheet. If empty, a new name is chosen for you.

Parameters:
newSheetName - newSheetName or null for none








getSourceSheetId
public Integer getSourceSheetId()
The sheet to duplicate. If the source sheet is of DATA_SOURCE type, its backing DataSource is
 also duplicated and associated with the new copy of the sheet. No data execution is triggered,
 the grid data of this sheet is also copied over but only available after the batch request
 completes.

Returns:
value or null for none








setSourceSheetId
public DuplicateSheetRequest setSourceSheetId(Integer sourceSheetId)
The sheet to duplicate. If the source sheet is of DATA_SOURCE type, its backing DataSource is
 also duplicated and associated with the new copy of the sheet. No data execution is triggered,
 the grid data of this sheet is also copied over but only available after the batch request
 completes.

Parameters:
sourceSheetId - sourceSheetId or null for none








set
public DuplicateSheetRequest set(String fieldName,
                                 Object value)

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








clone
public DuplicateSheetRequest clone()

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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.

Modifier and Type	Method and Description
`DuplicateSheetRequest`	`clone()`
`Integer`	`getInsertSheetIndex()` The zero-based index where the new sheet should be inserted.
`Integer`	`getNewSheetId()` If set, the ID of the new sheet.
`String`	`getNewSheetName()` The name of the new sheet.
`Integer`	`getSourceSheetId()` The sheet to duplicate.
`DuplicateSheetRequest`	`set(String fieldName, Object value)`
`DuplicateSheetRequest`	`setInsertSheetIndex(Integer insertSheetIndex)` The zero-based index where the new sheet should be inserted.
`DuplicateSheetRequest`	`setNewSheetId(Integer newSheetId)` If set, the ID of the new sheet.
`DuplicateSheetRequest`	`setNewSheetName(String newSheetName)` The name of the new sheet.
`DuplicateSheetRequest`	`setSourceSheetId(Integer sourceSheetId)` The sheet to duplicate.