Class Span (0.89.0)

public final class Span extends GeneratedMessageV3 implements SpanOrBuilder

A span represents a sub execution step of an action.

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

Implements

SpanOrBuilder

Static Fields

COMPLETE_TIME_FIELD_NUMBER

public static final int COMPLETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Span getDefaultInstance()
Returns
Type Description
Span

getDescriptor()

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

newBuilder()

public static Span.Builder newBuilder()
Returns
Type Description
Span.Builder

newBuilder(Span prototype)

public static Span.Builder newBuilder(Span prototype)
Parameter
Name Description
prototype Span
Returns
Type Description
Span.Builder

parseDelimitedFrom(InputStream input)

public static Span parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Span
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Span parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Span
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Span parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Span
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Span parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Span
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Span parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Span
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Span parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Span
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Span parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Span
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Span parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Span
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Span parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Span
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Span parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Span
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Span parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Span
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Span parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Span
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Span> parser()
Returns
Type Description
Parser<Span>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCompleteTime()

public Timestamp getCompleteTime()

Timestamp of the completion of the span.

.google.protobuf.Timestamp complete_time = 5;

Returns
Type Description
Timestamp

The completeTime.

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

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

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.

getParserForType()

public Parser<Span> getParserForType()
Returns
Type Description
Parser<Span>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Timestamp of the start of the span.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Timestamp

The startTime.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Span.Builder newBuilderForType()
Returns
Type Description
Span.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Span.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Span.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Span.Builder toBuilder()
Returns
Type Description
Span.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException