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
|
/*
* 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 definition of how a value in a pivot table should be calculated.
*
* <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 PivotValue extends com.google.api.client.json.GenericJson {
/**
* If specified, indicates that pivot values should be displayed as the result of a calculation
* with another pivot value. For example, if calculated_display_type is specified as
* PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand
* total. In the Sheets editor, this is referred to as "Show As" in the value section of a pivot
* table.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String calculatedDisplayType;
/**
* The reference to the data source column that this value reads from.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private DataSourceColumnReference dataSourceColumnReference;
/**
* A custom formula to calculate the value. The formula must start with an `=` character.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String formula;
/**
* A name to use for the value.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* The column offset of the source range that this value reads from. For example, if the source
* was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the
* offset `1` would refer to column `D`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer sourceColumnOffset;
/**
* A function to summarize the value. If formula is set, the only supported values are SUM and
* CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String summarizeFunction;
/**
* If specified, indicates that pivot values should be displayed as the result of a calculation
* with another pivot value. For example, if calculated_display_type is specified as
* PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand
* total. In the Sheets editor, this is referred to as "Show As" in the value section of a pivot
* table.
* @return value or {@code null} for none
*/
public java.lang.String getCalculatedDisplayType() {
return calculatedDisplayType;
}
/**
* If specified, indicates that pivot values should be displayed as the result of a calculation
* with another pivot value. For example, if calculated_display_type is specified as
* PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand
* total. In the Sheets editor, this is referred to as "Show As" in the value section of a pivot
* table.
* @param calculatedDisplayType calculatedDisplayType or {@code null} for none
*/
public PivotValue setCalculatedDisplayType(java.lang.String calculatedDisplayType) {
this.calculatedDisplayType = calculatedDisplayType;
return this;
}
/**
* The reference to the data source column that this value reads from.
* @return value or {@code null} for none
*/
public DataSourceColumnReference getDataSourceColumnReference() {
return dataSourceColumnReference;
}
/**
* The reference to the data source column that this value reads from.
* @param dataSourceColumnReference dataSourceColumnReference or {@code null} for none
*/
public PivotValue setDataSourceColumnReference(DataSourceColumnReference dataSourceColumnReference) {
this.dataSourceColumnReference = dataSourceColumnReference;
return this;
}
/**
* A custom formula to calculate the value. The formula must start with an `=` character.
* @return value or {@code null} for none
*/
public java.lang.String getFormula() {
return formula;
}
/**
* A custom formula to calculate the value. The formula must start with an `=` character.
* @param formula formula or {@code null} for none
*/
public PivotValue setFormula(java.lang.String formula) {
this.formula = formula;
return this;
}
/**
* A name to use for the value.
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* A name to use for the value.
* @param name name or {@code null} for none
*/
public PivotValue setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* The column offset of the source range that this value reads from. For example, if the source
* was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the
* offset `1` would refer to column `D`.
* @return value or {@code null} for none
*/
public java.lang.Integer getSourceColumnOffset() {
return sourceColumnOffset;
}
/**
* The column offset of the source range that this value reads from. For example, if the source
* was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the
* offset `1` would refer to column `D`.
* @param sourceColumnOffset sourceColumnOffset or {@code null} for none
*/
public PivotValue setSourceColumnOffset(java.lang.Integer sourceColumnOffset) {
this.sourceColumnOffset = sourceColumnOffset;
return this;
}
/**
* A function to summarize the value. If formula is set, the only supported values are SUM and
* CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.
* @return value or {@code null} for none
*/
public java.lang.String getSummarizeFunction() {
return summarizeFunction;
}
/**
* A function to summarize the value. If formula is set, the only supported values are SUM and
* CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.
* @param summarizeFunction summarizeFunction or {@code null} for none
*/
public PivotValue setSummarizeFunction(java.lang.String summarizeFunction) {
this.summarizeFunction = summarizeFunction;
return this;
}
@Override
public PivotValue set(String fieldName, Object value) {
return (PivotValue) super.set(fieldName, value);
}
@Override
public PivotValue clone() {
return (PivotValue) super.clone();
}
}
|
