t

io.opencensus.proto.trace.v1

SpanOrBuilder

trait SpanOrBuilder extends MessageOrBuilder

Source
SpanOrBuilder.java
Linear Supertypes
MessageOrBuilder, MessageLiteOrBuilder, AnyRef, Any
Known Subclasses
Span
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpanOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  2. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAttributes(): Attributes

    A set of attributes on the span.


    A set of attributes on the span.

    .opencensus.proto.trace.v1.Span.Attributes attributes = 7;

    returns

    The attributes.

  4. abstract def getAttributesOrBuilder(): AttributesOrBuilder

    A set of attributes on the span.


    A set of attributes on the span.

    .opencensus.proto.trace.v1.Span.Attributes attributes = 7;

  5. abstract def getChildSpanCount(): UInt32Value

    An optional number of child spans that were generated while this span
was active. If set, allows an implementation to detect missing child spans.


    An optional number of child spans that were generated while this span
was active. If set, allows an implementation to detect missing child spans.

    .google.protobuf.UInt32Value child_span_count = 13;

    returns

    The childSpanCount.

  6. abstract def getChildSpanCountOrBuilder(): UInt32ValueOrBuilder

    An optional number of child spans that were generated while this span
was active. If set, allows an implementation to detect missing child spans.


    An optional number of child spans that were generated while this span
was active. If set, allows an implementation to detect missing child spans.

    .google.protobuf.UInt32Value child_span_count = 13;

  7. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  8. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  9. abstract def getEndTime(): Timestamp

    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.

This field is semantically required. When not set on receive -
receiver should set it to start_time value. It is important to
keep end_time > start_time for consistency.

This field is 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.

This field is semantically required. When not set on receive -
receiver should set it to start_time value. It is important to
keep end_time > start_time for consistency.

This field is required.

    .google.protobuf.Timestamp end_time = 6;

    returns

    The endTime.

  10. abstract def getEndTimeOrBuilder(): TimestampOrBuilder

    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.

This field is semantically required. When not set on receive -
receiver should set it to start_time value. It is important to
keep end_time > start_time for consistency.

This field is 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.

This field is semantically required. When not set on receive -
receiver should set it to start_time value. It is important to
keep end_time > start_time for consistency.

This field is required.

    .google.protobuf.Timestamp end_time = 6;

  11. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  12. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  13. abstract def getKind(): SpanKind

    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 queueing latency associated with the span.


    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 queueing latency associated with the span.

    .opencensus.proto.trace.v1.Span.SpanKind kind = 14;

    returns

    The kind.

  14. abstract def getKindValue(): Int

    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 queueing latency associated with the span.


    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 queueing latency associated with the span.

    .opencensus.proto.trace.v1.Span.SpanKind kind = 14;

    returns

    The enum numeric value on the wire for kind.

  15. abstract def getLinks(): Links

    The included links.


    The included links.

    .opencensus.proto.trace.v1.Span.Links links = 10;

    returns

    The links.

  16. abstract def getLinksOrBuilder(): LinksOrBuilder

    The included links.


    The included links.

    .opencensus.proto.trace.v1.Span.Links links = 10;

  17. abstract def getName(): TruncatableString

    A description of the span's operation.

For example, the 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 at the same call point in an application.
This makes it easier to correlate spans in different traces.

This field is semantically required to be set to non-empty string.
When null or empty string received - receiver may use string "name"
as a replacement. There might be smarted algorithms implemented by
receiver to fix the empty span name.

This field is required.


    A description of the span's operation.

For example, the 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 at the same call point in an application.
This makes it easier to correlate spans in different traces.

This field is semantically required to be set to non-empty string.
When null or empty string received - receiver may use string "name"
as a replacement. There might be smarted algorithms implemented by
receiver to fix the empty span name.

This field is required.

    .opencensus.proto.trace.v1.TruncatableString name = 4;

    returns

    The name.

  18. abstract def getNameOrBuilder(): TruncatableStringOrBuilder

    A description of the span's operation.

For example, the 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 at the same call point in an application.
This makes it easier to correlate spans in different traces.

This field is semantically required to be set to non-empty string.
When null or empty string received - receiver may use string "name"
as a replacement. There might be smarted algorithms implemented by
receiver to fix the empty span name.

This field is required.


    A description of the span's operation.

For example, the 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 at the same call point in an application.
This makes it easier to correlate spans in different traces.

This field is semantically required to be set to non-empty string.
When null or empty string received - receiver may use string "name"
as a replacement. There might be smarted algorithms implemented by
receiver to fix the empty span name.

This field is required.

    .opencensus.proto.trace.v1.TruncatableString name = 4;

  19. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  20. abstract def getParentSpanId(): ByteString

    The `span_id` of this span's parent span. If this is a root span, then this
field must be empty. The ID is an 8-byte array.


    The `span_id` of this span's parent span. If this is a root span, then this
field must be empty. The ID is an 8-byte array.

    bytes parent_span_id = 3;

    returns

    The parentSpanId.

  21. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  22. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  23. abstract def getResource(): Resource

    An optional resource that is associated with this span. If not set, this span
should be part of a batch that does include the resource information, unless resource
information is unknown.


    An optional resource that is associated with this span. If not set, this span
should be part of a batch that does include the resource information, unless resource
information is unknown.

    .opencensus.proto.resource.v1.Resource resource = 16;

    returns

    The resource.

  24. abstract def getResourceOrBuilder(): ResourceOrBuilder

    An optional resource that is associated with this span. If not set, this span
should be part of a batch that does include the resource information, unless resource
information is unknown.


    An optional resource that is associated with this span. If not set, this span
should be part of a batch that does include the resource information, unless resource
information is unknown.

    .opencensus.proto.resource.v1.Resource resource = 16;

  25. abstract def getSameProcessAsParentSpan(): BoolValue

    A highly recommended but not required flag that identifies when a
trace crosses a process boundary. True when the parent_span belongs
to the same process as the current span. This flag is most commonly
used to indicate the need to adjust time as clocks in different
processes may not be synchronized.


    A highly recommended but not required flag that identifies when a
trace crosses a process boundary. True when the parent_span belongs
to the same process as the current span. This flag is most commonly
used to indicate the need to adjust time as clocks in different
processes may not be synchronized.

    .google.protobuf.BoolValue same_process_as_parent_span = 12;

    returns

    The sameProcessAsParentSpan.

  26. abstract def getSameProcessAsParentSpanOrBuilder(): BoolValueOrBuilder

    A highly recommended but not required flag that identifies when a
trace crosses a process boundary. True when the parent_span belongs
to the same process as the current span. This flag is most commonly
used to indicate the need to adjust time as clocks in different
processes may not be synchronized.


    A highly recommended but not required flag that identifies when a
trace crosses a process boundary. True when the parent_span belongs
to the same process as the current span. This flag is most commonly
used to indicate the need to adjust time as clocks in different
processes may not be synchronized.

    .google.protobuf.BoolValue same_process_as_parent_span = 12;

  27. abstract def getSpanId(): ByteString

    A unique identifier for a span within a trace, assigned when the span
is created. The ID is an 8-byte array. An ID with all zeroes is considered
invalid.

This field is semantically required. Receiver should generate new
random span_id if empty or invalid span_id was received.

This field is required.


    A unique identifier for a span within a trace, assigned when the span
is created. The ID is an 8-byte array. An ID with all zeroes is considered
invalid.

This field is semantically required. Receiver should generate new
random span_id if empty or invalid span_id was received.

This field is required.

    bytes span_id = 2;

    returns

    The spanId.

  28. abstract def getStackTrace(): StackTrace

    A stack trace captured at the start of the span.


    A stack trace captured at the start of the span.

    .opencensus.proto.trace.v1.StackTrace stack_trace = 8;

    returns

    The stackTrace.

  29. abstract def getStackTraceOrBuilder(): StackTraceOrBuilder

    A stack trace captured at the start of the span.


    A stack trace captured at the start of the span.

    .opencensus.proto.trace.v1.StackTrace stack_trace = 8;

  30. abstract def getStartTime(): Timestamp

    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.

This field is semantically required. When not set on receive -
receiver should set it to the value of end_time field if it was
set. Or to the current time if neither was set. It is important to
keep end_time > start_time for consistency.

This field is 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.

This field is semantically required. When not set on receive -
receiver should set it to the value of end_time field if it was
set. Or to the current time if neither was set. It is important to
keep end_time > start_time for consistency.

This field is required.

    .google.protobuf.Timestamp start_time = 5;

    returns

    The startTime.

  31. abstract def getStartTimeOrBuilder(): TimestampOrBuilder

    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.

This field is semantically required. When not set on receive -
receiver should set it to the value of end_time field if it was
set. Or to the current time if neither was set. It is important to
keep end_time > start_time for consistency.

This field is 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.

This field is semantically required. When not set on receive -
receiver should set it to the value of end_time field if it was
set. Or to the current time if neither was set. It is important to
keep end_time > start_time for consistency.

This field is required.

    .google.protobuf.Timestamp start_time = 5;

  32. abstract def getStatus(): Status

    An optional final status for this span. Semantically when Status
wasn't set it is means span ended without errors and assume
Status.Ok (code = 0).


    An optional final status for this span. Semantically when Status
wasn't set it is means span ended without errors and assume
Status.Ok (code = 0).

    .opencensus.proto.trace.v1.Status status = 11;

    returns

    The status.

  33. abstract def getStatusOrBuilder(): StatusOrBuilder

    An optional final status for this span. Semantically when Status
wasn't set it is means span ended without errors and assume
Status.Ok (code = 0).


    An optional final status for this span. Semantically when Status
wasn't set it is means span ended without errors and assume
Status.Ok (code = 0).

    .opencensus.proto.trace.v1.Status status = 11;

  34. abstract def getTimeEvents(): TimeEvents

    The included time events.


    The included time events.

    .opencensus.proto.trace.v1.Span.TimeEvents time_events = 9;

    returns

    The timeEvents.

  35. abstract def getTimeEventsOrBuilder(): TimeEventsOrBuilder

    The included time events.


    The included time events.

    .opencensus.proto.trace.v1.Span.TimeEvents time_events = 9;

  36. abstract def getTraceId(): ByteString

    A unique identifier for a trace. All spans from the same trace share
the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes
is considered invalid.

This field is semantically required. Receiver should generate new
random trace_id if empty or invalid trace_id was received.

This field is required.


    A unique identifier for a trace. All spans from the same trace share
the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes
is considered invalid.

This field is semantically required. Receiver should generate new
random trace_id if empty or invalid trace_id was received.

This field is required.

    bytes trace_id = 1;

    returns

    The traceId.

  37. abstract def getTracestate(): Tracestate

    The Tracestate on the span.


    The Tracestate on the span.

    .opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;

    returns

    The tracestate.

  38. abstract def getTracestateOrBuilder(): TracestateOrBuilder

    The Tracestate on the span.


    The Tracestate on the span.

    .opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;

  39. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  40. abstract def hasAttributes(): Boolean

    A set of attributes on the span.


    A set of attributes on the span.

    .opencensus.proto.trace.v1.Span.Attributes attributes = 7;

    returns

    Whether the attributes field is set.

  41. abstract def hasChildSpanCount(): Boolean

    An optional number of child spans that were generated while this span
was active. If set, allows an implementation to detect missing child spans.


    An optional number of child spans that were generated while this span
was active. If set, allows an implementation to detect missing child spans.

    .google.protobuf.UInt32Value child_span_count = 13;

    returns

    Whether the childSpanCount field is set.

  42. abstract def hasEndTime(): Boolean

    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.

This field is semantically required. When not set on receive -
receiver should set it to start_time value. It is important to
keep end_time > start_time for consistency.

This field is 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.

This field is semantically required. When not set on receive -
receiver should set it to start_time value. It is important to
keep end_time > start_time for consistency.

This field is required.

    .google.protobuf.Timestamp end_time = 6;

    returns

    Whether the endTime field is set.

  43. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  44. abstract def hasLinks(): Boolean

    The included links.


    The included links.

    .opencensus.proto.trace.v1.Span.Links links = 10;

    returns

    Whether the links field is set.

  45. abstract def hasName(): Boolean

    A description of the span's operation.

For example, the 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 at the same call point in an application.
This makes it easier to correlate spans in different traces.

This field is semantically required to be set to non-empty string.
When null or empty string received - receiver may use string "name"
as a replacement. There might be smarted algorithms implemented by
receiver to fix the empty span name.

This field is required.


    A description of the span's operation.

For example, the 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 at the same call point in an application.
This makes it easier to correlate spans in different traces.

This field is semantically required to be set to non-empty string.
When null or empty string received - receiver may use string "name"
as a replacement. There might be smarted algorithms implemented by
receiver to fix the empty span name.

This field is required.

    .opencensus.proto.trace.v1.TruncatableString name = 4;

    returns

    Whether the name field is set.

  46. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  47. abstract def hasResource(): Boolean

    An optional resource that is associated with this span. If not set, this span
should be part of a batch that does include the resource information, unless resource
information is unknown.


    An optional resource that is associated with this span. If not set, this span
should be part of a batch that does include the resource information, unless resource
information is unknown.

    .opencensus.proto.resource.v1.Resource resource = 16;

    returns

    Whether the resource field is set.

  48. abstract def hasSameProcessAsParentSpan(): Boolean

    A highly recommended but not required flag that identifies when a
trace crosses a process boundary. True when the parent_span belongs
to the same process as the current span. This flag is most commonly
used to indicate the need to adjust time as clocks in different
processes may not be synchronized.


    A highly recommended but not required flag that identifies when a
trace crosses a process boundary. True when the parent_span belongs
to the same process as the current span. This flag is most commonly
used to indicate the need to adjust time as clocks in different
processes may not be synchronized.

    .google.protobuf.BoolValue same_process_as_parent_span = 12;

    returns

    Whether the sameProcessAsParentSpan field is set.

  49. abstract def hasStackTrace(): Boolean

    A stack trace captured at the start of the span.


    A stack trace captured at the start of the span.

    .opencensus.proto.trace.v1.StackTrace stack_trace = 8;

    returns

    Whether the stackTrace field is set.

  50. abstract def hasStartTime(): Boolean

    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.

This field is semantically required. When not set on receive -
receiver should set it to the value of end_time field if it was
set. Or to the current time if neither was set. It is important to
keep end_time > start_time for consistency.

This field is 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.

This field is semantically required. When not set on receive -
receiver should set it to the value of end_time field if it was
set. Or to the current time if neither was set. It is important to
keep end_time > start_time for consistency.

This field is required.

    .google.protobuf.Timestamp start_time = 5;

    returns

    Whether the startTime field is set.

  51. abstract def hasStatus(): Boolean

    An optional final status for this span. Semantically when Status
wasn't set it is means span ended without errors and assume
Status.Ok (code = 0).


    An optional final status for this span. Semantically when Status
wasn't set it is means span ended without errors and assume
Status.Ok (code = 0).

    .opencensus.proto.trace.v1.Status status = 11;

    returns

    Whether the status field is set.

  52. abstract def hasTimeEvents(): Boolean

    The included time events.


    The included time events.

    .opencensus.proto.trace.v1.Span.TimeEvents time_events = 9;

    returns

    Whether the timeEvents field is set.

  53. abstract def hasTracestate(): Boolean

    The Tracestate on the span.


    The Tracestate on the span.

    .opencensus.proto.trace.v1.Span.Tracestate tracestate = 15;

    returns

    Whether the tracestate field is set.

  54. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped