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/devtools/clouderrorreporting/v1beta1/error_stats_service.proto 18 19 package com.google.devtools.clouderrorreporting.v1beta1; 20 21 public interface ErrorGroupStatsOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.devtools.clouderrorreporting.v1beta1.ErrorGroupStats) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Group data that is independent of the filter criteria. 31 * </pre> 32 * 33 * <code>.google.devtools.clouderrorreporting.v1beta1.ErrorGroup group = 1;</code> 34 * 35 * @return Whether the group field is set. 36 */ hasGroup()37 boolean hasGroup(); 38 /** 39 * 40 * 41 * <pre> 42 * Group data that is independent of the filter criteria. 43 * </pre> 44 * 45 * <code>.google.devtools.clouderrorreporting.v1beta1.ErrorGroup group = 1;</code> 46 * 47 * @return The group. 48 */ getGroup()49 com.google.devtools.clouderrorreporting.v1beta1.ErrorGroup getGroup(); 50 /** 51 * 52 * 53 * <pre> 54 * Group data that is independent of the filter criteria. 55 * </pre> 56 * 57 * <code>.google.devtools.clouderrorreporting.v1beta1.ErrorGroup group = 1;</code> 58 */ getGroupOrBuilder()59 com.google.devtools.clouderrorreporting.v1beta1.ErrorGroupOrBuilder getGroupOrBuilder(); 60 61 /** 62 * 63 * 64 * <pre> 65 * Approximate total number of events in the given group that match 66 * the filter criteria. 67 * </pre> 68 * 69 * <code>int64 count = 2;</code> 70 * 71 * @return The count. 72 */ getCount()73 long getCount(); 74 75 /** 76 * 77 * 78 * <pre> 79 * Approximate number of affected users in the given group that 80 * match the filter criteria. 81 * Users are distinguished by data in the `ErrorContext` of the 82 * individual error events, such as their login name or their remote 83 * IP address in case of HTTP requests. 84 * The number of affected users can be zero even if the number of 85 * errors is non-zero if no data was provided from which the 86 * affected user could be deduced. 87 * Users are counted based on data in the request 88 * context that was provided in the error report. If more users are 89 * implicitly affected, such as due to a crash of the whole service, 90 * this is not reflected here. 91 * </pre> 92 * 93 * <code>int64 affected_users_count = 3;</code> 94 * 95 * @return The affectedUsersCount. 96 */ getAffectedUsersCount()97 long getAffectedUsersCount(); 98 99 /** 100 * 101 * 102 * <pre> 103 * Approximate number of occurrences over time. 104 * Timed counts returned by ListGroups are guaranteed to be: 105 * - Inside the requested time interval 106 * - Non-overlapping, and 107 * - Ordered by ascending time. 108 * </pre> 109 * 110 * <code>repeated .google.devtools.clouderrorreporting.v1beta1.TimedCount timed_counts = 4;</code> 111 */ getTimedCountsList()112 java.util.List<com.google.devtools.clouderrorreporting.v1beta1.TimedCount> getTimedCountsList(); 113 /** 114 * 115 * 116 * <pre> 117 * Approximate number of occurrences over time. 118 * Timed counts returned by ListGroups are guaranteed to be: 119 * - Inside the requested time interval 120 * - Non-overlapping, and 121 * - Ordered by ascending time. 122 * </pre> 123 * 124 * <code>repeated .google.devtools.clouderrorreporting.v1beta1.TimedCount timed_counts = 4;</code> 125 */ getTimedCounts(int index)126 com.google.devtools.clouderrorreporting.v1beta1.TimedCount getTimedCounts(int index); 127 /** 128 * 129 * 130 * <pre> 131 * Approximate number of occurrences over time. 132 * Timed counts returned by ListGroups are guaranteed to be: 133 * - Inside the requested time interval 134 * - Non-overlapping, and 135 * - Ordered by ascending time. 136 * </pre> 137 * 138 * <code>repeated .google.devtools.clouderrorreporting.v1beta1.TimedCount timed_counts = 4;</code> 139 */ getTimedCountsCount()140 int getTimedCountsCount(); 141 /** 142 * 143 * 144 * <pre> 145 * Approximate number of occurrences over time. 146 * Timed counts returned by ListGroups are guaranteed to be: 147 * - Inside the requested time interval 148 * - Non-overlapping, and 149 * - Ordered by ascending time. 150 * </pre> 151 * 152 * <code>repeated .google.devtools.clouderrorreporting.v1beta1.TimedCount timed_counts = 4;</code> 153 */ 154 java.util.List<? extends com.google.devtools.clouderrorreporting.v1beta1.TimedCountOrBuilder> getTimedCountsOrBuilderList()155 getTimedCountsOrBuilderList(); 156 /** 157 * 158 * 159 * <pre> 160 * Approximate number of occurrences over time. 161 * Timed counts returned by ListGroups are guaranteed to be: 162 * - Inside the requested time interval 163 * - Non-overlapping, and 164 * - Ordered by ascending time. 165 * </pre> 166 * 167 * <code>repeated .google.devtools.clouderrorreporting.v1beta1.TimedCount timed_counts = 4;</code> 168 */ getTimedCountsOrBuilder( int index)169 com.google.devtools.clouderrorreporting.v1beta1.TimedCountOrBuilder getTimedCountsOrBuilder( 170 int index); 171 172 /** 173 * 174 * 175 * <pre> 176 * Approximate first occurrence that was ever seen for this group 177 * and which matches the given filter criteria, ignoring the 178 * time_range that was specified in the request. 179 * </pre> 180 * 181 * <code>.google.protobuf.Timestamp first_seen_time = 5;</code> 182 * 183 * @return Whether the firstSeenTime field is set. 184 */ hasFirstSeenTime()185 boolean hasFirstSeenTime(); 186 /** 187 * 188 * 189 * <pre> 190 * Approximate first occurrence that was ever seen for this group 191 * and which matches the given filter criteria, ignoring the 192 * time_range that was specified in the request. 193 * </pre> 194 * 195 * <code>.google.protobuf.Timestamp first_seen_time = 5;</code> 196 * 197 * @return The firstSeenTime. 198 */ getFirstSeenTime()199 com.google.protobuf.Timestamp getFirstSeenTime(); 200 /** 201 * 202 * 203 * <pre> 204 * Approximate first occurrence that was ever seen for this group 205 * and which matches the given filter criteria, ignoring the 206 * time_range that was specified in the request. 207 * </pre> 208 * 209 * <code>.google.protobuf.Timestamp first_seen_time = 5;</code> 210 */ getFirstSeenTimeOrBuilder()211 com.google.protobuf.TimestampOrBuilder getFirstSeenTimeOrBuilder(); 212 213 /** 214 * 215 * 216 * <pre> 217 * Approximate last occurrence that was ever seen for this group and 218 * which matches the given filter criteria, ignoring the time_range 219 * that was specified in the request. 220 * </pre> 221 * 222 * <code>.google.protobuf.Timestamp last_seen_time = 6;</code> 223 * 224 * @return Whether the lastSeenTime field is set. 225 */ hasLastSeenTime()226 boolean hasLastSeenTime(); 227 /** 228 * 229 * 230 * <pre> 231 * Approximate last occurrence that was ever seen for this group and 232 * which matches the given filter criteria, ignoring the time_range 233 * that was specified in the request. 234 * </pre> 235 * 236 * <code>.google.protobuf.Timestamp last_seen_time = 6;</code> 237 * 238 * @return The lastSeenTime. 239 */ getLastSeenTime()240 com.google.protobuf.Timestamp getLastSeenTime(); 241 /** 242 * 243 * 244 * <pre> 245 * Approximate last occurrence that was ever seen for this group and 246 * which matches the given filter criteria, ignoring the time_range 247 * that was specified in the request. 248 * </pre> 249 * 250 * <code>.google.protobuf.Timestamp last_seen_time = 6;</code> 251 */ getLastSeenTimeOrBuilder()252 com.google.protobuf.TimestampOrBuilder getLastSeenTimeOrBuilder(); 253 254 /** 255 * 256 * 257 * <pre> 258 * Service contexts with a non-zero error count for the given filter 259 * criteria. This list can be truncated if multiple services are affected. 260 * Refer to `num_affected_services` for the total count. 261 * </pre> 262 * 263 * <code> 264 * repeated .google.devtools.clouderrorreporting.v1beta1.ServiceContext affected_services = 7; 265 * </code> 266 */ 267 java.util.List<com.google.devtools.clouderrorreporting.v1beta1.ServiceContext> getAffectedServicesList()268 getAffectedServicesList(); 269 /** 270 * 271 * 272 * <pre> 273 * Service contexts with a non-zero error count for the given filter 274 * criteria. This list can be truncated if multiple services are affected. 275 * Refer to `num_affected_services` for the total count. 276 * </pre> 277 * 278 * <code> 279 * repeated .google.devtools.clouderrorreporting.v1beta1.ServiceContext affected_services = 7; 280 * </code> 281 */ getAffectedServices(int index)282 com.google.devtools.clouderrorreporting.v1beta1.ServiceContext getAffectedServices(int index); 283 /** 284 * 285 * 286 * <pre> 287 * Service contexts with a non-zero error count for the given filter 288 * criteria. This list can be truncated if multiple services are affected. 289 * Refer to `num_affected_services` for the total count. 290 * </pre> 291 * 292 * <code> 293 * repeated .google.devtools.clouderrorreporting.v1beta1.ServiceContext affected_services = 7; 294 * </code> 295 */ getAffectedServicesCount()296 int getAffectedServicesCount(); 297 /** 298 * 299 * 300 * <pre> 301 * Service contexts with a non-zero error count for the given filter 302 * criteria. This list can be truncated if multiple services are affected. 303 * Refer to `num_affected_services` for the total count. 304 * </pre> 305 * 306 * <code> 307 * repeated .google.devtools.clouderrorreporting.v1beta1.ServiceContext affected_services = 7; 308 * </code> 309 */ 310 java.util.List<? extends com.google.devtools.clouderrorreporting.v1beta1.ServiceContextOrBuilder> getAffectedServicesOrBuilderList()311 getAffectedServicesOrBuilderList(); 312 /** 313 * 314 * 315 * <pre> 316 * Service contexts with a non-zero error count for the given filter 317 * criteria. This list can be truncated if multiple services are affected. 318 * Refer to `num_affected_services` for the total count. 319 * </pre> 320 * 321 * <code> 322 * repeated .google.devtools.clouderrorreporting.v1beta1.ServiceContext affected_services = 7; 323 * </code> 324 */ 325 com.google.devtools.clouderrorreporting.v1beta1.ServiceContextOrBuilder getAffectedServicesOrBuilder(int index)326 getAffectedServicesOrBuilder(int index); 327 328 /** 329 * 330 * 331 * <pre> 332 * The total number of services with a non-zero error count for the given 333 * filter criteria. 334 * </pre> 335 * 336 * <code>int32 num_affected_services = 8;</code> 337 * 338 * @return The numAffectedServices. 339 */ getNumAffectedServices()340 int getNumAffectedServices(); 341 342 /** 343 * 344 * 345 * <pre> 346 * An arbitrary event that is chosen as representative for the whole group. 347 * The representative event is intended to be used as a quick preview for 348 * the whole group. Events in the group are usually sufficiently similar 349 * to each other such that showing an arbitrary representative provides 350 * insight into the characteristics of the group as a whole. 351 * </pre> 352 * 353 * <code>.google.devtools.clouderrorreporting.v1beta1.ErrorEvent representative = 9;</code> 354 * 355 * @return Whether the representative field is set. 356 */ hasRepresentative()357 boolean hasRepresentative(); 358 /** 359 * 360 * 361 * <pre> 362 * An arbitrary event that is chosen as representative for the whole group. 363 * The representative event is intended to be used as a quick preview for 364 * the whole group. Events in the group are usually sufficiently similar 365 * to each other such that showing an arbitrary representative provides 366 * insight into the characteristics of the group as a whole. 367 * </pre> 368 * 369 * <code>.google.devtools.clouderrorreporting.v1beta1.ErrorEvent representative = 9;</code> 370 * 371 * @return The representative. 372 */ getRepresentative()373 com.google.devtools.clouderrorreporting.v1beta1.ErrorEvent getRepresentative(); 374 /** 375 * 376 * 377 * <pre> 378 * An arbitrary event that is chosen as representative for the whole group. 379 * The representative event is intended to be used as a quick preview for 380 * the whole group. Events in the group are usually sufficiently similar 381 * to each other such that showing an arbitrary representative provides 382 * insight into the characteristics of the group as a whole. 383 * </pre> 384 * 385 * <code>.google.devtools.clouderrorreporting.v1beta1.ErrorEvent representative = 9;</code> 386 */ getRepresentativeOrBuilder()387 com.google.devtools.clouderrorreporting.v1beta1.ErrorEventOrBuilder getRepresentativeOrBuilder(); 388 } 389