1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/analytics/data/v1beta/data.proto 18 19 package com.google.analytics.data.v1beta; 20 21 public interface PivotOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.analytics.data.v1beta.Pivot) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Dimension names for visible columns in the report response. Including 31 * "dateRange" produces a date range column; for each row in the response, 32 * dimension values in the date range column will indicate the corresponding 33 * date range from the request. 34 * </pre> 35 * 36 * <code>repeated string field_names = 1;</code> 37 * 38 * @return A list containing the fieldNames. 39 */ getFieldNamesList()40 java.util.List<java.lang.String> getFieldNamesList(); 41 /** 42 * 43 * 44 * <pre> 45 * Dimension names for visible columns in the report response. Including 46 * "dateRange" produces a date range column; for each row in the response, 47 * dimension values in the date range column will indicate the corresponding 48 * date range from the request. 49 * </pre> 50 * 51 * <code>repeated string field_names = 1;</code> 52 * 53 * @return The count of fieldNames. 54 */ getFieldNamesCount()55 int getFieldNamesCount(); 56 /** 57 * 58 * 59 * <pre> 60 * Dimension names for visible columns in the report response. Including 61 * "dateRange" produces a date range column; for each row in the response, 62 * dimension values in the date range column will indicate the corresponding 63 * date range from the request. 64 * </pre> 65 * 66 * <code>repeated string field_names = 1;</code> 67 * 68 * @param index The index of the element to return. 69 * @return The fieldNames at the given index. 70 */ getFieldNames(int index)71 java.lang.String getFieldNames(int index); 72 /** 73 * 74 * 75 * <pre> 76 * Dimension names for visible columns in the report response. Including 77 * "dateRange" produces a date range column; for each row in the response, 78 * dimension values in the date range column will indicate the corresponding 79 * date range from the request. 80 * </pre> 81 * 82 * <code>repeated string field_names = 1;</code> 83 * 84 * @param index The index of the value to return. 85 * @return The bytes of the fieldNames at the given index. 86 */ getFieldNamesBytes(int index)87 com.google.protobuf.ByteString getFieldNamesBytes(int index); 88 89 /** 90 * 91 * 92 * <pre> 93 * Specifies how dimensions are ordered in the pivot. In the first Pivot, the 94 * OrderBys determine Row and PivotDimensionHeader ordering; in subsequent 95 * Pivots, the OrderBys determine only PivotDimensionHeader ordering. 96 * Dimensions specified in these OrderBys must be a subset of 97 * Pivot.field_names. 98 * </pre> 99 * 100 * <code>repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;</code> 101 */ getOrderBysList()102 java.util.List<com.google.analytics.data.v1beta.OrderBy> getOrderBysList(); 103 /** 104 * 105 * 106 * <pre> 107 * Specifies how dimensions are ordered in the pivot. In the first Pivot, the 108 * OrderBys determine Row and PivotDimensionHeader ordering; in subsequent 109 * Pivots, the OrderBys determine only PivotDimensionHeader ordering. 110 * Dimensions specified in these OrderBys must be a subset of 111 * Pivot.field_names. 112 * </pre> 113 * 114 * <code>repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;</code> 115 */ getOrderBys(int index)116 com.google.analytics.data.v1beta.OrderBy getOrderBys(int index); 117 /** 118 * 119 * 120 * <pre> 121 * Specifies how dimensions are ordered in the pivot. In the first Pivot, the 122 * OrderBys determine Row and PivotDimensionHeader ordering; in subsequent 123 * Pivots, the OrderBys determine only PivotDimensionHeader ordering. 124 * Dimensions specified in these OrderBys must be a subset of 125 * Pivot.field_names. 126 * </pre> 127 * 128 * <code>repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;</code> 129 */ getOrderBysCount()130 int getOrderBysCount(); 131 /** 132 * 133 * 134 * <pre> 135 * Specifies how dimensions are ordered in the pivot. In the first Pivot, the 136 * OrderBys determine Row and PivotDimensionHeader ordering; in subsequent 137 * Pivots, the OrderBys determine only PivotDimensionHeader ordering. 138 * Dimensions specified in these OrderBys must be a subset of 139 * Pivot.field_names. 140 * </pre> 141 * 142 * <code>repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;</code> 143 */ 144 java.util.List<? extends com.google.analytics.data.v1beta.OrderByOrBuilder> getOrderBysOrBuilderList()145 getOrderBysOrBuilderList(); 146 /** 147 * 148 * 149 * <pre> 150 * Specifies how dimensions are ordered in the pivot. In the first Pivot, the 151 * OrderBys determine Row and PivotDimensionHeader ordering; in subsequent 152 * Pivots, the OrderBys determine only PivotDimensionHeader ordering. 153 * Dimensions specified in these OrderBys must be a subset of 154 * Pivot.field_names. 155 * </pre> 156 * 157 * <code>repeated .google.analytics.data.v1beta.OrderBy order_bys = 2;</code> 158 */ getOrderBysOrBuilder(int index)159 com.google.analytics.data.v1beta.OrderByOrBuilder getOrderBysOrBuilder(int index); 160 161 /** 162 * 163 * 164 * <pre> 165 * The row count of the start row. The first row is counted as row 0. 166 * </pre> 167 * 168 * <code>int64 offset = 3;</code> 169 * 170 * @return The offset. 171 */ getOffset()172 long getOffset(); 173 174 /** 175 * 176 * 177 * <pre> 178 * The number of unique combinations of dimension values to return in this 179 * pivot. The `limit` parameter is required. A `limit` of 10,000 is common for 180 * single pivot requests. 181 * The product of the `limit` for each `pivot` in a `RunPivotReportRequest` 182 * must not exceed 100,000. For example, a two pivot request with `limit: 183 * 1000` in each pivot will fail because the product is `1,000,000`. 184 * </pre> 185 * 186 * <code>int64 limit = 4;</code> 187 * 188 * @return The limit. 189 */ getLimit()190 long getLimit(); 191 192 /** 193 * 194 * 195 * <pre> 196 * Aggregate the metrics by dimensions in this pivot using the specified 197 * metric_aggregations. 198 * </pre> 199 * 200 * <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code> 201 * 202 * @return A list containing the metricAggregations. 203 */ getMetricAggregationsList()204 java.util.List<com.google.analytics.data.v1beta.MetricAggregation> getMetricAggregationsList(); 205 /** 206 * 207 * 208 * <pre> 209 * Aggregate the metrics by dimensions in this pivot using the specified 210 * metric_aggregations. 211 * </pre> 212 * 213 * <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code> 214 * 215 * @return The count of metricAggregations. 216 */ getMetricAggregationsCount()217 int getMetricAggregationsCount(); 218 /** 219 * 220 * 221 * <pre> 222 * Aggregate the metrics by dimensions in this pivot using the specified 223 * metric_aggregations. 224 * </pre> 225 * 226 * <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code> 227 * 228 * @param index The index of the element to return. 229 * @return The metricAggregations at the given index. 230 */ getMetricAggregations(int index)231 com.google.analytics.data.v1beta.MetricAggregation getMetricAggregations(int index); 232 /** 233 * 234 * 235 * <pre> 236 * Aggregate the metrics by dimensions in this pivot using the specified 237 * metric_aggregations. 238 * </pre> 239 * 240 * <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code> 241 * 242 * @return A list containing the enum numeric values on the wire for metricAggregations. 243 */ getMetricAggregationsValueList()244 java.util.List<java.lang.Integer> getMetricAggregationsValueList(); 245 /** 246 * 247 * 248 * <pre> 249 * Aggregate the metrics by dimensions in this pivot using the specified 250 * metric_aggregations. 251 * </pre> 252 * 253 * <code>repeated .google.analytics.data.v1beta.MetricAggregation metric_aggregations = 5;</code> 254 * 255 * @param index The index of the value to return. 256 * @return The enum numeric value on the wire of metricAggregations at the given index. 257 */ getMetricAggregationsValue(int index)258 int getMetricAggregationsValue(int index); 259 } 260