Class TraceBlock (0.102.0)

public final class TraceBlock extends GeneratedMessage implements TraceBlockOrBuilder

The trace block tracks a sequence of actions taken by the agent in a flow or a playbook.

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

Implements

TraceBlockOrBuilder

Static Fields

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

COMPLETE_TIME_FIELD_NUMBER

public static final int COMPLETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

END_STATE_FIELD_NUMBER

public static final int END_STATE_FIELD_NUMBER
Field Value
Type Description
int

FLOW_TRACE_METADATA_FIELD_NUMBER

public static final int FLOW_TRACE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

INPUT_PARAMETERS_FIELD_NUMBER

public static final int INPUT_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_PARAMETERS_FIELD_NUMBER

public static final int OUTPUT_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

PLAYBOOK_TRACE_METADATA_FIELD_NUMBER

public static final int PLAYBOOK_TRACE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

SPEECH_PROCESSING_METADATA_FIELD_NUMBER

public static final int SPEECH_PROCESSING_METADATA_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TraceBlock getDefaultInstance()
Returns
Type Description
TraceBlock

getDescriptor()

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

newBuilder()

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

newBuilder(TraceBlock prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getActions(int index)

public Action getActions(int index)

The actions performed by the agent and the user during this session.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 3;

Parameter
Name Description
index int
Returns
Type Description
Action

getActionsCount()

public int getActionsCount()

The actions performed by the agent and the user during this session.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 3;

Returns
Type Description
int

getActionsList()

public List<Action> getActionsList()

The actions performed by the agent and the user during this session.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 3;

Returns
Type Description
List<Action>

getActionsOrBuilder(int index)

public ActionOrBuilder getActionsOrBuilder(int index)

The actions performed by the agent and the user during this session.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 3;

Parameter
Name Description
index int
Returns
Type Description
ActionOrBuilder

getActionsOrBuilderList()

public List<? extends ActionOrBuilder> getActionsOrBuilderList()

The actions performed by the agent and the user during this session.

repeated .google.cloud.dialogflow.cx.v3beta1.Action actions = 3;

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

getCompleteTime()

public Timestamp getCompleteTime()

Output only. Timestamp of the end of the trace block.

.google.protobuf.Timestamp complete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The completeTime.

getCompleteTimeOrBuilder()

public TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Timestamp of the end of the trace block.

.google.protobuf.Timestamp complete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public TraceBlock getDefaultInstanceForType()
Returns
Type Description
TraceBlock

getEndState()

public OutputState getEndState()

Optional. Output only. The end state of the trace block.

.google.cloud.dialogflow.cx.v3beta1.OutputState end_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputState

The endState.

getEndStateValue()

public int getEndStateValue()

Optional. Output only. The end state of the trace block.

.google.cloud.dialogflow.cx.v3beta1.OutputState end_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for endState.

getFlowTraceMetadata()

public FlowTraceMetadata getFlowTraceMetadata()

Metadata of the flow trace.

.google.cloud.dialogflow.cx.v3beta1.FlowTraceMetadata flow_trace_metadata = 2;

Returns
Type Description
FlowTraceMetadata

The flowTraceMetadata.

getFlowTraceMetadataOrBuilder()

public FlowTraceMetadataOrBuilder getFlowTraceMetadataOrBuilder()

Metadata of the flow trace.

.google.cloud.dialogflow.cx.v3beta1.FlowTraceMetadata flow_trace_metadata = 2;

Returns
Type Description
FlowTraceMetadataOrBuilder

getInputParameters()

public Struct getInputParameters()

Optional. A list of input parameters of the trace block.

.google.protobuf.Struct input_parameters = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The inputParameters.

getInputParametersOrBuilder()

public StructOrBuilder getInputParametersOrBuilder()

Optional. A list of input parameters of the trace block.

.google.protobuf.Struct input_parameters = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getOutputParameters()

public Struct getOutputParameters()

Optional. A list of output parameters of the trace block.

.google.protobuf.Struct output_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The outputParameters.

getOutputParametersOrBuilder()

public StructOrBuilder getOutputParametersOrBuilder()

Optional. A list of output parameters of the trace block.

.google.protobuf.Struct output_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getParserForType()

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

getPlaybookTraceMetadata()

public PlaybookTraceMetadata getPlaybookTraceMetadata()

Metadata of the playbook trace.

.google.cloud.dialogflow.cx.v3beta1.PlaybookTraceMetadata playbook_trace_metadata = 1;

Returns
Type Description
PlaybookTraceMetadata

The playbookTraceMetadata.

getPlaybookTraceMetadataOrBuilder()

public PlaybookTraceMetadataOrBuilder getPlaybookTraceMetadataOrBuilder()

Metadata of the playbook trace.

.google.cloud.dialogflow.cx.v3beta1.PlaybookTraceMetadata playbook_trace_metadata = 1;

Returns
Type Description
PlaybookTraceMetadataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpeechProcessingMetadata()

public SpeechProcessingMetadata getSpeechProcessingMetadata()

Metadata of the speech-to-text and speech-to-text processing.

.google.cloud.dialogflow.cx.v3beta1.SpeechProcessingMetadata speech_processing_metadata = 8;

Returns
Type Description
SpeechProcessingMetadata

The speechProcessingMetadata.

getSpeechProcessingMetadataOrBuilder()

public SpeechProcessingMetadataOrBuilder getSpeechProcessingMetadataOrBuilder()

Metadata of the speech-to-text and speech-to-text processing.

.google.cloud.dialogflow.cx.v3beta1.SpeechProcessingMetadata speech_processing_metadata = 8;

Returns
Type Description
SpeechProcessingMetadataOrBuilder

getStartTime()

public Timestamp getStartTime()

Output only. Timestamp of the start of the trace block.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Timestamp of the start of the trace block.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getTraceMetadataCase()

public TraceBlock.TraceMetadataCase getTraceMetadataCase()
Returns
Type Description
TraceBlock.TraceMetadataCase

hasCompleteTime()

public boolean hasCompleteTime()

Output only. Timestamp of the end of the trace block.

.google.protobuf.Timestamp complete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the completeTime field is set.

hasFlowTraceMetadata()

public boolean hasFlowTraceMetadata()

Metadata of the flow trace.

.google.cloud.dialogflow.cx.v3beta1.FlowTraceMetadata flow_trace_metadata = 2;

Returns
Type Description
boolean

Whether the flowTraceMetadata field is set.

hasInputParameters()

public boolean hasInputParameters()

Optional. A list of input parameters of the trace block.

.google.protobuf.Struct input_parameters = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inputParameters field is set.

hasOutputParameters()

public boolean hasOutputParameters()

Optional. A list of output parameters of the trace block.

.google.protobuf.Struct output_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the outputParameters field is set.

hasPlaybookTraceMetadata()

public boolean hasPlaybookTraceMetadata()

Metadata of the playbook trace.

.google.cloud.dialogflow.cx.v3beta1.PlaybookTraceMetadata playbook_trace_metadata = 1;

Returns
Type Description
boolean

Whether the playbookTraceMetadata field is set.

hasSpeechProcessingMetadata()

public boolean hasSpeechProcessingMetadata()

Metadata of the speech-to-text and speech-to-text processing.

.google.cloud.dialogflow.cx.v3beta1.SpeechProcessingMetadata speech_processing_metadata = 8;

Returns
Type Description
boolean

Whether the speechProcessingMetadata field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Timestamp of the start of the trace block.

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected TraceBlock.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TraceBlock.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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