Class Span.Builder (2.53.0)

Version 2.53.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.7
• 2.2.0
• 2.1.13

public static final class Span.Builder extends GeneratedMessageV3.Builder<Span.Builder> implements SpanOrBuilder

A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations.

A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous. There might be gaps or overlaps between spans in a trace.

Protobuf type google.devtools.cloudtrace.v2.Span

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Span.Builder

Implements

SpanOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Span.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Span build()

Returns
Type	Description
Span

buildPartial()

public Span buildPartial()

Returns
Type	Description
Span

clear()

public Span.Builder clear()

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAttributes()

public Span.Builder clearAttributes()

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
Type	Description
Span.Builder

clearChildSpanCount()

public Span.Builder clearChildSpanCount()

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
Type	Description
Span.Builder

clearDisplayName()

public Span.Builder clearDisplayName()

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
Type	Description
Span.Builder

clearEndTime()

public Span.Builder clearEndTime()

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
Type	Description
Span.Builder

clearField(Descriptors.FieldDescriptor field)

public Span.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLinks()

public Span.Builder clearLinks()

Links associated with the span. You can have up to 128 links per Span.

.google.devtools.cloudtrace.v2.Span.Links links = 10;

Returns
Type	Description
Span.Builder

clearName()

public Span.Builder clearName()

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
Type	Description
Span.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Span.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParentSpanId()

public Span.Builder clearParentSpanId()

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
Type	Description
Span.Builder	This builder for chaining.

clearSameProcessAsParentSpan()

public Span.Builder clearSameProcessAsParentSpan()

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
Type	Description
Span.Builder

clearSpanId()

public Span.Builder clearSpanId()

Required. The [SPAN_ID] portion of the span's resource name.

string span_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Span.Builder	This builder for chaining.

clearSpanKind()

public Span.Builder clearSpanKind()

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
Type	Description
Span.Builder	This builder for chaining.

clearStackTrace()

public Span.Builder clearStackTrace()

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Returns
Type	Description
Span.Builder

clearStartTime()

public Span.Builder clearStartTime()

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
Type	Description
Span.Builder

clearStatus()

public Span.Builder clearStatus()

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Span.Builder

clearTimeEvents()

public Span.Builder clearTimeEvents()

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
Type	Description
Span.Builder

clone()

public Span.Builder clone()

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAttributes()

public 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
Type	Description
Span.Attributes	The attributes.

getAttributesBuilder()

public Span.Attributes.Builder getAttributesBuilder()

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
Type	Description
Span.Attributes.Builder

getAttributesOrBuilder()

public 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;

Returns
Type	Description
Span.AttributesOrBuilder

getChildSpanCount()

public 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
Type	Description
Int32Value	The childSpanCount.

getChildSpanCountBuilder()

public Int32Value.Builder getChildSpanCountBuilder()

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
Type	Description
Builder

getChildSpanCountOrBuilder()

public 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];

Returns
Type	Description
Int32ValueOrBuilder

getDefaultInstanceForType()

public Span getDefaultInstanceForType()

Returns
Type	Description
Span

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public 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
Type	Description
TruncatableString	The displayName.

getDisplayNameBuilder()

public TruncatableString.Builder getDisplayNameBuilder()

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
Type	Description
TruncatableString.Builder

getDisplayNameOrBuilder()

public 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];

Returns
Type	Description
TruncatableStringOrBuilder

getEndTime()

public 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
Type	Description
Timestamp	The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Type	Description
Builder

getEndTimeOrBuilder()

public 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];

Returns
Type	Description
TimestampOrBuilder

getLinks()

public 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
Type	Description
Span.Links	The links.

getLinksBuilder()

public Span.Links.Builder getLinksBuilder()

Links associated with the span. You can have up to 128 links per Span.

.google.devtools.cloudtrace.v2.Span.Links links = 10;

Returns
Type	Description
Span.Links.Builder

getLinksOrBuilder()

public 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;

Returns
Type	Description
Span.LinksOrBuilder

getName()

public 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
Type	Description
String	The name.

getNameBytes()

public 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
Type	Description
ByteString	The bytes for name.

getParentSpanId()

public 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
Type	Description
String	The parentSpanId.

getParentSpanIdBytes()

public 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
Type	Description
ByteString	The bytes for parentSpanId.

getSameProcessAsParentSpan()

public 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
Type	Description
BoolValue	The sameProcessAsParentSpan.

getSameProcessAsParentSpanBuilder()

public BoolValue.Builder getSameProcessAsParentSpanBuilder()

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
Type	Description
Builder

getSameProcessAsParentSpanOrBuilder()

public 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];

Returns
Type	Description
BoolValueOrBuilder

getSpanId()

public String getSpanId()

Required. The [SPAN_ID] portion of the span's resource name.

string span_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The spanId.

getSpanIdBytes()

public ByteString getSpanIdBytes()

Required. The [SPAN_ID] portion of the span's resource name.

string span_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for spanId.

getSpanKind()

public 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
Type	Description
Span.SpanKind	The spanKind.

getSpanKindValue()

public 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
Type	Description
int	The enum numeric value on the wire for spanKind.

getStackTrace()

public StackTrace getStackTrace()

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Returns
Type	Description
StackTrace	The stackTrace.

getStackTraceBuilder()

public StackTrace.Builder getStackTraceBuilder()

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Returns
Type	Description
StackTrace.Builder

getStackTraceOrBuilder()

public StackTraceOrBuilder getStackTraceOrBuilder()

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Returns
Type	Description
StackTraceOrBuilder

getStartTime()

public 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
Type	Description
Timestamp	The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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
Type	Description
Builder

getStartTimeOrBuilder()

public 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];

Returns
Type	Description
TimestampOrBuilder

getStatus()

public Status getStatus()

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.rpc.Status	The status.

getStatusBuilder()

public Status.Builder getStatusBuilder()

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.rpc.Status.Builder

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
com.google.rpc.StatusOrBuilder

getTimeEvents()

public 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
Type	Description
Span.TimeEvents	The timeEvents.

getTimeEventsBuilder()

public Span.TimeEvents.Builder getTimeEventsBuilder()

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
Type	Description
Span.TimeEvents.Builder

getTimeEventsOrBuilder()

public 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;

Returns
Type	Description
Span.TimeEventsOrBuilder

hasAttributes()

public 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
Type	Description
boolean	Whether the attributes field is set.

hasChildSpanCount()

public 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
Type	Description
boolean	Whether the childSpanCount field is set.

hasDisplayName()

public 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
Type	Description
boolean	Whether the displayName field is set.

hasEndTime()

public 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
Type	Description
boolean	Whether the endTime field is set.

hasLinks()

public 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
Type	Description
boolean	Whether the links field is set.

hasSameProcessAsParentSpan()

public 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
Type	Description
boolean	Whether the sameProcessAsParentSpan field is set.

hasStackTrace()

public boolean hasStackTrace()

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Returns
Type	Description
boolean	Whether the stackTrace field is set.

hasStartTime()

public 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
Type	Description
boolean	Whether the startTime field is set.

hasStatus()

public boolean hasStatus()

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the status field is set.

hasTimeEvents()

public 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
Type	Description
boolean	Whether the timeEvents field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAttributes(Span.Attributes value)

public Span.Builder mergeAttributes(Span.Attributes value)

A set of attributes on the span. You can have up to 32 attributes per span.

.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;

Parameter
Name	Description
value	Span.Attributes

Returns
Type	Description
Span.Builder

mergeChildSpanCount(Int32Value value)

public Span.Builder mergeChildSpanCount(Int32Value value)

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];

Parameter
Name	Description
value	Int32Value

Returns
Type	Description
Span.Builder

mergeDisplayName(TruncatableString value)

public Span.Builder mergeDisplayName(TruncatableString value)

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];

Parameter
Name	Description
value	TruncatableString

Returns
Type	Description
Span.Builder

mergeEndTime(Timestamp value)

public Span.Builder mergeEndTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Span.Builder

mergeFrom(Span other)

public Span.Builder mergeFrom(Span other)

Parameter
Name	Description
other	Span

Returns
Type	Description
Span.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Span.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Span.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Span.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Span.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeLinks(Span.Links value)

public Span.Builder mergeLinks(Span.Links value)

Links associated with the span. You can have up to 128 links per Span.

.google.devtools.cloudtrace.v2.Span.Links links = 10;

Parameter
Name	Description
value	Span.Links

Returns
Type	Description
Span.Builder

mergeSameProcessAsParentSpan(BoolValue value)

public Span.Builder mergeSameProcessAsParentSpan(BoolValue value)

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];

Parameter
Name	Description
value	BoolValue

Returns
Type	Description
Span.Builder

mergeStackTrace(StackTrace value)

public Span.Builder mergeStackTrace(StackTrace value)

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Parameter
Name	Description
value	StackTrace

Returns
Type	Description
Span.Builder

mergeStartTime(Timestamp value)

public Span.Builder mergeStartTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Span.Builder

mergeStatus(Status value)

public Span.Builder mergeStatus(Status value)

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	com.google.rpc.Status

Returns
Type	Description
Span.Builder

mergeTimeEvents(Span.TimeEvents value)

public Span.Builder mergeTimeEvents(Span.TimeEvents value)

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;

Parameter
Name	Description
value	Span.TimeEvents

Returns
Type	Description
Span.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Span.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAttributes(Span.Attributes value)

public Span.Builder setAttributes(Span.Attributes value)

A set of attributes on the span. You can have up to 32 attributes per span.

.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;

Parameter
Name	Description
value	Span.Attributes

Returns
Type	Description
Span.Builder

setAttributes(Span.Attributes.Builder builderForValue)

public Span.Builder setAttributes(Span.Attributes.Builder builderForValue)

A set of attributes on the span. You can have up to 32 attributes per span.

.google.devtools.cloudtrace.v2.Span.Attributes attributes = 7;

Parameter
Name	Description
builderForValue	Span.Attributes.Builder

Returns
Type	Description
Span.Builder

setChildSpanCount(Int32Value value)

public Span.Builder setChildSpanCount(Int32Value value)

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];

Parameter
Name	Description
value	Int32Value

Returns
Type	Description
Span.Builder

setChildSpanCount(Int32Value.Builder builderForValue)

public Span.Builder setChildSpanCount(Int32Value.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Span.Builder

setDisplayName(TruncatableString value)

public Span.Builder setDisplayName(TruncatableString value)

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];

Parameter
Name	Description
value	TruncatableString

Returns
Type	Description
Span.Builder

setDisplayName(TruncatableString.Builder builderForValue)

public Span.Builder setDisplayName(TruncatableString.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	TruncatableString.Builder

Returns
Type	Description
Span.Builder

setEndTime(Timestamp value)

public Span.Builder setEndTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Span.Builder

setEndTime(Timestamp.Builder builderForValue)

public Span.Builder setEndTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Span.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Span.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLinks(Span.Links value)

public Span.Builder setLinks(Span.Links value)

Links associated with the span. You can have up to 128 links per Span.

.google.devtools.cloudtrace.v2.Span.Links links = 10;

Parameter
Name	Description
value	Span.Links

Returns
Type	Description
Span.Builder

setLinks(Span.Links.Builder builderForValue)

public Span.Builder setLinks(Span.Links.Builder builderForValue)

Links associated with the span. You can have up to 128 links per Span.

.google.devtools.cloudtrace.v2.Span.Links links = 10;

Parameter
Name	Description
builderForValue	Span.Links.Builder

Returns
Type	Description
Span.Builder

setName(String value)

public Span.Builder setName(String value)

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];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Span.Builder setNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setParentSpanId(String value)

public Span.Builder setParentSpanId(String value)

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;

Parameter
Name	Description
value	String The parentSpanId to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setParentSpanIdBytes(ByteString value)

public Span.Builder setParentSpanIdBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for parentSpanId to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Span.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSameProcessAsParentSpan(BoolValue value)

public Span.Builder setSameProcessAsParentSpan(BoolValue value)

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];

Parameter
Name	Description
value	BoolValue

Returns
Type	Description
Span.Builder

setSameProcessAsParentSpan(BoolValue.Builder builderForValue)

public Span.Builder setSameProcessAsParentSpan(BoolValue.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Span.Builder

setSpanId(String value)

public Span.Builder setSpanId(String value)

Required. The [SPAN_ID] portion of the span's resource name.

string span_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The spanId to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setSpanIdBytes(ByteString value)

public Span.Builder setSpanIdBytes(ByteString value)

Required. The [SPAN_ID] portion of the span's resource name.

string span_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for spanId to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setSpanKind(Span.SpanKind value)

public Span.Builder setSpanKind(Span.SpanKind value)

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];

Parameter
Name	Description
value	Span.SpanKind The spanKind to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setSpanKindValue(int value)

public Span.Builder setSpanKindValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for spanKind to set.

Returns
Type	Description
Span.Builder	This builder for chaining.

setStackTrace(StackTrace value)

public Span.Builder setStackTrace(StackTrace value)

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Parameter
Name	Description
value	StackTrace

Returns
Type	Description
Span.Builder

setStackTrace(StackTrace.Builder builderForValue)

public Span.Builder setStackTrace(StackTrace.Builder builderForValue)

Stack trace captured at the start of the span.

.google.devtools.cloudtrace.v2.StackTrace stack_trace = 8;

Parameter
Name	Description
builderForValue	StackTrace.Builder

Returns
Type	Description
Span.Builder

setStartTime(Timestamp value)

public Span.Builder setStartTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Span.Builder

setStartTime(Timestamp.Builder builderForValue)

public Span.Builder setStartTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Span.Builder

setStatus(Status value)

public Span.Builder setStatus(Status value)

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	com.google.rpc.Status

Returns
Type	Description
Span.Builder

setStatus(Status.Builder builderForValue)

public Span.Builder setStatus(Status.Builder builderForValue)

Optional. The final status for this span.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	com.google.rpc.Status.Builder

Returns
Type	Description
Span.Builder

setTimeEvents(Span.TimeEvents value)

public Span.Builder setTimeEvents(Span.TimeEvents value)

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;

Parameter
Name	Description
value	Span.TimeEvents

Returns
Type	Description
Span.Builder

setTimeEvents(Span.TimeEvents.Builder builderForValue)

public Span.Builder setTimeEvents(Span.TimeEvents.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Span.TimeEvents.Builder

Returns
Type	Description
Span.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Span.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Span.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)