Package com.google.devtools.cloudtrace.v1

Class TraceSpan.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder>
com.google.devtools.cloudtrace.v1.TraceSpan.Builder
All Implemented Interfaces:
TraceSpanOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TraceSpan
public static final class TraceSpan.Builder extends com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder> implements TraceSpanOrBuilder
 A span represents a single timed event within a trace. Spans can be nested
 and form a trace tree. Often, a trace contains a root span that describes the
 end-to-end latency of an operation and, optionally, one or more subspans for
 its suboperations. Spans do not need to be contiguous. There may be gaps
 between spans in a trace.
Protobuf type google.devtools.cloudtrace.v1.TraceSpan

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder>

    • clear

      public TraceSpan.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder>

    • getDefaultInstanceForType

      public TraceSpan getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public TraceSpan build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TraceSpan buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public TraceSpan.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TraceSpan.Builder>

    • mergeFrom

      public TraceSpan.Builder mergeFrom(TraceSpan other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TraceSpan.Builder>

    • mergeFrom

      public TraceSpan.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TraceSpan.Builder>
      Throws:
      IOException

    • getSpanId

      public long getSpanId()
       Identifier for the span. Must be a 64-bit integer other than 0 and
 unique within a trace. For example, `2205310701640571284`.
      fixed64 span_id = 1;
      Specified by:
      getSpanId in interface TraceSpanOrBuilder
      Returns:
      The spanId.

    • setSpanId

      public TraceSpan.Builder setSpanId(long value)
       Identifier for the span. Must be a 64-bit integer other than 0 and
 unique within a trace. For example, `2205310701640571284`.
      fixed64 span_id = 1;
      Parameters:
      value - The spanId to set.
      Returns:
      This builder for chaining.

    • clearSpanId

      public TraceSpan.Builder clearSpanId()
       Identifier for the span. Must be a 64-bit integer other than 0 and
 unique within a trace. For example, `2205310701640571284`.
      fixed64 span_id = 1;
      Returns:
      This builder for chaining.

    • getKindValue

      public int getKindValue()
       Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `RPC_CLIENT`
 and `RPC_SERVER` to identify queueing latency associated with the span.
      .google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;
      Specified by:
      getKindValue in interface TraceSpanOrBuilder
      Returns:
      The enum numeric value on the wire for kind.

    • setKindValue

      public TraceSpan.Builder setKindValue(int value)
       Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `RPC_CLIENT`
 and `RPC_SERVER` to identify queueing latency associated with the span.
      .google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;
      Parameters:
      value - The enum numeric value on the wire for kind to set.
      Returns:
      This builder for chaining.

    • getKind

      public TraceSpan.SpanKind getKind()
       Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `RPC_CLIENT`
 and `RPC_SERVER` to identify queueing latency associated with the span.
      .google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;
      Specified by:
      getKind in interface TraceSpanOrBuilder
      Returns:
      The kind.

    • setKind

      public TraceSpan.Builder setKind(TraceSpan.SpanKind value)
       Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `RPC_CLIENT`
 and `RPC_SERVER` to identify queueing latency associated with the span.
      .google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;
      Parameters:
      value - The kind to set.
      Returns:
      This builder for chaining.

    • clearKind

      public TraceSpan.Builder clearKind()
       Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `RPC_CLIENT`
 and `RPC_SERVER` to identify queueing latency associated with the span.
      .google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;
      Returns:
      This builder for chaining.

    • getName

      public String getName()
       Name of the span. Must be less than 128 bytes. The span name is sanitized
 and displayed in the Stackdriver Trace tool in the
 Google Cloud Platform Console.
 The name may be a method name or some other per-call site name.
 For the same executable and the same call point, a best practice is
 to use a consistent name, which makes it easier to correlate
 cross-trace spans.
      string name = 3;
      Specified by:
      getName in interface TraceSpanOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the span. Must be less than 128 bytes. The span name is sanitized
 and displayed in the Stackdriver Trace tool in the
 Google Cloud Platform Console.
 The name may be a method name or some other per-call site name.
 For the same executable and the same call point, a best practice is
 to use a consistent name, which makes it easier to correlate
 cross-trace spans.
      string name = 3;
      Specified by:
      getNameBytes in interface TraceSpanOrBuilder
      Returns:
      The bytes for name.

    • setName

      public TraceSpan.Builder setName(String value)
       Name of the span. Must be less than 128 bytes. The span name is sanitized
 and displayed in the Stackdriver Trace tool in the
 Google Cloud Platform Console.
 The name may be a method name or some other per-call site name.
 For the same executable and the same call point, a best practice is
 to use a consistent name, which makes it easier to correlate
 cross-trace spans.
      string name = 3;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public TraceSpan.Builder clearName()
       Name of the span. Must be less than 128 bytes. The span name is sanitized
 and displayed in the Stackdriver Trace tool in the
 Google Cloud Platform Console.
 The name may be a method name or some other per-call site name.
 For the same executable and the same call point, a best practice is
 to use a consistent name, which makes it easier to correlate
 cross-trace spans.
      string name = 3;
      Returns:
      This builder for chaining.

    • setNameBytes

      public TraceSpan.Builder setNameBytes(com.google.protobuf.ByteString value)
       Name of the span. Must be less than 128 bytes. The span name is sanitized
 and displayed in the Stackdriver Trace tool in the
 Google Cloud Platform Console.
 The name may be a method name or some other per-call site name.
 For the same executable and the same call point, a best practice is
 to use a consistent name, which makes it easier to correlate
 cross-trace spans.
      string name = 3;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • hasStartTime

      public boolean hasStartTime()
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;
      Specified by:
      hasStartTime in interface TraceSpanOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;
      Specified by:
      getStartTime in interface TraceSpanOrBuilder
      Returns:
      The startTime.

    • setStartTime

      public TraceSpan.Builder setStartTime(com.google.protobuf.Timestamp value)
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;

    • setStartTime

      public TraceSpan.Builder setStartTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;

    • mergeStartTime

      public TraceSpan.Builder mergeStartTime(com.google.protobuf.Timestamp value)
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;

    • clearStartTime

      public TraceSpan.Builder clearStartTime()
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;

    • getStartTimeBuilder

      public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Start time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp start_time = 4;
      Specified by:
      getStartTimeOrBuilder in interface TraceSpanOrBuilder

    • hasEndTime

      public boolean hasEndTime()
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;
      Specified by:
      hasEndTime in interface TraceSpanOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;
      Specified by:
      getEndTime in interface TraceSpanOrBuilder
      Returns:
      The endTime.

    • setEndTime

      public TraceSpan.Builder setEndTime(com.google.protobuf.Timestamp value)
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;

    • setEndTime

      public TraceSpan.Builder setEndTime(com.google.protobuf.Timestamp.Builder builderForValue)
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;

    • mergeEndTime

      public TraceSpan.Builder mergeEndTime(com.google.protobuf.Timestamp value)
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;

    • clearEndTime

      public TraceSpan.Builder clearEndTime()
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;

    • getEndTimeBuilder

      public com.google.protobuf.Timestamp.Builder getEndTimeBuilder()
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;

    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       End time of the span in nanoseconds from the UNIX epoch.
      .google.protobuf.Timestamp end_time = 5;
      Specified by:
      getEndTimeOrBuilder in interface TraceSpanOrBuilder

    • getParentSpanId

      public long getParentSpanId()
       Optional. ID of the parent span, if any.
      fixed64 parent_span_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParentSpanId in interface TraceSpanOrBuilder
      Returns:
      The parentSpanId.

    • setParentSpanId

      public TraceSpan.Builder setParentSpanId(long value)
       Optional. ID of the parent span, if any.
      fixed64 parent_span_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The parentSpanId to set.
      Returns:
      This builder for chaining.

    • clearParentSpanId

      public TraceSpan.Builder clearParentSpanId()
       Optional. ID of the parent span, if any.
      fixed64 parent_span_id = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: TraceSpanOrBuilder
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;
      Specified by:
      getLabelsCount in interface TraceSpanOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;
      Specified by:
      containsLabels in interface TraceSpanOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface TraceSpanOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;
      Specified by:
      getLabelsMap in interface TraceSpanOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;
      Specified by:
      getLabelsOrDefault in interface TraceSpanOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;
      Specified by:
      getLabelsOrThrow in interface TraceSpanOrBuilder

    • clearLabels

      public TraceSpan.Builder clearLabels()

    • removeLabels

      public TraceSpan.Builder removeLabels(String key)
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      public TraceSpan.Builder putLabels(String key, String value)
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;

    • putAllLabels

      public TraceSpan.Builder putAllLabels(Map<String,String> values)
       Collection of labels associated with the span. Label keys must be less than
 128 bytes. Label values must be less than 16 kilobytes (10MB for
 `/stacktrace` values).

 Some predefined label keys exist, or you may create your own. When creating
 your own, we recommend the following formats:

 * `/category/product/key` for agents of well-known products (e.g.
 `/db/mongodb/read_size`).
 * `short_host/path/key` for domain-specific keys (e.g.
 `foo.com/myproduct/bar`)

 Predefined labels include:

 *   `/agent`
 *   `/component`
 *   `/error/message`
 *   `/error/name`
 *   `/http/client_city`
 *   `/http/client_country`
 *   `/http/client_protocol`
 *   `/http/client_region`
 *   `/http/host`
 *   `/http/method`
 *   `/http/path`
 *   `/http/redirected_url`
 *   `/http/request/size`
 *   `/http/response/size`
 *   `/http/route`
 *   `/http/status_code`
 *   `/http/url`
 *   `/http/user_agent`
 *   `/pid`
 *   `/stacktrace`
 *   `/tid`
      map<string, string> labels = 7;