Package com.google.devtools.cloudtrace.v1

Interface TraceSpanOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsLabels​(String key)
      Collection of labels associated with the span.
      com.google.protobuf.Timestamp getEndTime()
      End time of the span in nanoseconds from the UNIX epoch.
      com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
      End time of the span in nanoseconds from the UNIX epoch.
      TraceSpan.SpanKind getKind()
      Distinguishes between spans generated in a particular context.
      int getKindValue()
      Distinguishes between spans generated in a particular context.
      Map<String,​String> getLabels()
      Deprecated.
      int getLabelsCount()
      Collection of labels associated with the span.
      Map<String,​String> getLabelsMap()
      Collection of labels associated with the span.
      String getLabelsOrDefault​(String key, String defaultValue)
      Collection of labels associated with the span.
      String getLabelsOrThrow​(String key)
      Collection of labels associated with the span.
      String getName()
      Name of the span.
      com.google.protobuf.ByteString getNameBytes()
      Name of the span.
      long getParentSpanId()
      Optional.
      long getSpanId()
      Identifier for the span.
      com.google.protobuf.Timestamp getStartTime()
      Start time of the span in nanoseconds from the UNIX epoch.
      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
      Start time of the span in nanoseconds from the UNIX epoch.
      boolean hasEndTime()
      End time of the span in nanoseconds from the UNIX epoch.
      boolean hasStartTime()
      Start time of the span in nanoseconds from the UNIX epoch.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getSpanId

        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;
        Returns:
        The spanId.

      • getKindValue

        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;
        Returns:
        The enum numeric value on the wire for kind.

      • getKind

        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;
        Returns:
        The kind.

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • hasStartTime

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

      • getStartTime

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

      • getStartTimeOrBuilder

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

      • hasEndTime

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

      • getEndTime

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

      • getEndTimeOrBuilder

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

      • getParentSpanId

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

      • getLabelsCount

        int getLabelsCount()
         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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;