Class Span.Builder (0.89.0)

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

A span represents a sub execution step of an action.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Span

Implements

SpanOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllMetrics(Iterable<? extends NamedMetric> values)

public Span.Builder addAllMetrics(Iterable<? extends NamedMetric> values)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.NamedMetric>
Returns
Type Description
Span.Builder

addAllTags(Iterable<String> values)

public Span.Builder addAllTags(Iterable<String> values)

The metadata tags of the span such as span type.

repeated string tags = 2;

Parameter
Name Description
values Iterable<String>

The tags to add.

Returns
Type Description
Span.Builder

This builder for chaining.

addMetrics(NamedMetric value)

public Span.Builder addMetrics(NamedMetric value)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
value NamedMetric
Returns
Type Description
Span.Builder

addMetrics(NamedMetric.Builder builderForValue)

public Span.Builder addMetrics(NamedMetric.Builder builderForValue)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
builderForValue NamedMetric.Builder
Returns
Type Description
Span.Builder

addMetrics(int index, NamedMetric value)

public Span.Builder addMetrics(int index, NamedMetric value)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameters
Name Description
index int
value NamedMetric
Returns
Type Description
Span.Builder

addMetrics(int index, NamedMetric.Builder builderForValue)

public Span.Builder addMetrics(int index, NamedMetric.Builder builderForValue)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameters
Name Description
index int
builderForValue NamedMetric.Builder
Returns
Type Description
Span.Builder

addMetricsBuilder()

public NamedMetric.Builder addMetricsBuilder()

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Returns
Type Description
NamedMetric.Builder

addMetricsBuilder(int index)

public NamedMetric.Builder addMetricsBuilder(int index)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
index int
Returns
Type Description
NamedMetric.Builder

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

addTags(String value)

public Span.Builder addTags(String value)

The metadata tags of the span such as span type.

repeated string tags = 2;

Parameter
Name Description
value String

The tags to add.

Returns
Type Description
Span.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public Span.Builder addTagsBytes(ByteString value)

The metadata tags of the span such as span type.

repeated string tags = 2;

Parameter
Name Description
value ByteString

The bytes of the tags to add.

Returns
Type Description
Span.Builder

This builder for chaining.

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

clearCompleteTime()

public Span.Builder clearCompleteTime()

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

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

clearMetrics()

public Span.Builder clearMetrics()

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Returns
Type Description
Span.Builder

clearName()

public Span.Builder clearName()

The name of the span.

string name = 1;

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

clearStartTime()

public Span.Builder clearStartTime()

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Span.Builder

clearTags()

public Span.Builder clearTags()

The metadata tags of the span such as span type.

repeated string tags = 2;

Returns
Type Description
Span.Builder

This builder for chaining.

clone()

public Span.Builder clone()
Returns
Type Description
Span.Builder
Overrides

getCompleteTime()

public Timestamp getCompleteTime()

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

Returns
Type Description
Timestamp

The completeTime.

getCompleteTimeBuilder()

public Timestamp.Builder getCompleteTimeBuilder()

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

Returns
Type Description
Builder

getCompleteTimeOrBuilder()

public TimestampOrBuilder getCompleteTimeOrBuilder()

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Span getDefaultInstanceForType()
Returns
Type Description
Span

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetrics(int index)

public NamedMetric getMetrics(int index)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
index int
Returns
Type Description
NamedMetric

getMetricsBuilder(int index)

public NamedMetric.Builder getMetricsBuilder(int index)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
index int
Returns
Type Description
NamedMetric.Builder

getMetricsBuilderList()

public List<NamedMetric.Builder> getMetricsBuilderList()

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Returns
Type Description
List<Builder>

getMetricsCount()

public int getMetricsCount()

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Returns
Type Description
int

getMetricsList()

public List<NamedMetric> getMetricsList()

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Returns
Type Description
List<NamedMetric>

getMetricsOrBuilder(int index)

public NamedMetricOrBuilder getMetricsOrBuilder(int index)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
index int
Returns
Type Description
NamedMetricOrBuilder

getMetricsOrBuilderList()

public List<? extends NamedMetricOrBuilder> getMetricsOrBuilderList()

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.NamedMetricOrBuilder>

getName()

public String getName()

The name of the span.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the span.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getStartTime()

public Timestamp getStartTime()

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
TimestampOrBuilder

getTags(int index)

public String getTags(int index)

The metadata tags of the span such as span type.

repeated string tags = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

The metadata tags of the span such as span type.

repeated string tags = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

The metadata tags of the span such as span type.

repeated string tags = 2;

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

The metadata tags of the span such as span type.

repeated string tags = 2;

Returns
Type Description
ProtocolStringList

A list containing the tags.

hasCompleteTime()

public boolean hasCompleteTime()

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

Returns
Type Description
boolean

Whether the completeTime field is set.

hasStartTime()

public boolean hasStartTime()

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompleteTime(Timestamp value)

public Span.Builder mergeCompleteTime(Timestamp value)

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Span.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Span.Builder
Overrides

mergeStartTime(Timestamp value)

public Span.Builder mergeStartTime(Timestamp value)

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Parameter
Name Description
value Timestamp
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

removeMetrics(int index)

public Span.Builder removeMetrics(int index)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameter
Name Description
index int
Returns
Type Description
Span.Builder

setCompleteTime(Timestamp value)

public Span.Builder setCompleteTime(Timestamp value)

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

Parameter
Name Description
value Timestamp
Returns
Type Description
Span.Builder

setCompleteTime(Timestamp.Builder builderForValue)

public Span.Builder setCompleteTime(Timestamp.Builder builderForValue)

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

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

setMetrics(int index, NamedMetric value)

public Span.Builder setMetrics(int index, NamedMetric value)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameters
Name Description
index int
value NamedMetric
Returns
Type Description
Span.Builder

setMetrics(int index, NamedMetric.Builder builderForValue)

public Span.Builder setMetrics(int index, NamedMetric.Builder builderForValue)

The unordered collection of metrics in this span.

repeated .google.cloud.dialogflow.cx.v3beta1.NamedMetric metrics = 3;

Parameters
Name Description
index int
builderForValue NamedMetric.Builder
Returns
Type Description
Span.Builder

setName(String value)

public Span.Builder setName(String value)

The name of the span.

string name = 1;

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)

The name of the span.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name 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

setStartTime(Timestamp value)

public Span.Builder setStartTime(Timestamp value)

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
Span.Builder

setStartTime(Timestamp.Builder builderForValue)

public Span.Builder setStartTime(Timestamp.Builder builderForValue)

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Span.Builder

setTags(int index, String value)

public Span.Builder setTags(int index, String value)

The metadata tags of the span such as span type.

repeated string tags = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The tags to set.

Returns
Type Description
Span.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Span.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Span.Builder
Overrides