3131public final class Dimension extends com .google .api .client .json .GenericJson {
3232
3333 /**
34- * Required. The name of the column in the source SQL query that is used to chart the dimension.
34+ * Required. For widgets that use SQL queries, set the value to the name of the column in the
35+ * results table whose data is charted. For a histogram that uses a time series query, set the
36+ * value of this field to metric_value.
3537 * The value may be {@code null}.
3638 */
3739 @ com .google .api .client .util .Key
@@ -56,15 +58,18 @@ public final class Dimension extends com.google.api.client.json.GenericJson {
5658 private java .lang .Double floatBinSize ;
5759
5860 /**
59- * A limit to the number of bins generated. When 0 is specified, the maximum count is not
60- * enforced.
61+ * For widgets that use SQL queries, the limit to the number of bins to generate. When 0 is
62+ * specified, the maximum count is not enforced. For a histogram that uses a time series query,
63+ * the exact number of bins to generate. If not specified or the value is 0, then the histogram
64+ * determines the number of bins to use.
6165 * The value may be {@code null}.
6266 */
6367 @ com .google .api .client .util .Key
6468 private java .lang .Integer maxBinCount ;
6569
6670 /**
67- * numeric_bin_size is used when the column type used for a dimension is numeric or string.
71+ * numeric_bin_size is used when the column type used for a dimension is numeric or string. If the
72+ * column field is set to metric_value, then numericBinSize overrides maxBinCount.
6873 * The value may be {@code null}.
6974 */
7075 @ com .google .api .client .util .Key
@@ -87,24 +92,28 @@ public final class Dimension extends com.google.api.client.json.GenericJson {
8792 private java .lang .String sortOrder ;
8893
8994 /**
90- * time_bin_size is used when the data type specified by column is a time type and the bin size is
91- * determined by a time duration. If column_type is DATE, this must be a whole value multiple of 1
92- * day. If column_type is TIME, this must be less than or equal to 24 hours.
95+ * time_bin_size is used when the data type of the specified dimension is a time type and the bin
96+ * size is determined by a time duration. If column_type is DATE, this must be a whole value
97+ * multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours.
9398 * The value may be {@code null}.
9499 */
95100 @ com .google .api .client .util .Key
96101 private String timeBinSize ;
97102
98103 /**
99- * Required. The name of the column in the source SQL query that is used to chart the dimension.
104+ * Required. For widgets that use SQL queries, set the value to the name of the column in the
105+ * results table whose data is charted. For a histogram that uses a time series query, set the
106+ * value of this field to metric_value.
100107 * @return value or {@code null} for none
101108 */
102109 public java .lang .String getColumn () {
103110 return column ;
104111 }
105112
106113 /**
107- * Required. The name of the column in the source SQL query that is used to chart the dimension.
114+ * Required. For widgets that use SQL queries, set the value to the name of the column in the
115+ * results table whose data is charted. For a histogram that uses a time series query, set the
116+ * value of this field to metric_value.
108117 * @param column column or {@code null} for none
109118 */
110119 public Dimension setColumn (java .lang .String column ) {
@@ -155,17 +164,21 @@ public Dimension setFloatBinSize(java.lang.Double floatBinSize) {
155164 }
156165
157166 /**
158- * A limit to the number of bins generated. When 0 is specified, the maximum count is not
159- * enforced.
167+ * For widgets that use SQL queries, the limit to the number of bins to generate. When 0 is
168+ * specified, the maximum count is not enforced. For a histogram that uses a time series query,
169+ * the exact number of bins to generate. If not specified or the value is 0, then the histogram
170+ * determines the number of bins to use.
160171 * @return value or {@code null} for none
161172 */
162173 public java .lang .Integer getMaxBinCount () {
163174 return maxBinCount ;
164175 }
165176
166177 /**
167- * A limit to the number of bins generated. When 0 is specified, the maximum count is not
168- * enforced.
178+ * For widgets that use SQL queries, the limit to the number of bins to generate. When 0 is
179+ * specified, the maximum count is not enforced. For a histogram that uses a time series query,
180+ * the exact number of bins to generate. If not specified or the value is 0, then the histogram
181+ * determines the number of bins to use.
169182 * @param maxBinCount maxBinCount or {@code null} for none
170183 */
171184 public Dimension setMaxBinCount (java .lang .Integer maxBinCount ) {
@@ -174,15 +187,17 @@ public Dimension setMaxBinCount(java.lang.Integer maxBinCount) {
174187 }
175188
176189 /**
177- * numeric_bin_size is used when the column type used for a dimension is numeric or string.
190+ * numeric_bin_size is used when the column type used for a dimension is numeric or string. If the
191+ * column field is set to metric_value, then numericBinSize overrides maxBinCount.
178192 * @return value or {@code null} for none
179193 */
180194 public java .lang .Integer getNumericBinSize () {
181195 return numericBinSize ;
182196 }
183197
184198 /**
185- * numeric_bin_size is used when the column type used for a dimension is numeric or string.
199+ * numeric_bin_size is used when the column type used for a dimension is numeric or string. If the
200+ * column field is set to metric_value, then numericBinSize overrides maxBinCount.
186201 * @param numericBinSize numericBinSize or {@code null} for none
187202 */
188203 public Dimension setNumericBinSize (java .lang .Integer numericBinSize ) {
@@ -229,19 +244,19 @@ public Dimension setSortOrder(java.lang.String sortOrder) {
229244 }
230245
231246 /**
232- * time_bin_size is used when the data type specified by column is a time type and the bin size is
233- * determined by a time duration. If column_type is DATE, this must be a whole value multiple of 1
234- * day. If column_type is TIME, this must be less than or equal to 24 hours.
247+ * time_bin_size is used when the data type of the specified dimension is a time type and the bin
248+ * size is determined by a time duration. If column_type is DATE, this must be a whole value
249+ * multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours.
235250 * @return value or {@code null} for none
236251 */
237252 public String getTimeBinSize () {
238253 return timeBinSize ;
239254 }
240255
241256 /**
242- * time_bin_size is used when the data type specified by column is a time type and the bin size is
243- * determined by a time duration. If column_type is DATE, this must be a whole value multiple of 1
244- * day. If column_type is TIME, this must be less than or equal to 24 hours.
257+ * time_bin_size is used when the data type of the specified dimension is a time type and the bin
258+ * size is determined by a time duration. If column_type is DATE, this must be a whole value
259+ * multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours.
245260 * @param timeBinSize timeBinSize or {@code null} for none
246261 */
247262 public Dimension setTimeBinSize (String timeBinSize ) {
0 commit comments