Package com.google.devtools.cloudtrace.v2

Interface SpanOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Span, Span.Builder
    public interface SpanOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Required. The resource name of the span in the following format:

  * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]`

 `[TRACE_ID]` is a unique identifier for a trace within a project;
 it is a 32-character hexadecimal encoding of a 16-byte array. It should
 not be zero.

 `[SPAN_ID]` is a unique identifier for a span within a trace; it
 is a 16-character hexadecimal encoding of an 8-byte array. It should not
 be zero.
 .
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Required. The resource name of the span in the following format:

  * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]`

 `[TRACE_ID]` is a unique identifier for a trace within a project;
 it is a 32-character hexadecimal encoding of a 16-byte array. It should
 not be zero.

 `[SPAN_ID]` is a unique identifier for a span within a trace; it
 is a 16-character hexadecimal encoding of an 8-byte array. It should not
 be zero.
 .
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for name.

      • getSpanId

        String getSpanId()
         Required. The `[SPAN_ID]` portion of the span's resource name.
        string span_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The spanId.

      • getSpanIdBytes

        com.google.protobuf.ByteString getSpanIdBytes()
         Required. The `[SPAN_ID]` portion of the span's resource name.
        string span_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for spanId.

      • getParentSpanId

        String getParentSpanId()
         The `[SPAN_ID]` of this span's parent span. If this is a root span,
 then this field must be empty.
        string parent_span_id = 3;
        Returns:
        The parentSpanId.

      • getParentSpanIdBytes

        com.google.protobuf.ByteString getParentSpanIdBytes()
         The `[SPAN_ID]` of this span's parent span. If this is a root span,
 then this field must be empty.
        string parent_span_id = 3;
        Returns:
        The bytes for parentSpanId.

      • hasDisplayName

        boolean hasDisplayName()
         Required. A description of the span's operation (up to 128 bytes).
 Cloud Trace displays the description in the
 Cloud console.
 For example, the display name can be a qualified method name or a file name
 and a line number where the operation is called. A best practice is to use
 the same display name within an application and at the same call point.
 This makes it easier to correlate spans in different traces.
        .google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the displayName field is set.

      • getDisplayName

        TruncatableString getDisplayName()
         Required. A description of the span's operation (up to 128 bytes).
 Cloud Trace displays the description in the
 Cloud console.
 For example, the display name can be a qualified method name or a file name
 and a line number where the operation is called. A best practice is to use
 the same display name within an application and at the same call point.
 This makes it easier to correlate spans in different traces.
        .google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameOrBuilder

        TruncatableStringOrBuilder getDisplayNameOrBuilder()
         Required. A description of the span's operation (up to 128 bytes).
 Cloud Trace displays the description in the
 Cloud console.
 For example, the display name can be a qualified method name or a file name
 and a line number where the operation is called. A best practice is to use
 the same display name within an application and at the same call point.
 This makes it easier to correlate spans in different traces.
        .google.devtools.cloudtrace.v2.TruncatableString display_name = 4 [(.google.api.field_behavior) = REQUIRED];

      • hasStartTime

        boolean hasStartTime()
         Required. The start time of the span. On the client side, this is the time
 kept by the local machine where the span execution starts. On the server
 side, this is the time when the server's application handler starts
 running.
        .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the startTime field is set.

      • getStartTime

        com.google.protobuf.Timestamp getStartTime()
         Required. The start time of the span. On the client side, this is the time
 kept by the local machine where the span execution starts. On the server
 side, this is the time when the server's application handler starts
 running.
        .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Required. The start time of the span. On the client side, this is the time
 kept by the local machine where the span execution starts. On the server
 side, this is the time when the server's application handler starts
 running.
        .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = REQUIRED];

      • hasEndTime

        boolean hasEndTime()
         Required. The end time of the span. On the client side, this is the time
 kept by the local machine where the span execution ends. On the server
 side, this is the time when the server application handler stops running.
        .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the endTime field is set.

      • getEndTime

        com.google.protobuf.Timestamp getEndTime()
         Required. The end time of the span. On the client side, this is the time
 kept by the local machine where the span execution ends. On the server
 side, this is the time when the server application handler stops running.
        .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Required. The end time of the span. On the client side, this is the time
 kept by the local machine where the span execution ends. On the server
 side, this is the time when the server application handler stops running.
        .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = REQUIRED];

      • hasAttributes

        boolean hasAttributes()
         A set of attributes on the span. You can have up to 32 attributes per
 span.
        .google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;
        Returns:
        Whether the attributes field is set.

      • getAttributes

        Span.Attributes getAttributes()
         A set of attributes on the span. You can have up to 32 attributes per
 span.
        .google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;
        Returns:
        The attributes.

      • getAttributesOrBuilder

        Span.AttributesOrBuilder getAttributesOrBuilder()
         A set of attributes on the span. You can have up to 32 attributes per
 span.
        .google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;

      • hasStackTrace

        boolean hasStackTrace()
         Stack trace captured at the start of the span.
        .google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;
        Returns:
        Whether the stackTrace field is set.

      • getStackTrace

        StackTrace getStackTrace()
         Stack trace captured at the start of the span.
        .google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;
        Returns:
        The stackTrace.

      • getStackTraceOrBuilder

        StackTraceOrBuilder getStackTraceOrBuilder()
         Stack trace captured at the start of the span.
        .google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

      • hasTimeEvents

        boolean hasTimeEvents()
         A set of time events. You can have up to 32 annotations and 128 message
 events per span.
        .google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;
        Returns:
        Whether the timeEvents field is set.

      • getTimeEvents

        Span.TimeEvents getTimeEvents()
         A set of time events. You can have up to 32 annotations and 128 message
 events per span.
        .google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;
        Returns:
        The timeEvents.

      • getTimeEventsOrBuilder

        Span.TimeEventsOrBuilder getTimeEventsOrBuilder()
         A set of time events. You can have up to 32 annotations and 128 message
 events per span.
        .google.devtools.cloudtrace.v2.Span.TimeEvents time_events = 9;

      • hasLinks

        boolean hasLinks()
         Links associated with the span. You can have up to 128 links per Span.
        .google.devtools.cloudtrace.v2.Span.Links links = 10;
        Returns:
        Whether the links field is set.

      • getLinks

        Span.Links getLinks()
         Links associated with the span. You can have up to 128 links per Span.
        .google.devtools.cloudtrace.v2.Span.Links links = 10;
        Returns:
        The links.

      • getLinksOrBuilder

        Span.LinksOrBuilder getLinksOrBuilder()
         Links associated with the span. You can have up to 128 links per Span.
        .google.devtools.cloudtrace.v2.Span.Links links = 10;

      • hasStatus

        boolean hasStatus()
         Optional. The final status for this span.
        .google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the status field is set.

      • getStatus

        com.google.rpc.Status getStatus()
         Optional. The final status for this span.
        .google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The status.

      • getStatusOrBuilder

        com.google.rpc.StatusOrBuilder getStatusOrBuilder()
         Optional. The final status for this span.
        .google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

      • hasSameProcessAsParentSpan

        boolean hasSameProcessAsParentSpan()
         Optional. Set this parameter to indicate whether this span is in
 the same process as its parent. If you do not set this parameter,
 Trace is unable to take advantage of this helpful information.
        .google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the sameProcessAsParentSpan field is set.

      • getSameProcessAsParentSpan

        com.google.protobuf.BoolValue getSameProcessAsParentSpan()
         Optional. Set this parameter to indicate whether this span is in
 the same process as its parent. If you do not set this parameter,
 Trace is unable to take advantage of this helpful information.
        .google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The sameProcessAsParentSpan.

      • getSameProcessAsParentSpanOrBuilder

        com.google.protobuf.BoolValueOrBuilder getSameProcessAsParentSpanOrBuilder()
         Optional. Set this parameter to indicate whether this span is in
 the same process as its parent. If you do not set this parameter,
 Trace is unable to take advantage of this helpful information.
        .google.protobuf.BoolValue same_process_as_parent_span = 12 [(.google.api.field_behavior) = OPTIONAL];

      • hasChildSpanCount

        boolean hasChildSpanCount()
         Optional. The number of child spans that were generated while this span
 was active. If set, allows implementation to detect missing child spans.
        .google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the childSpanCount field is set.

      • getChildSpanCount

        com.google.protobuf.Int32Value getChildSpanCount()
         Optional. The number of child spans that were generated while this span
 was active. If set, allows implementation to detect missing child spans.
        .google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The childSpanCount.

      • getChildSpanCountOrBuilder

        com.google.protobuf.Int32ValueOrBuilder getChildSpanCountOrBuilder()
         Optional. The number of child spans that were generated while this span
 was active. If set, allows implementation to detect missing child spans.
        .google.protobuf.Int32Value child_span_count = 13 [(.google.api.field_behavior) = OPTIONAL];

      • getSpanKindValue

        int getSpanKindValue()
         Optional. Distinguishes between spans generated in a particular context.
 For example, two spans with the same name may be distinguished using
 `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
        .google.devtools.cloudtrace.v2.Span.SpanKind span_kind = 14 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for spanKind.

      • getSpanKind

        Span.SpanKind getSpanKind()
         Optional. Distinguishes between spans generated in a particular context.
 For example, two spans with the same name may be distinguished using
 `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
        .google.devtools.cloudtrace.v2.Span.SpanKind span_kind = 14 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The spanKind.