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/cloudtrace/v1/trace.proto 18 19 package com.google.devtools.cloudtrace.v1; 20 21 public interface ListTracesRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.devtools.cloudtrace.v1.ListTracesRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. ID of the Cloud project where the trace data is stored. 31 * </pre> 32 * 33 * <code>string project_id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 34 * 35 * @return The projectId. 36 */ getProjectId()37 java.lang.String getProjectId(); 38 /** 39 * 40 * 41 * <pre> 42 * Required. ID of the Cloud project where the trace data is stored. 43 * </pre> 44 * 45 * <code>string project_id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 46 * 47 * @return The bytes for projectId. 48 */ getProjectIdBytes()49 com.google.protobuf.ByteString getProjectIdBytes(); 50 51 /** 52 * 53 * 54 * <pre> 55 * Optional. Type of data returned for traces in the list. Default is 56 * `MINIMAL`. 57 * </pre> 58 * 59 * <code> 60 * .google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2 [(.google.api.field_behavior) = OPTIONAL]; 61 * </code> 62 * 63 * @return The enum numeric value on the wire for view. 64 */ getViewValue()65 int getViewValue(); 66 /** 67 * 68 * 69 * <pre> 70 * Optional. Type of data returned for traces in the list. Default is 71 * `MINIMAL`. 72 * </pre> 73 * 74 * <code> 75 * .google.devtools.cloudtrace.v1.ListTracesRequest.ViewType view = 2 [(.google.api.field_behavior) = OPTIONAL]; 76 * </code> 77 * 78 * @return The view. 79 */ getView()80 com.google.devtools.cloudtrace.v1.ListTracesRequest.ViewType getView(); 81 82 /** 83 * 84 * 85 * <pre> 86 * Optional. Maximum number of traces to return. If not specified or <= 0, the 87 * implementation selects a reasonable value. The implementation may 88 * return fewer traces than the requested page size. 89 * </pre> 90 * 91 * <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 92 * 93 * @return The pageSize. 94 */ getPageSize()95 int getPageSize(); 96 97 /** 98 * 99 * 100 * <pre> 101 * Token identifying the page of results to return. If provided, use the 102 * value of the `next_page_token` field from a previous request. 103 * </pre> 104 * 105 * <code>string page_token = 4;</code> 106 * 107 * @return The pageToken. 108 */ getPageToken()109 java.lang.String getPageToken(); 110 /** 111 * 112 * 113 * <pre> 114 * Token identifying the page of results to return. If provided, use the 115 * value of the `next_page_token` field from a previous request. 116 * </pre> 117 * 118 * <code>string page_token = 4;</code> 119 * 120 * @return The bytes for pageToken. 121 */ getPageTokenBytes()122 com.google.protobuf.ByteString getPageTokenBytes(); 123 124 /** 125 * 126 * 127 * <pre> 128 * Start of the time interval (inclusive) during which the trace data was 129 * collected from the application. 130 * </pre> 131 * 132 * <code>.google.protobuf.Timestamp start_time = 5;</code> 133 * 134 * @return Whether the startTime field is set. 135 */ hasStartTime()136 boolean hasStartTime(); 137 /** 138 * 139 * 140 * <pre> 141 * Start of the time interval (inclusive) during which the trace data was 142 * collected from the application. 143 * </pre> 144 * 145 * <code>.google.protobuf.Timestamp start_time = 5;</code> 146 * 147 * @return The startTime. 148 */ getStartTime()149 com.google.protobuf.Timestamp getStartTime(); 150 /** 151 * 152 * 153 * <pre> 154 * Start of the time interval (inclusive) during which the trace data was 155 * collected from the application. 156 * </pre> 157 * 158 * <code>.google.protobuf.Timestamp start_time = 5;</code> 159 */ getStartTimeOrBuilder()160 com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder(); 161 162 /** 163 * 164 * 165 * <pre> 166 * End of the time interval (inclusive) during which the trace data was 167 * collected from the application. 168 * </pre> 169 * 170 * <code>.google.protobuf.Timestamp end_time = 6;</code> 171 * 172 * @return Whether the endTime field is set. 173 */ hasEndTime()174 boolean hasEndTime(); 175 /** 176 * 177 * 178 * <pre> 179 * End of the time interval (inclusive) during which the trace data was 180 * collected from the application. 181 * </pre> 182 * 183 * <code>.google.protobuf.Timestamp end_time = 6;</code> 184 * 185 * @return The endTime. 186 */ getEndTime()187 com.google.protobuf.Timestamp getEndTime(); 188 /** 189 * 190 * 191 * <pre> 192 * End of the time interval (inclusive) during which the trace data was 193 * collected from the application. 194 * </pre> 195 * 196 * <code>.google.protobuf.Timestamp end_time = 6;</code> 197 */ getEndTimeOrBuilder()198 com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder(); 199 200 /** 201 * 202 * 203 * <pre> 204 * Optional. A filter against labels for the request. 205 * By default, searches use prefix matching. To specify exact match, prepend 206 * a plus symbol (`+`) to the search term. 207 * Multiple terms are ANDed. Syntax: 208 * * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root 209 * span starts with `NAME_PREFIX`. 210 * * `+root:NAME` or `+NAME`: Return traces where any root span's name is 211 * exactly `NAME`. 212 * * `span:NAME_PREFIX`: Return traces where any span starts with 213 * `NAME_PREFIX`. 214 * * `+span:NAME`: Return traces where any span's name is exactly 215 * `NAME`. 216 * * `latency:DURATION`: Return traces whose overall latency is 217 * greater or equal to than `DURATION`. Accepted units are nanoseconds 218 * (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For 219 * example, `latency:24ms` returns traces whose overall latency 220 * is greater than or equal to 24 milliseconds. 221 * * `label:LABEL_KEY`: Return all traces containing the specified 222 * label key (exact match, case-sensitive) regardless of the key:value 223 * pair's value (including empty values). 224 * * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified 225 * label key (exact match, case-sensitive) whose value starts with 226 * `VALUE_PREFIX`. Both a key and a value must be specified. 227 * * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair 228 * exactly matching the specified text. Both a key and a value must be 229 * specified. 230 * * `method:VALUE`: Equivalent to `/http/method:VALUE`. 231 * * `url:VALUE`: Equivalent to `/http/url:VALUE`. 232 * </pre> 233 * 234 * <code>string filter = 7 [(.google.api.field_behavior) = OPTIONAL];</code> 235 * 236 * @return The filter. 237 */ getFilter()238 java.lang.String getFilter(); 239 /** 240 * 241 * 242 * <pre> 243 * Optional. A filter against labels for the request. 244 * By default, searches use prefix matching. To specify exact match, prepend 245 * a plus symbol (`+`) to the search term. 246 * Multiple terms are ANDed. Syntax: 247 * * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root 248 * span starts with `NAME_PREFIX`. 249 * * `+root:NAME` or `+NAME`: Return traces where any root span's name is 250 * exactly `NAME`. 251 * * `span:NAME_PREFIX`: Return traces where any span starts with 252 * `NAME_PREFIX`. 253 * * `+span:NAME`: Return traces where any span's name is exactly 254 * `NAME`. 255 * * `latency:DURATION`: Return traces whose overall latency is 256 * greater or equal to than `DURATION`. Accepted units are nanoseconds 257 * (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For 258 * example, `latency:24ms` returns traces whose overall latency 259 * is greater than or equal to 24 milliseconds. 260 * * `label:LABEL_KEY`: Return all traces containing the specified 261 * label key (exact match, case-sensitive) regardless of the key:value 262 * pair's value (including empty values). 263 * * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified 264 * label key (exact match, case-sensitive) whose value starts with 265 * `VALUE_PREFIX`. Both a key and a value must be specified. 266 * * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair 267 * exactly matching the specified text. Both a key and a value must be 268 * specified. 269 * * `method:VALUE`: Equivalent to `/http/method:VALUE`. 270 * * `url:VALUE`: Equivalent to `/http/url:VALUE`. 271 * </pre> 272 * 273 * <code>string filter = 7 [(.google.api.field_behavior) = OPTIONAL];</code> 274 * 275 * @return The bytes for filter. 276 */ getFilterBytes()277 com.google.protobuf.ByteString getFilterBytes(); 278 279 /** 280 * 281 * 282 * <pre> 283 * Optional. Field used to sort the returned traces. 284 * Can be one of the following: 285 * * `trace_id` 286 * * `name` (`name` field of root span in the trace) 287 * * `duration` (difference between `end_time` and `start_time` fields of 288 * the root span) 289 * * `start` (`start_time` field of the root span) 290 * Descending order can be specified by appending `desc` to the sort field 291 * (for example, `name desc`). 292 * Only one sort field is permitted. 293 * </pre> 294 * 295 * <code>string order_by = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 296 * 297 * @return The orderBy. 298 */ getOrderBy()299 java.lang.String getOrderBy(); 300 /** 301 * 302 * 303 * <pre> 304 * Optional. Field used to sort the returned traces. 305 * Can be one of the following: 306 * * `trace_id` 307 * * `name` (`name` field of root span in the trace) 308 * * `duration` (difference between `end_time` and `start_time` fields of 309 * the root span) 310 * * `start` (`start_time` field of the root span) 311 * Descending order can be specified by appending `desc` to the sort field 312 * (for example, `name desc`). 313 * Only one sort field is permitted. 314 * </pre> 315 * 316 * <code>string order_by = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 317 * 318 * @return The bytes for orderBy. 319 */ getOrderByBytes()320 com.google.protobuf.ByteString getOrderByBytes(); 321 } 322