• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/v2/trace.proto
18 
19 package com.google.devtools.cloudtrace.v2;
20 
21 public interface SpanOrBuilder
22     extends
23     // @@protoc_insertion_point(interface_extends:google.devtools.cloudtrace.v2.Span)
24     com.google.protobuf.MessageOrBuilder {
25 
26   /**
27    *
28    *
29    * <pre>
30    * Required. The resource name of the span in the following format:
31    *  * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]`
32    * `[TRACE_ID]` is a unique identifier for a trace within a project;
33    * it is a 32-character hexadecimal encoding of a 16-byte array. It should
34    * not be zero.
35    * `[SPAN_ID]` is a unique identifier for a span within a trace; it
36    * is a 16-character hexadecimal encoding of an 8-byte array. It should not
37    * be zero.
38    * .
39    * </pre>
40    *
41    * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code>
42    *
43    * @return The name.
44    */
getName()45   java.lang.String getName();
46   /**
47    *
48    *
49    * <pre>
50    * Required. The resource name of the span in the following format:
51    *  * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]`
52    * `[TRACE_ID]` is a unique identifier for a trace within a project;
53    * it is a 32-character hexadecimal encoding of a 16-byte array. It should
54    * not be zero.
55    * `[SPAN_ID]` is a unique identifier for a span within a trace; it
56    * is a 16-character hexadecimal encoding of an 8-byte array. It should not
57    * be zero.
58    * .
59    * </pre>
60    *
61    * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code>
62    *
63    * @return The bytes for name.
64    */
getNameBytes()65   com.google.protobuf.ByteString getNameBytes();
66 
67   /**
68    *
69    *
70    * <pre>
71    * Required. The `[SPAN_ID]` portion of the span's resource name.
72    * </pre>
73    *
74    * <code>string span_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
75    *
76    * @return The spanId.
77    */
getSpanId()78   java.lang.String getSpanId();
79   /**
80    *
81    *
82    * <pre>
83    * Required. The `[SPAN_ID]` portion of the span's resource name.
84    * </pre>
85    *
86    * <code>string span_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
87    *
88    * @return The bytes for spanId.
89    */
getSpanIdBytes()90   com.google.protobuf.ByteString getSpanIdBytes();
91 
92   /**
93    *
94    *
95    * <pre>
96    * The `[SPAN_ID]` of this span's parent span. If this is a root span,
97    * then this field must be empty.
98    * </pre>
99    *
100    * <code>string parent_span_id = 3;</code>
101    *
102    * @return The parentSpanId.
103    */
getParentSpanId()104   java.lang.String getParentSpanId();
105   /**
106    *
107    *
108    * <pre>
109    * The `[SPAN_ID]` of this span's parent span. If this is a root span,
110    * then this field must be empty.
111    * </pre>
112    *
113    * <code>string parent_span_id = 3;</code>
114    *
115    * @return The bytes for parentSpanId.
116    */
getParentSpanIdBytes()117   com.google.protobuf.ByteString getParentSpanIdBytes();
118 
119   /**
120    *
121    *
122    * <pre>
123    * Required. A description of the span's operation (up to 128 bytes).
124    * Cloud Trace displays the description in the
125    * Cloud console.
126    * For example, the display name can be a qualified method name or a file name
127    * and a line number where the operation is called. A best practice is to use
128    * the same display name within an application and at the same call point.
129    * This makes it easier to correlate spans in different traces.
130    * </pre>
131    *
132    * <code>
133    * .google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
134    * </code>
135    *
136    * @return Whether the displayName field is set.
137    */
hasDisplayName()138   boolean hasDisplayName();
139   /**
140    *
141    *
142    * <pre>
143    * Required. A description of the span's operation (up to 128 bytes).
144    * Cloud Trace displays the description in the
145    * Cloud console.
146    * For example, the display name can be a qualified method name or a file name
147    * and a line number where the operation is called. A best practice is to use
148    * the same display name within an application and at the same call point.
149    * This makes it easier to correlate spans in different traces.
150    * </pre>
151    *
152    * <code>
153    * .google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
154    * </code>
155    *
156    * @return The displayName.
157    */
getDisplayName()158   com.google.devtools.cloudtrace.v2.TruncatableString getDisplayName();
159   /**
160    *
161    *
162    * <pre>
163    * Required. A description of the span's operation (up to 128 bytes).
164    * Cloud Trace displays the description in the
165    * Cloud console.
166    * For example, the display name can be a qualified method name or a file name
167    * and a line number where the operation is called. A best practice is to use
168    * the same display name within an application and at the same call point.
169    * This makes it easier to correlate spans in different traces.
170    * </pre>
171    *
172    * <code>
173    * .google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
174    * </code>
175    */
getDisplayNameOrBuilder()176   com.google.devtools.cloudtrace.v2.TruncatableStringOrBuilder getDisplayNameOrBuilder();
177 
178   /**
179    *
180    *
181    * <pre>
182    * Required. The start time of the span. On the client side, this is the time
183    * kept by the local machine where the span execution starts. On the server
184    * side, this is the time when the server's application handler starts
185    * running.
186    * </pre>
187    *
188    * <code>.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
189    * </code>
190    *
191    * @return Whether the startTime field is set.
192    */
hasStartTime()193   boolean hasStartTime();
194   /**
195    *
196    *
197    * <pre>
198    * Required. The start time of the span. On the client side, this is the time
199    * kept by the local machine where the span execution starts. On the server
200    * side, this is the time when the server's application handler starts
201    * running.
202    * </pre>
203    *
204    * <code>.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
205    * </code>
206    *
207    * @return The startTime.
208    */
getStartTime()209   com.google.protobuf.Timestamp getStartTime();
210   /**
211    *
212    *
213    * <pre>
214    * Required. The start time of the span. On the client side, this is the time
215    * kept by the local machine where the span execution starts. On the server
216    * side, this is the time when the server's application handler starts
217    * running.
218    * </pre>
219    *
220    * <code>.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
221    * </code>
222    */
getStartTimeOrBuilder()223   com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
224 
225   /**
226    *
227    *
228    * <pre>
229    * Required. The end time of the span. On the client side, this is the time
230    * kept by the local machine where the span execution ends. On the server
231    * side, this is the time when the server application handler stops running.
232    * </pre>
233    *
234    * <code>.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];</code>
235    *
236    * @return Whether the endTime field is set.
237    */
hasEndTime()238   boolean hasEndTime();
239   /**
240    *
241    *
242    * <pre>
243    * Required. The end time of the span. On the client side, this is the time
244    * kept by the local machine where the span execution ends. On the server
245    * side, this is the time when the server application handler stops running.
246    * </pre>
247    *
248    * <code>.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];</code>
249    *
250    * @return The endTime.
251    */
getEndTime()252   com.google.protobuf.Timestamp getEndTime();
253   /**
254    *
255    *
256    * <pre>
257    * Required. The end time of the span. On the client side, this is the time
258    * kept by the local machine where the span execution ends. On the server
259    * side, this is the time when the server application handler stops running.
260    * </pre>
261    *
262    * <code>.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];</code>
263    */
getEndTimeOrBuilder()264   com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();
265 
266   /**
267    *
268    *
269    * <pre>
270    * A set of attributes on the span. You can have up to 32 attributes per
271    * span.
272    * </pre>
273    *
274    * <code>.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;</code>
275    *
276    * @return Whether the attributes field is set.
277    */
hasAttributes()278   boolean hasAttributes();
279   /**
280    *
281    *
282    * <pre>
283    * A set of attributes on the span. You can have up to 32 attributes per
284    * span.
285    * </pre>
286    *
287    * <code>.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;</code>
288    *
289    * @return The attributes.
290    */
getAttributes()291   com.google.devtools.cloudtrace.v2.Span.Attributes getAttributes();
292   /**
293    *
294    *
295    * <pre>
296    * A set of attributes on the span. You can have up to 32 attributes per
297    * span.
298    * </pre>
299    *
300    * <code>.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;</code>
301    */
getAttributesOrBuilder()302   com.google.devtools.cloudtrace.v2.Span.AttributesOrBuilder getAttributesOrBuilder();
303 
304   /**
305    *
306    *
307    * <pre>
308    * Stack trace captured at the start of the span.
309    * </pre>
310    *
311    * <code>.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;</code>
312    *
313    * @return Whether the stackTrace field is set.
314    */
hasStackTrace()315   boolean hasStackTrace();
316   /**
317    *
318    *
319    * <pre>
320    * Stack trace captured at the start of the span.
321    * </pre>
322    *
323    * <code>.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;</code>
324    *
325    * @return The stackTrace.
326    */
getStackTrace()327   com.google.devtools.cloudtrace.v2.StackTrace getStackTrace();
328   /**
329    *
330    *
331    * <pre>
332    * Stack trace captured at the start of the span.
333    * </pre>
334    *
335    * <code>.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;</code>
336    */
getStackTraceOrBuilder()337   com.google.devtools.cloudtrace.v2.StackTraceOrBuilder getStackTraceOrBuilder();
338 
339   /**
340    *
341    *
342    * <pre>
343    * A set of time events. You can have up to 32 annotations and 128 message
344    * events per span.
345    * </pre>
346    *
347    * <code>.google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;</code>
348    *
349    * @return Whether the timeEvents field is set.
350    */
hasTimeEvents()351   boolean hasTimeEvents();
352   /**
353    *
354    *
355    * <pre>
356    * A set of time events. You can have up to 32 annotations and 128 message
357    * events per span.
358    * </pre>
359    *
360    * <code>.google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;</code>
361    *
362    * @return The timeEvents.
363    */
getTimeEvents()364   com.google.devtools.cloudtrace.v2.Span.TimeEvents getTimeEvents();
365   /**
366    *
367    *
368    * <pre>
369    * A set of time events. You can have up to 32 annotations and 128 message
370    * events per span.
371    * </pre>
372    *
373    * <code>.google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;</code>
374    */
getTimeEventsOrBuilder()375   com.google.devtools.cloudtrace.v2.Span.TimeEventsOrBuilder getTimeEventsOrBuilder();
376 
377   /**
378    *
379    *
380    * <pre>
381    * Links associated with the span. You can have up to 128 links per Span.
382    * </pre>
383    *
384    * <code>.google.devtools.cloudtrace.v2.Span.Links links = 10;</code>
385    *
386    * @return Whether the links field is set.
387    */
hasLinks()388   boolean hasLinks();
389   /**
390    *
391    *
392    * <pre>
393    * Links associated with the span. You can have up to 128 links per Span.
394    * </pre>
395    *
396    * <code>.google.devtools.cloudtrace.v2.Span.Links links = 10;</code>
397    *
398    * @return The links.
399    */
getLinks()400   com.google.devtools.cloudtrace.v2.Span.Links getLinks();
401   /**
402    *
403    *
404    * <pre>
405    * Links associated with the span. You can have up to 128 links per Span.
406    * </pre>
407    *
408    * <code>.google.devtools.cloudtrace.v2.Span.Links links = 10;</code>
409    */
getLinksOrBuilder()410   com.google.devtools.cloudtrace.v2.Span.LinksOrBuilder getLinksOrBuilder();
411 
412   /**
413    *
414    *
415    * <pre>
416    * Optional. The final status for this span.
417    * </pre>
418    *
419    * <code>.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
420    *
421    * @return Whether the status field is set.
422    */
hasStatus()423   boolean hasStatus();
424   /**
425    *
426    *
427    * <pre>
428    * Optional. The final status for this span.
429    * </pre>
430    *
431    * <code>.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
432    *
433    * @return The status.
434    */
getStatus()435   com.google.rpc.Status getStatus();
436   /**
437    *
438    *
439    * <pre>
440    * Optional. The final status for this span.
441    * </pre>
442    *
443    * <code>.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];</code>
444    */
getStatusOrBuilder()445   com.google.rpc.StatusOrBuilder getStatusOrBuilder();
446 
447   /**
448    *
449    *
450    * <pre>
451    * Optional. Set this parameter to indicate whether this span is in
452    * the same process as its parent. If you do not set this parameter,
453    * Trace is unable to take advantage of this helpful information.
454    * </pre>
455    *
456    * <code>
457    * .google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
458    * </code>
459    *
460    * @return Whether the sameProcessAsParentSpan field is set.
461    */
hasSameProcessAsParentSpan()462   boolean hasSameProcessAsParentSpan();
463   /**
464    *
465    *
466    * <pre>
467    * Optional. Set this parameter to indicate whether this span is in
468    * the same process as its parent. If you do not set this parameter,
469    * Trace is unable to take advantage of this helpful information.
470    * </pre>
471    *
472    * <code>
473    * .google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
474    * </code>
475    *
476    * @return The sameProcessAsParentSpan.
477    */
getSameProcessAsParentSpan()478   com.google.protobuf.BoolValue getSameProcessAsParentSpan();
479   /**
480    *
481    *
482    * <pre>
483    * Optional. Set this parameter to indicate whether this span is in
484    * the same process as its parent. If you do not set this parameter,
485    * Trace is unable to take advantage of this helpful information.
486    * </pre>
487    *
488    * <code>
489    * .google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
490    * </code>
491    */
getSameProcessAsParentSpanOrBuilder()492   com.google.protobuf.BoolValueOrBuilder getSameProcessAsParentSpanOrBuilder();
493 
494   /**
495    *
496    *
497    * <pre>
498    * Optional. The number of child spans that were generated while this span
499    * was active. If set, allows implementation to detect missing child spans.
500    * </pre>
501    *
502    * <code>
503    * .google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
504    * </code>
505    *
506    * @return Whether the childSpanCount field is set.
507    */
hasChildSpanCount()508   boolean hasChildSpanCount();
509   /**
510    *
511    *
512    * <pre>
513    * Optional. The number of child spans that were generated while this span
514    * was active. If set, allows implementation to detect missing child spans.
515    * </pre>
516    *
517    * <code>
518    * .google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
519    * </code>
520    *
521    * @return The childSpanCount.
522    */
getChildSpanCount()523   com.google.protobuf.Int32Value getChildSpanCount();
524   /**
525    *
526    *
527    * <pre>
528    * Optional. The number of child spans that were generated while this span
529    * was active. If set, allows implementation to detect missing child spans.
530    * </pre>
531    *
532    * <code>
533    * .google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
534    * </code>
535    */
getChildSpanCountOrBuilder()536   com.google.protobuf.Int32ValueOrBuilder getChildSpanCountOrBuilder();
537 
538   /**
539    *
540    *
541    * <pre>
542    * Optional. Distinguishes between spans generated in a particular context.
543    * For example, two spans with the same name may be distinguished using
544    * `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
545    * </pre>
546    *
547    * <code>
548    * .google.devtools.cloudtrace.v2.Span.SpanKind span_kind = 14 [(.google.api.field_behavior) = OPTIONAL];
549    * </code>
550    *
551    * @return The enum numeric value on the wire for spanKind.
552    */
getSpanKindValue()553   int getSpanKindValue();
554   /**
555    *
556    *
557    * <pre>
558    * Optional. Distinguishes between spans generated in a particular context.
559    * For example, two spans with the same name may be distinguished using
560    * `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
561    * </pre>
562    *
563    * <code>
564    * .google.devtools.cloudtrace.v2.Span.SpanKind span_kind = 14 [(.google.api.field_behavior) = OPTIONAL];
565    * </code>
566    *
567    * @return The spanKind.
568    */
getSpanKind()569   com.google.devtools.cloudtrace.v2.Span.SpanKind getSpanKind();
570 }
571