File: GridRange.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 (171 lines) | stat: -rw-r--r-- 5,683 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
/*
 * 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 range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is
 * inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate
 * the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 0, then:
 * `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0,
 * end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4,
 * start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0,
 * end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0,
 * end_column_index: 2` `Sheet1 == sheet_id:0` The start index must always be less than or equal to
 * the end index. If the start index equals the end index, then the range is empty. Empty ranges are
 * typically not meaningful and are usually rendered in the UI as `#REF!`.
 *
 * <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 GridRange extends com.google.api.client.json.GenericJson {

  /**
   * The end column (exclusive) of the range, or not set if unbounded.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer endColumnIndex;

  /**
   * The end row (exclusive) of the range, or not set if unbounded.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer endRowIndex;

  /**
   * The sheet this range is on.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer sheetId;

  /**
   * The start column (inclusive) of the range, or not set if unbounded.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer startColumnIndex;

  /**
   * The start row (inclusive) of the range, or not set if unbounded.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer startRowIndex;

  /**
   * The end column (exclusive) of the range, or not set if unbounded.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getEndColumnIndex() {
    return endColumnIndex;
  }

  /**
   * The end column (exclusive) of the range, or not set if unbounded.
   * @param endColumnIndex endColumnIndex or {@code null} for none
   */
  public GridRange setEndColumnIndex(java.lang.Integer endColumnIndex) {
    this.endColumnIndex = endColumnIndex;
    return this;
  }

  /**
   * The end row (exclusive) of the range, or not set if unbounded.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getEndRowIndex() {
    return endRowIndex;
  }

  /**
   * The end row (exclusive) of the range, or not set if unbounded.
   * @param endRowIndex endRowIndex or {@code null} for none
   */
  public GridRange setEndRowIndex(java.lang.Integer endRowIndex) {
    this.endRowIndex = endRowIndex;
    return this;
  }

  /**
   * The sheet this range is on.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getSheetId() {
    return sheetId;
  }

  /**
   * The sheet this range is on.
   * @param sheetId sheetId or {@code null} for none
   */
  public GridRange setSheetId(java.lang.Integer sheetId) {
    this.sheetId = sheetId;
    return this;
  }

  /**
   * The start column (inclusive) of the range, or not set if unbounded.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getStartColumnIndex() {
    return startColumnIndex;
  }

  /**
   * The start column (inclusive) of the range, or not set if unbounded.
   * @param startColumnIndex startColumnIndex or {@code null} for none
   */
  public GridRange setStartColumnIndex(java.lang.Integer startColumnIndex) {
    this.startColumnIndex = startColumnIndex;
    return this;
  }

  /**
   * The start row (inclusive) of the range, or not set if unbounded.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getStartRowIndex() {
    return startRowIndex;
  }

  /**
   * The start row (inclusive) of the range, or not set if unbounded.
   * @param startRowIndex startRowIndex or {@code null} for none
   */
  public GridRange setStartRowIndex(java.lang.Integer startRowIndex) {
    this.startRowIndex = startRowIndex;
    return this;
  }

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

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

}