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/admin/v1alpha/expanded_data_set.proto 18 19 package com.google.analytics.admin.v1alpha; 20 21 public interface ExpandedDataSetOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.analytics.admin.v1alpha.ExpandedDataSet) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. The resource name for this ExpandedDataSet resource. 31 * Format: properties/{property_id}/expandedDataSets/{expanded_data_set} 32 * </pre> 33 * 34 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 35 * 36 * @return The name. 37 */ getName()38 java.lang.String getName(); 39 /** 40 * 41 * 42 * <pre> 43 * Output only. The resource name for this ExpandedDataSet resource. 44 * Format: properties/{property_id}/expandedDataSets/{expanded_data_set} 45 * </pre> 46 * 47 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 48 * 49 * @return The bytes for name. 50 */ getNameBytes()51 com.google.protobuf.ByteString getNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * Required. The display name of the ExpandedDataSet. 58 * Max 200 chars. 59 * </pre> 60 * 61 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 62 * 63 * @return The displayName. 64 */ getDisplayName()65 java.lang.String getDisplayName(); 66 /** 67 * 68 * 69 * <pre> 70 * Required. The display name of the ExpandedDataSet. 71 * Max 200 chars. 72 * </pre> 73 * 74 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 75 * 76 * @return The bytes for displayName. 77 */ getDisplayNameBytes()78 com.google.protobuf.ByteString getDisplayNameBytes(); 79 80 /** 81 * 82 * 83 * <pre> 84 * Optional. The description of the ExpandedDataSet. 85 * Max 50 chars. 86 * </pre> 87 * 88 * <code>string description = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 89 * 90 * @return The description. 91 */ getDescription()92 java.lang.String getDescription(); 93 /** 94 * 95 * 96 * <pre> 97 * Optional. The description of the ExpandedDataSet. 98 * Max 50 chars. 99 * </pre> 100 * 101 * <code>string description = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 102 * 103 * @return The bytes for description. 104 */ getDescriptionBytes()105 com.google.protobuf.ByteString getDescriptionBytes(); 106 107 /** 108 * 109 * 110 * <pre> 111 * Immutable. The list of dimensions included in the ExpandedDataSet. 112 * See the [API 113 * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) 114 * for the list of dimension names. 115 * </pre> 116 * 117 * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> 118 * 119 * @return A list containing the dimensionNames. 120 */ getDimensionNamesList()121 java.util.List<java.lang.String> getDimensionNamesList(); 122 /** 123 * 124 * 125 * <pre> 126 * Immutable. The list of dimensions included in the ExpandedDataSet. 127 * See the [API 128 * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) 129 * for the list of dimension names. 130 * </pre> 131 * 132 * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> 133 * 134 * @return The count of dimensionNames. 135 */ getDimensionNamesCount()136 int getDimensionNamesCount(); 137 /** 138 * 139 * 140 * <pre> 141 * Immutable. The list of dimensions included in the ExpandedDataSet. 142 * See the [API 143 * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) 144 * for the list of dimension names. 145 * </pre> 146 * 147 * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> 148 * 149 * @param index The index of the element to return. 150 * @return The dimensionNames at the given index. 151 */ getDimensionNames(int index)152 java.lang.String getDimensionNames(int index); 153 /** 154 * 155 * 156 * <pre> 157 * Immutable. The list of dimensions included in the ExpandedDataSet. 158 * See the [API 159 * Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) 160 * for the list of dimension names. 161 * </pre> 162 * 163 * <code>repeated string dimension_names = 4 [(.google.api.field_behavior) = IMMUTABLE];</code> 164 * 165 * @param index The index of the value to return. 166 * @return The bytes of the dimensionNames at the given index. 167 */ getDimensionNamesBytes(int index)168 com.google.protobuf.ByteString getDimensionNamesBytes(int index); 169 170 /** 171 * 172 * 173 * <pre> 174 * Immutable. The list of metrics included in the ExpandedDataSet. 175 * See the [API 176 * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) 177 * for the list of dimension names. 178 * </pre> 179 * 180 * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code> 181 * 182 * @return A list containing the metricNames. 183 */ getMetricNamesList()184 java.util.List<java.lang.String> getMetricNamesList(); 185 /** 186 * 187 * 188 * <pre> 189 * Immutable. The list of metrics included in the ExpandedDataSet. 190 * See the [API 191 * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) 192 * for the list of dimension names. 193 * </pre> 194 * 195 * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code> 196 * 197 * @return The count of metricNames. 198 */ getMetricNamesCount()199 int getMetricNamesCount(); 200 /** 201 * 202 * 203 * <pre> 204 * Immutable. The list of metrics included in the ExpandedDataSet. 205 * See the [API 206 * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) 207 * for the list of dimension names. 208 * </pre> 209 * 210 * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code> 211 * 212 * @param index The index of the element to return. 213 * @return The metricNames at the given index. 214 */ getMetricNames(int index)215 java.lang.String getMetricNames(int index); 216 /** 217 * 218 * 219 * <pre> 220 * Immutable. The list of metrics included in the ExpandedDataSet. 221 * See the [API 222 * Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) 223 * for the list of dimension names. 224 * </pre> 225 * 226 * <code>repeated string metric_names = 5 [(.google.api.field_behavior) = IMMUTABLE];</code> 227 * 228 * @param index The index of the value to return. 229 * @return The bytes of the metricNames at the given index. 230 */ getMetricNamesBytes(int index)231 com.google.protobuf.ByteString getMetricNamesBytes(int index); 232 233 /** 234 * 235 * 236 * <pre> 237 * Immutable. A logical expression of ExpandedDataSet filters applied to 238 * dimension included in the ExpandedDataSet. This filter is used to reduce 239 * the number of rows and thus the chance of encountering `other` row. 240 * </pre> 241 * 242 * <code> 243 * .google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE]; 244 * </code> 245 * 246 * @return Whether the dimensionFilterExpression field is set. 247 */ hasDimensionFilterExpression()248 boolean hasDimensionFilterExpression(); 249 /** 250 * 251 * 252 * <pre> 253 * Immutable. A logical expression of ExpandedDataSet filters applied to 254 * dimension included in the ExpandedDataSet. This filter is used to reduce 255 * the number of rows and thus the chance of encountering `other` row. 256 * </pre> 257 * 258 * <code> 259 * .google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE]; 260 * </code> 261 * 262 * @return The dimensionFilterExpression. 263 */ getDimensionFilterExpression()264 com.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression getDimensionFilterExpression(); 265 /** 266 * 267 * 268 * <pre> 269 * Immutable. A logical expression of ExpandedDataSet filters applied to 270 * dimension included in the ExpandedDataSet. This filter is used to reduce 271 * the number of rows and thus the chance of encountering `other` row. 272 * </pre> 273 * 274 * <code> 275 * .google.analytics.admin.v1alpha.ExpandedDataSetFilterExpression dimension_filter_expression = 6 [(.google.api.field_behavior) = IMMUTABLE]; 276 * </code> 277 */ 278 com.google.analytics.admin.v1alpha.ExpandedDataSetFilterExpressionOrBuilder getDimensionFilterExpressionOrBuilder()279 getDimensionFilterExpressionOrBuilder(); 280 281 /** 282 * 283 * 284 * <pre> 285 * Output only. Time when expanded data set began (or will begin) collecing 286 * data. 287 * </pre> 288 * 289 * <code> 290 * .google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 291 * </code> 292 * 293 * @return Whether the dataCollectionStartTime field is set. 294 */ hasDataCollectionStartTime()295 boolean hasDataCollectionStartTime(); 296 /** 297 * 298 * 299 * <pre> 300 * Output only. Time when expanded data set began (or will begin) collecing 301 * data. 302 * </pre> 303 * 304 * <code> 305 * .google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 306 * </code> 307 * 308 * @return The dataCollectionStartTime. 309 */ getDataCollectionStartTime()310 com.google.protobuf.Timestamp getDataCollectionStartTime(); 311 /** 312 * 313 * 314 * <pre> 315 * Output only. Time when expanded data set began (or will begin) collecing 316 * data. 317 * </pre> 318 * 319 * <code> 320 * .google.protobuf.Timestamp data_collection_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 321 * </code> 322 */ getDataCollectionStartTimeOrBuilder()323 com.google.protobuf.TimestampOrBuilder getDataCollectionStartTimeOrBuilder(); 324 } 325