Class DetectIntentResponse.Builder (0.17.0) 

public static final class DetectIntentResponse.Builder extends GeneratedMessageV3.Builder<DetectIntentResponse.Builder> implements DetectIntentResponseOrBuilder

The message returned from the DetectIntent method.

Protobuf type google.cloud.dialogflow.cx.v3.DetectIntentResponse

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DetectIntentResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DetectIntentResponse.Builder
Overrides

build()

public DetectIntentResponse build()
Returns
Type Description
DetectIntentResponse

buildPartial()

public DetectIntentResponse buildPartial()
Returns
Type Description
DetectIntentResponse

clear()

public DetectIntentResponse.Builder clear()
Returns
Type Description
DetectIntentResponse.Builder
Overrides

clearAllowCancellation()

public DetectIntentResponse.Builder clearAllowCancellation()

Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.

bool allow_cancellation = 7;

Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DetectIntentResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DetectIntentResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DetectIntentResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DetectIntentResponse.Builder
Overrides

clearOutputAudio()

public DetectIntentResponse.Builder clearOutputAudio()

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.response_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

bytes output_audio = 4;

Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

clearOutputAudioConfig()

public DetectIntentResponse.Builder clearOutputAudioConfig()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Returns
Type Description
DetectIntentResponse.Builder

clearQueryResult()

public DetectIntentResponse.Builder clearQueryResult()

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Returns
Type Description
DetectIntentResponse.Builder

clearResponseId()

public DetectIntentResponse.Builder clearResponseId()

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

string response_id = 1;

Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

clearResponseType()

public DetectIntentResponse.Builder clearResponseType()

Response type.

.google.cloud.dialogflow.cx.v3.DetectIntentResponse.ResponseType response_type = 6;

Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

clone()

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

getAllowCancellation()

public boolean getAllowCancellation()

Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.

bool allow_cancellation = 7;

Returns
Type Description
boolean

The allowCancellation.

getDefaultInstanceForType()

public DetectIntentResponse getDefaultInstanceForType()
Returns
Type Description
DetectIntentResponse

getDescriptorForType()

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

getOutputAudio()

public ByteString getOutputAudio()

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.response_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

bytes output_audio = 4;

Returns
Type Description
ByteString

The outputAudio.

getOutputAudioConfig()

public OutputAudioConfig getOutputAudioConfig()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Returns
Type Description
OutputAudioConfig

The outputAudioConfig.

getOutputAudioConfigBuilder()

public OutputAudioConfig.Builder getOutputAudioConfigBuilder()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Returns
Type Description
OutputAudioConfig.Builder

getOutputAudioConfigOrBuilder()

public OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Returns
Type Description
OutputAudioConfigOrBuilder

getQueryResult()

public QueryResult getQueryResult()

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Returns
Type Description
QueryResult

The queryResult.

getQueryResultBuilder()

public QueryResult.Builder getQueryResultBuilder()

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Returns
Type Description
QueryResult.Builder

getQueryResultOrBuilder()

public QueryResultOrBuilder getQueryResultOrBuilder()

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Returns
Type Description
QueryResultOrBuilder

getResponseId()

public String getResponseId()

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

string response_id = 1;

Returns
Type Description
String

The responseId.

getResponseIdBytes()

public ByteString getResponseIdBytes()

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

string response_id = 1;

Returns
Type Description
ByteString

The bytes for responseId.

getResponseType()

public DetectIntentResponse.ResponseType getResponseType()

Response type.

.google.cloud.dialogflow.cx.v3.DetectIntentResponse.ResponseType response_type = 6;

Returns
Type Description
DetectIntentResponse.ResponseType

The responseType.

getResponseTypeValue()

public int getResponseTypeValue()

Response type.

.google.cloud.dialogflow.cx.v3.DetectIntentResponse.ResponseType response_type = 6;

Returns
Type Description
int

The enum numeric value on the wire for responseType.

hasOutputAudioConfig()

public boolean hasOutputAudioConfig()

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Returns
Type Description
boolean

Whether the outputAudioConfig field is set.

hasQueryResult()

public boolean hasQueryResult()

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Returns
Type Description
boolean

Whether the queryResult field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DetectIntentResponse other)

public DetectIntentResponse.Builder mergeFrom(DetectIntentResponse other)
Parameter
Name Description
other DetectIntentResponse
Returns
Type Description
DetectIntentResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DetectIntentResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DetectIntentResponse.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeOutputAudioConfig(OutputAudioConfig value)

public DetectIntentResponse.Builder mergeOutputAudioConfig(OutputAudioConfig value)

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Parameter
Name Description
value OutputAudioConfig
Returns
Type Description
DetectIntentResponse.Builder

mergeQueryResult(QueryResult value)

public DetectIntentResponse.Builder mergeQueryResult(QueryResult value)

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Parameter
Name Description
value QueryResult
Returns
Type Description
DetectIntentResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DetectIntentResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DetectIntentResponse.Builder
Overrides

setAllowCancellation(boolean value)

public DetectIntentResponse.Builder setAllowCancellation(boolean value)

Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.

bool allow_cancellation = 7;

Parameter
Name Description
value boolean

The allowCancellation to set.
Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DetectIntentResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DetectIntentResponse.Builder
Overrides

setOutputAudio(ByteString value)

public DetectIntentResponse.Builder setOutputAudio(ByteString value)

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the query_result.response_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

bytes output_audio = 4;

Parameter
Name Description
value ByteString

The outputAudio to set.
Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

setOutputAudioConfig(OutputAudioConfig value)

public DetectIntentResponse.Builder setOutputAudioConfig(OutputAudioConfig value)

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Parameter
Name Description
value OutputAudioConfig
Returns
Type Description
DetectIntentResponse.Builder

setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)

public DetectIntentResponse.Builder setOutputAudioConfig(OutputAudioConfig.Builder builderForValue)

The config used by the speech synthesizer to generate the output audio.

.google.cloud.dialogflow.cx.v3.OutputAudioConfig output_audio_config = 5;

Parameter
Name Description
builderForValue OutputAudioConfig.Builder
Returns
Type Description
DetectIntentResponse.Builder

setQueryResult(QueryResult value)

public DetectIntentResponse.Builder setQueryResult(QueryResult value)

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Parameter
Name Description
value QueryResult
Returns
Type Description
DetectIntentResponse.Builder

setQueryResult(QueryResult.Builder builderForValue)

public DetectIntentResponse.Builder setQueryResult(QueryResult.Builder builderForValue)

The result of the conversational query.

.google.cloud.dialogflow.cx.v3.QueryResult query_result = 2;

Parameter
Name Description
builderForValue QueryResult.Builder
Returns
Type Description
DetectIntentResponse.Builder

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

public DetectIntentResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DetectIntentResponse.Builder
Overrides

setResponseId(String value)

public DetectIntentResponse.Builder setResponseId(String value)

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

string response_id = 1;

Parameter
Name Description
value String

The responseId to set.
Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

setResponseIdBytes(ByteString value)

public DetectIntentResponse.Builder setResponseIdBytes(ByteString value)

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

string response_id = 1;

Parameter
Name Description
value ByteString

The bytes for responseId to set.
Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

setResponseType(DetectIntentResponse.ResponseType value)

public DetectIntentResponse.Builder setResponseType(DetectIntentResponse.ResponseType value)

Response type.

.google.cloud.dialogflow.cx.v3.DetectIntentResponse.ResponseType response_type = 6;

Parameter
Name Description
value DetectIntentResponse.ResponseType

The responseType to set.
Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

setResponseTypeValue(int value)

public DetectIntentResponse.Builder setResponseTypeValue(int value)

Response type.

.google.cloud.dialogflow.cx.v3.DetectIntentResponse.ResponseType response_type = 6;

Parameter
Name Description
value int

The enum numeric value on the wire for responseType to set.
Returns
Type Description
DetectIntentResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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