com.google.devtools.cloudtrace.v1

Interface TraceSpanOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

TraceSpan, TraceSpan.Builder

public interface TraceSpanOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) Collection of labels associated with the span.
Timestamp	getEndTime() End time of the span in nanoseconds from the UNIX epoch.
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.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Collection of labels associated with the span.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Collection of labels associated with the span.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Collection of labels associated with the span.
java.lang.String	getLabelsOrThrow(java.lang.String key) Collection of labels associated with the span.
java.lang.String	getName() Name of the span.
ByteString	getNameBytes() Name of the span.
long	getParentSpanId() ID of the parent span, if any.
long	getSpanId() Identifier for the span.
Timestamp	getStartTime() Start time of the span in nanoseconds from the UNIX epoch.
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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSpanId

long getSpanId()

 Identifier for the span. Must be a 64-bit integer other than 0 and
 unique within a trace.
 

fixed64 span_id = 1;

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;

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;

getName

java.lang.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
 {% dynamic print site_values.console_name %}.
 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;

getNameBytes

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
 {% dynamic print site_values.console_name %}.
 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;

hasStartTime

boolean hasStartTime()

 Start time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp start_time = 4;

getStartTime

Timestamp getStartTime()

 Start time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp start_time = 4;

getStartTimeOrBuilder

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;

getEndTime

Timestamp getEndTime()

 End time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp end_time = 5;

getEndTimeOrBuilder

TimestampOrBuilder getEndTimeOrBuilder()

 End time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp end_time = 5;

getParentSpanId

long getParentSpanId()

 ID of the parent span, if any. Optional.
 

fixed64 parent_span_id = 6;

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(java.lang.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;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.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

java.lang.String getLabelsOrDefault(java.lang.String key,
                                    java.lang.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

java.lang.String getLabelsOrThrow(java.lang.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;