File: DuplicateSheetRequest.java

package info (click to toggle)
google-api-services-sheets-java 1.32.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,008 kB
  • sloc: java: 12,826; xml: 161; makefile: 2
file content (153 lines) | stat: -rw-r--r-- 5,514 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

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

/**
 * Duplicates the contents of a sheet.
 *
 * <p> 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:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class DuplicateSheetRequest extends com.google.api.client.json.GenericJson {

  /**
   * The zero-based index where the new sheet should be inserted. The index of all sheets after this
   * are incremented.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer insertSheetIndex;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer newSheetId;

  /**
   * The name of the new sheet. If empty, a new name is chosen for you.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String newSheetName;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer sourceSheetId;

  /**
   * The zero-based index where the new sheet should be inserted. The index of all sheets after this
   * are incremented.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getInsertSheetIndex() {
    return insertSheetIndex;
  }

  /**
   * The zero-based index where the new sheet should be inserted. The index of all sheets after this
   * are incremented.
   * @param insertSheetIndex insertSheetIndex or {@code null} for none
   */
  public DuplicateSheetRequest setInsertSheetIndex(java.lang.Integer insertSheetIndex) {
    this.insertSheetIndex = insertSheetIndex;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getNewSheetId() {
    return 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.
   * @param newSheetId newSheetId or {@code null} for none
   */
  public DuplicateSheetRequest setNewSheetId(java.lang.Integer newSheetId) {
    this.newSheetId = newSheetId;
    return this;
  }

  /**
   * The name of the new sheet. If empty, a new name is chosen for you.
   * @return value or {@code null} for none
   */
  public java.lang.String getNewSheetName() {
    return newSheetName;
  }

  /**
   * The name of the new sheet. If empty, a new name is chosen for you.
   * @param newSheetName newSheetName or {@code null} for none
   */
  public DuplicateSheetRequest setNewSheetName(java.lang.String newSheetName) {
    this.newSheetName = newSheetName;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getSourceSheetId() {
    return 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.
   * @param sourceSheetId sourceSheetId or {@code null} for none
   */
  public DuplicateSheetRequest setSourceSheetId(java.lang.Integer sourceSheetId) {
    this.sourceSheetId = sourceSheetId;
    return this;
  }

  @Override
  public DuplicateSheetRequest set(String fieldName, Object value) {
    return (DuplicateSheetRequest) super.set(fieldName, value);
  }

  @Override
  public DuplicateSheetRequest clone() {
    return (DuplicateSheetRequest) super.clone();
  }

}