File: BatchUpdateSpreadsheetRequest.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 (147 lines) | stat: -rw-r--r-- 5,523 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
/*
 * 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;

/**
 * The request for updating any aspect of 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 BatchUpdateSpreadsheetRequest extends com.google.api.client.json.GenericJson {

  /**
   * Determines if the update response should include the spreadsheet resource.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean includeSpreadsheetInResponse;

  /**
   * A list of updates to apply to the spreadsheet. Requests will be applied in the order they are
   * specified. If any request is not valid, no requests will be applied.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<Request> requests;

  /**
   * True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is
   * 'true'. This parameter is ignored if a field mask was set in the request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean responseIncludeGridData;

  /**
   * Limits the ranges included in the response spreadsheet. Meaningful only if
   * include_spreadsheet_in_response is 'true'.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> responseRanges;

  /**
   * Determines if the update response should include the spreadsheet resource.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIncludeSpreadsheetInResponse() {
    return includeSpreadsheetInResponse;
  }

  /**
   * Determines if the update response should include the spreadsheet resource.
   * @param includeSpreadsheetInResponse includeSpreadsheetInResponse or {@code null} for none
   */
  public BatchUpdateSpreadsheetRequest setIncludeSpreadsheetInResponse(java.lang.Boolean includeSpreadsheetInResponse) {
    this.includeSpreadsheetInResponse = includeSpreadsheetInResponse;
    return this;
  }

  /**
   * A list of updates to apply to the spreadsheet. Requests will be applied in the order they are
   * specified. If any request is not valid, no requests will be applied.
   * @return value or {@code null} for none
   */
  public java.util.List<Request> getRequests() {
    return requests;
  }

  /**
   * A list of updates to apply to the spreadsheet. Requests will be applied in the order they are
   * specified. If any request is not valid, no requests will be applied.
   * @param requests requests or {@code null} for none
   */
  public BatchUpdateSpreadsheetRequest setRequests(java.util.List<Request> requests) {
    this.requests = requests;
    return this;
  }

  /**
   * True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is
   * 'true'. This parameter is ignored if a field mask was set in the request.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getResponseIncludeGridData() {
    return responseIncludeGridData;
  }

  /**
   * True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is
   * 'true'. This parameter is ignored if a field mask was set in the request.
   * @param responseIncludeGridData responseIncludeGridData or {@code null} for none
   */
  public BatchUpdateSpreadsheetRequest setResponseIncludeGridData(java.lang.Boolean responseIncludeGridData) {
    this.responseIncludeGridData = responseIncludeGridData;
    return this;
  }

  /**
   * Limits the ranges included in the response spreadsheet. Meaningful only if
   * include_spreadsheet_in_response is 'true'.
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getResponseRanges() {
    return responseRanges;
  }

  /**
   * Limits the ranges included in the response spreadsheet. Meaningful only if
   * include_spreadsheet_in_response is 'true'.
   * @param responseRanges responseRanges or {@code null} for none
   */
  public BatchUpdateSpreadsheetRequest setResponseRanges(java.util.List<java.lang.String> responseRanges) {
    this.responseRanges = responseRanges;
    return this;
  }

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

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

}