Class SuggestionInput (4.46.0)

public final class SuggestionInput extends GeneratedMessageV3 implements SuggestionInputOrBuilder

Represents the selection of a suggestion.

Protobuf type google.cloud.dialogflow.v2beta1.SuggestionInput

Static Fields

ANSWER_RECORD_FIELD_NUMBER

public static final int ANSWER_RECORD_FIELD_NUMBER
Field Value
TypeDescription
int

INTENT_INPUT_FIELD_NUMBER

public static final int INTENT_INPUT_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_OVERRIDE_FIELD_NUMBER

public static final int TEXT_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SuggestionInput getDefaultInstance()
Returns
TypeDescription
SuggestionInput

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SuggestionInput.Builder newBuilder()
Returns
TypeDescription
SuggestionInput.Builder

newBuilder(SuggestionInput prototype)

public static SuggestionInput.Builder newBuilder(SuggestionInput prototype)
Parameter
NameDescription
prototypeSuggestionInput
Returns
TypeDescription
SuggestionInput.Builder

parseDelimitedFrom(InputStream input)

public static SuggestionInput parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestionInput parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SuggestionInput parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SuggestionInput parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SuggestionInput parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SuggestionInput parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SuggestionInput parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestionInput parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SuggestionInput parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestionInput parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SuggestionInput parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SuggestionInput parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SuggestionInput
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SuggestionInput> parser()
Returns
TypeDescription
Parser<SuggestionInput>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnswerRecord()

public String getAnswerRecord()

Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID> where <Answer Record ID> is an alphanumeric string.

string answer_record = 1;

Returns
TypeDescription
String

The answerRecord.

getAnswerRecordBytes()

public ByteString getAnswerRecordBytes()

Required. The ID of a suggestion selected by the human agent. The suggestion(s) were generated in a previous call to request Dialogflow assist. The format is: projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID> where <Answer Record ID> is an alphanumeric string.

string answer_record = 1;

Returns
TypeDescription
ByteString

The bytes for answerRecord.

getDefaultInstanceForType()

public SuggestionInput getDefaultInstanceForType()
Returns
TypeDescription
SuggestionInput

getIntentInput()

public IntentInput getIntentInput()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
TypeDescription
IntentInput

The intentInput.

getIntentInputOrBuilder()

public IntentInputOrBuilder getIntentInputOrBuilder()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
TypeDescription
IntentInputOrBuilder

getParameters()

public Struct getParameters()

In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 4;

Returns
TypeDescription
Struct

The parameters.

getParametersOrBuilder()

public StructOrBuilder getParametersOrBuilder()

In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 4;

Returns
TypeDescription
StructOrBuilder

getParserForType()

public Parser<SuggestionInput> getParserForType()
Returns
TypeDescription
Parser<SuggestionInput>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTextOverride()

public TextInput getTextOverride()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
TypeDescription
TextInput

The textOverride.

getTextOverrideOrBuilder()

public TextInputOrBuilder getTextOverrideOrBuilder()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
TypeDescription
TextInputOrBuilder

hasIntentInput()

public boolean hasIntentInput()

The intent to be triggered on V3 agent.

.google.cloud.dialogflow.v2beta1.IntentInput intent_input = 6;

Returns
TypeDescription
boolean

Whether the intentInput field is set.

hasParameters()

public boolean hasParameters()

In Dialogflow assist for v3, the user can submit a form by sending a SuggestionInput. The form is uniquely determined by the answer_record field, which identifies a v3 QueryResult containing the current page. The form parameters are specified via the parameters field.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

  • MapKey type: string
  • MapKey value: parameter name
  • MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 4;

Returns
TypeDescription
boolean

Whether the parameters field is set.

hasTextOverride()

public boolean hasTextOverride()

Optional. If the customer edited the suggestion before using it, include the revised text here.

.google.cloud.dialogflow.v2beta1.TextInput text_override = 2;

Returns
TypeDescription
boolean

Whether the textOverride field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SuggestionInput.Builder newBuilderForType()
Returns
TypeDescription
SuggestionInput.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SuggestionInput.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SuggestionInput.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SuggestionInput.Builder toBuilder()
Returns
TypeDescription
SuggestionInput.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException