Class Suggestion (4.36.0)

public final class Suggestion extends GeneratedMessageV3 implements SuggestionOrBuilder

Represents a suggestion for a human agent.

Protobuf type google.cloud.dialogflow.v2beta1.Suggestion

Implements

SuggestionOrBuilder

Static Fields

ARTICLES_FIELD_NUMBER

public static final int ARTICLES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

FAQ_ANSWERS_FIELD_NUMBER

public static final int FAQ_ANSWERS_FIELD_NUMBER
Field Value
Type Description
int

LATEST_MESSAGE_FIELD_NUMBER

public static final int LATEST_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Suggestion getDefaultInstance()
Returns
Type Description
Suggestion

getDescriptor()

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

newBuilder()

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

newBuilder(Suggestion prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getArticles(int index)

public Suggestion.Article getArticles(int index)

Output only. Articles ordered by score in descending order.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.Article articles = 2;

Parameter
Name Description
index int
Returns
Type Description
Suggestion.Article

getArticlesCount()

public int getArticlesCount()

Output only. Articles ordered by score in descending order.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.Article articles = 2;

Returns
Type Description
int

getArticlesList()

public List<Suggestion.Article> getArticlesList()

Output only. Articles ordered by score in descending order.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.Article articles = 2;

Returns
Type Description
List<Article>

getArticlesOrBuilder(int index)

public Suggestion.ArticleOrBuilder getArticlesOrBuilder(int index)

Output only. Articles ordered by score in descending order.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.Article articles = 2;

Parameter
Name Description
index int
Returns
Type Description
Suggestion.ArticleOrBuilder

getArticlesOrBuilderList()

public List<? extends Suggestion.ArticleOrBuilder> getArticlesOrBuilderList()

Output only. Articles ordered by score in descending order.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.Article articles = 2;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Suggestion.ArticleOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the suggestion was created.

.google.protobuf.Timestamp create_time = 5;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the suggestion was created.

.google.protobuf.Timestamp create_time = 5;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Suggestion getDefaultInstanceForType()
Returns
Type Description
Suggestion

getFaqAnswers(int index)

public Suggestion.FaqAnswer getFaqAnswers(int index)

Output only. Answers extracted from FAQ documents.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.FaqAnswer faq_answers = 4;

Parameter
Name Description
index int
Returns
Type Description
Suggestion.FaqAnswer

getFaqAnswersCount()

public int getFaqAnswersCount()

Output only. Answers extracted from FAQ documents.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.FaqAnswer faq_answers = 4;

Returns
Type Description
int

getFaqAnswersList()

public List<Suggestion.FaqAnswer> getFaqAnswersList()

Output only. Answers extracted from FAQ documents.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.FaqAnswer faq_answers = 4;

Returns
Type Description
List<FaqAnswer>

getFaqAnswersOrBuilder(int index)

public Suggestion.FaqAnswerOrBuilder getFaqAnswersOrBuilder(int index)

Output only. Answers extracted from FAQ documents.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.FaqAnswer faq_answers = 4;

Parameter
Name Description
index int
Returns
Type Description
Suggestion.FaqAnswerOrBuilder

getFaqAnswersOrBuilderList()

public List<? extends Suggestion.FaqAnswerOrBuilder> getFaqAnswersOrBuilderList()

Output only. Answers extracted from FAQ documents.

repeated .google.cloud.dialogflow.v2beta1.Suggestion.FaqAnswer faq_answers = 4;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Suggestion.FaqAnswerOrBuilder>

getLatestMessage()

public String getLatestMessage()

Output only. Latest message used as context to compile this suggestion.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 7;

Returns
Type Description
String

The latestMessage.

getLatestMessageBytes()

public ByteString getLatestMessageBytes()

Output only. Latest message used as context to compile this suggestion.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 7;

Returns
Type Description
ByteString

The bytes for latestMessage.

getName()

public String getName()

Output only. The name of this suggestion. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/*/suggestions/<Suggestion ID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of this suggestion. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/*/suggestions/<Suggestion ID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the suggestion was created.

.google.protobuf.Timestamp create_time = 5;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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