Class QueryInput (0.56.0)

public final class QueryInput extends GeneratedMessageV3 implements QueryInputOrBuilder

Represents the query input. It can contain one of:

  1. A conversational query in the form of text.

  2. An intent query that specifies which intent to trigger.

  3. Natural language speech audio to be processed.

  4. An event to be triggered.

  5. DTMF digits to invoke an intent and fill in parameter value.

  6. The results of a tool executed by the client.

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

Implements

QueryInputOrBuilder

Static Fields

AUDIO_FIELD_NUMBER

public static final int AUDIO_FIELD_NUMBER
Field Value
Type Description
int

DTMF_FIELD_NUMBER

public static final int DTMF_FIELD_NUMBER
Field Value
Type Description
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
Type Description
int

INTENT_FIELD_NUMBER

public static final int INTENT_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryInput getDefaultInstance()
Returns
Type Description
QueryInput

getDescriptor()

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

newBuilder()

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

newBuilder(QueryInput prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAudio()

public AudioInput getAudio()

The natural language speech audio to be processed.

.google.cloud.dialogflow.cx.v3.AudioInput audio = 5;

Returns
Type Description
AudioInput

The audio.

getAudioOrBuilder()

public AudioInputOrBuilder getAudioOrBuilder()

The natural language speech audio to be processed.

.google.cloud.dialogflow.cx.v3.AudioInput audio = 5;

Returns
Type Description
AudioInputOrBuilder

getDefaultInstanceForType()

public QueryInput getDefaultInstanceForType()
Returns
Type Description
QueryInput

getDtmf()

public DtmfInput getDtmf()

The DTMF event to be handled.

.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 7;

Returns
Type Description
DtmfInput

The dtmf.

getDtmfOrBuilder()

public DtmfInputOrBuilder getDtmfOrBuilder()

The DTMF event to be handled.

.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 7;

Returns
Type Description
DtmfInputOrBuilder

getEvent()

public EventInput getEvent()

The event to be triggered.

.google.cloud.dialogflow.cx.v3.EventInput event = 6;

Returns
Type Description
EventInput

The event.

getEventOrBuilder()

public EventInputOrBuilder getEventOrBuilder()

The event to be triggered.

.google.cloud.dialogflow.cx.v3.EventInput event = 6;

Returns
Type Description
EventInputOrBuilder

getInputCase()

public QueryInput.InputCase getInputCase()
Returns
Type Description
QueryInput.InputCase

getIntent()

public IntentInput getIntent()

The intent to be triggered.

.google.cloud.dialogflow.cx.v3.IntentInput intent = 3;

Returns
Type Description
IntentInput

The intent.

getIntentOrBuilder()

public IntentInputOrBuilder getIntentOrBuilder()

The intent to be triggered.

.google.cloud.dialogflow.cx.v3.IntentInput intent = 3;

Returns
Type Description
IntentInputOrBuilder

getLanguageCode()

public String getLanguageCode()

Required. The language of the input. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

string language_code = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Required. The language of the input. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

string language_code = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for languageCode.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getText()

public TextInput getText()

The natural language text to be processed.

.google.cloud.dialogflow.cx.v3.TextInput text = 2;

Returns
Type Description
TextInput

The text.

getTextOrBuilder()

public TextInputOrBuilder getTextOrBuilder()

The natural language text to be processed.

.google.cloud.dialogflow.cx.v3.TextInput text = 2;

Returns
Type Description
TextInputOrBuilder

hasAudio()

public boolean hasAudio()

The natural language speech audio to be processed.

.google.cloud.dialogflow.cx.v3.AudioInput audio = 5;

Returns
Type Description
boolean

Whether the audio field is set.

hasDtmf()

public boolean hasDtmf()

The DTMF event to be handled.

.google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 7;

Returns
Type Description
boolean

Whether the dtmf field is set.

hasEvent()

public boolean hasEvent()

The event to be triggered.

.google.cloud.dialogflow.cx.v3.EventInput event = 6;

Returns
Type Description
boolean

Whether the event field is set.

hasIntent()

public boolean hasIntent()

The intent to be triggered.

.google.cloud.dialogflow.cx.v3.IntentInput intent = 3;

Returns
Type Description
boolean

Whether the intent field is set.

hasText()

public boolean hasText()

The natural language text to be processed.

.google.cloud.dialogflow.cx.v3.TextInput text = 2;

Returns
Type Description
boolean

Whether the text 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 QueryInput.Builder newBuilderForType()
Returns
Type Description
QueryInput.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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