File: Sheet.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 (429 lines) | stat: -rw-r--r-- 13,840 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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/*
 * 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;

/**
 * A sheet in a spreadsheet.
 *
 * <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 Sheet extends com.google.api.client.json.GenericJson {

  /**
   * The banded (alternating colors) ranges on this sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<BandedRange> bandedRanges;

  static {
    // hack to force ProGuard to consider BandedRange used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(BandedRange.class);
  }

  /**
   * The filter on this sheet, if any.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private BasicFilter basicFilter;

  /**
   * The specifications of every chart on this sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<EmbeddedChart> charts;

  static {
    // hack to force ProGuard to consider EmbeddedChart used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(EmbeddedChart.class);
  }

  /**
   * All column groups on this sheet, ordered by increasing range start index, then by group depth.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<DimensionGroup> columnGroups;

  static {
    // hack to force ProGuard to consider DimensionGroup used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(DimensionGroup.class);
  }

  /**
   * The conditional format rules in this sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<ConditionalFormatRule> conditionalFormats;

  static {
    // hack to force ProGuard to consider ConditionalFormatRule used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(ConditionalFormatRule.class);
  }

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

  static {
    // hack to force ProGuard to consider GridData used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GridData.class);
  }

  /**
   * The developer metadata associated with a sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<DeveloperMetadata> developerMetadata;

  static {
    // hack to force ProGuard to consider DeveloperMetadata used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(DeveloperMetadata.class);
  }

  /**
   * The filter views in this sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<FilterView> filterViews;

  static {
    // hack to force ProGuard to consider FilterView used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(FilterView.class);
  }

  /**
   * The ranges that are merged together.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GridRange> merges;

  static {
    // hack to force ProGuard to consider GridRange used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GridRange.class);
  }

  /**
   * The properties of the sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private SheetProperties properties;

  /**
   * The protected ranges in this sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<ProtectedRange> protectedRanges;

  static {
    // hack to force ProGuard to consider ProtectedRange used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(ProtectedRange.class);
  }

  /**
   * All row groups on this sheet, ordered by increasing range start index, then by group depth.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<DimensionGroup> rowGroups;

  static {
    // hack to force ProGuard to consider DimensionGroup used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(DimensionGroup.class);
  }

  /**
   * The slicers on this sheet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<Slicer> slicers;

  /**
   * The banded (alternating colors) ranges on this sheet.
   * @return value or {@code null} for none
   */
  public java.util.List<BandedRange> getBandedRanges() {
    return bandedRanges;
  }

  /**
   * The banded (alternating colors) ranges on this sheet.
   * @param bandedRanges bandedRanges or {@code null} for none
   */
  public Sheet setBandedRanges(java.util.List<BandedRange> bandedRanges) {
    this.bandedRanges = bandedRanges;
    return this;
  }

  /**
   * The filter on this sheet, if any.
   * @return value or {@code null} for none
   */
  public BasicFilter getBasicFilter() {
    return basicFilter;
  }

  /**
   * The filter on this sheet, if any.
   * @param basicFilter basicFilter or {@code null} for none
   */
  public Sheet setBasicFilter(BasicFilter basicFilter) {
    this.basicFilter = basicFilter;
    return this;
  }

  /**
   * The specifications of every chart on this sheet.
   * @return value or {@code null} for none
   */
  public java.util.List<EmbeddedChart> getCharts() {
    return charts;
  }

  /**
   * The specifications of every chart on this sheet.
   * @param charts charts or {@code null} for none
   */
  public Sheet setCharts(java.util.List<EmbeddedChart> charts) {
    this.charts = charts;
    return this;
  }

  /**
   * All column groups on this sheet, ordered by increasing range start index, then by group depth.
   * @return value or {@code null} for none
   */
  public java.util.List<DimensionGroup> getColumnGroups() {
    return columnGroups;
  }

  /**
   * All column groups on this sheet, ordered by increasing range start index, then by group depth.
   * @param columnGroups columnGroups or {@code null} for none
   */
  public Sheet setColumnGroups(java.util.List<DimensionGroup> columnGroups) {
    this.columnGroups = columnGroups;
    return this;
  }

  /**
   * The conditional format rules in this sheet.
   * @return value or {@code null} for none
   */
  public java.util.List<ConditionalFormatRule> getConditionalFormats() {
    return conditionalFormats;
  }

  /**
   * The conditional format rules in this sheet.
   * @param conditionalFormats conditionalFormats or {@code null} for none
   */
  public Sheet setConditionalFormats(java.util.List<ConditionalFormatRule> conditionalFormats) {
    this.conditionalFormats = conditionalFormats;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.util.List<GridData> getData() {
    return 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.
   * @param data data or {@code null} for none
   */
  public Sheet setData(java.util.List<GridData> data) {
    this.data = data;
    return this;
  }

  /**
   * The developer metadata associated with a sheet.
   * @return value or {@code null} for none
   */
  public java.util.List<DeveloperMetadata> getDeveloperMetadata() {
    return developerMetadata;
  }

  /**
   * The developer metadata associated with a sheet.
   * @param developerMetadata developerMetadata or {@code null} for none
   */
  public Sheet setDeveloperMetadata(java.util.List<DeveloperMetadata> developerMetadata) {
    this.developerMetadata = developerMetadata;
    return this;
  }

  /**
   * The filter views in this sheet.
   * @return value or {@code null} for none
   */
  public java.util.List<FilterView> getFilterViews() {
    return filterViews;
  }

  /**
   * The filter views in this sheet.
   * @param filterViews filterViews or {@code null} for none
   */
  public Sheet setFilterViews(java.util.List<FilterView> filterViews) {
    this.filterViews = filterViews;
    return this;
  }

  /**
   * The ranges that are merged together.
   * @return value or {@code null} for none
   */
  public java.util.List<GridRange> getMerges() {
    return merges;
  }

  /**
   * The ranges that are merged together.
   * @param merges merges or {@code null} for none
   */
  public Sheet setMerges(java.util.List<GridRange> merges) {
    this.merges = merges;
    return this;
  }

  /**
   * The properties of the sheet.
   * @return value or {@code null} for none
   */
  public SheetProperties getProperties() {
    return properties;
  }

  /**
   * The properties of the sheet.
   * @param properties properties or {@code null} for none
   */
  public Sheet setProperties(SheetProperties properties) {
    this.properties = properties;
    return this;
  }

  /**
   * The protected ranges in this sheet.
   * @return value or {@code null} for none
   */
  public java.util.List<ProtectedRange> getProtectedRanges() {
    return protectedRanges;
  }

  /**
   * The protected ranges in this sheet.
   * @param protectedRanges protectedRanges or {@code null} for none
   */
  public Sheet setProtectedRanges(java.util.List<ProtectedRange> protectedRanges) {
    this.protectedRanges = protectedRanges;
    return this;
  }

  /**
   * All row groups on this sheet, ordered by increasing range start index, then by group depth.
   * @return value or {@code null} for none
   */
  public java.util.List<DimensionGroup> getRowGroups() {
    return rowGroups;
  }

  /**
   * All row groups on this sheet, ordered by increasing range start index, then by group depth.
   * @param rowGroups rowGroups or {@code null} for none
   */
  public Sheet setRowGroups(java.util.List<DimensionGroup> rowGroups) {
    this.rowGroups = rowGroups;
    return this;
  }

  /**
   * The slicers on this sheet.
   * @return value or {@code null} for none
   */
  public java.util.List<Slicer> getSlicers() {
    return slicers;
  }

  /**
   * The slicers on this sheet.
   * @param slicers slicers or {@code null} for none
   */
  public Sheet setSlicers(java.util.List<Slicer> slicers) {
    this.slicers = slicers;
    return this;
  }

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

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

}