Class SuggestionInput (4.58.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
Type Description
int

INTENT_INPUT_FIELD_NUMBER

public static final int INTENT_INPUT_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_OVERRIDE_FIELD_NUMBER

public static final int TEXT_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SuggestionInput getDefaultInstance()
Returns
Type Description
SuggestionInput

getDescriptor()

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

newBuilder()

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

newBuilder(SuggestionInput prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for answerRecord.

getDefaultInstanceForType()

public SuggestionInput getDefaultInstanceForType()
Returns
Type Description
SuggestionInput

getIntentInput()

public IntentInput getIntentInput()

The intent to be triggered on V3 agent.

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

Returns
Type Description
IntentInput

The intentInput.

getIntentInputOrBuilder()

public IntentInputOrBuilder getIntentInputOrBuilder()

The intent to be triggered on V3 agent.

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

Returns
Type Description
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
Type Description
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
Type Description
StructOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
TextInputOrBuilder

hasIntentInput()

public boolean hasIntentInput()

The intent to be triggered on V3 agent.

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

Returns
Type Description
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
Type Description
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
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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