File: AddDimensionGroupRequest.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 (75 lines) | stat: -rw-r--r-- 3,066 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
/*
 * 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;

/**
 * Creates a group over the specified range. If the requested range is a superset of the range of an
 * existing group G, then the depth of G is incremented and this new group G' has the depth of that
 * group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D,
 * depth 2]. If the requested range is a subset of the range of an existing group G, then the depth
 * of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1]
 * + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before
 * and ends within, or starts within and ends after, the range of an existing group G, then the
 * range of the existing group G becomes the union of the ranges, and the new group G' has depth one
 * greater than the depth of G and range as the intersection of the ranges. For example, a group
 * [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2].
 *
 * <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 AddDimensionGroupRequest extends com.google.api.client.json.GenericJson {

  /**
   * The range over which to create a group.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private DimensionRange range;

  /**
   * The range over which to create a group.
   * @return value or {@code null} for none
   */
  public DimensionRange getRange() {
    return range;
  }

  /**
   * The range over which to create a group.
   * @param range range or {@code null} for none
   */
  public AddDimensionGroupRequest setRange(DimensionRange range) {
    this.range = range;
    return this;
  }

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

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

}