Class Answer.Builder (0.51.0)

public static final class Answer.Builder extends GeneratedMessageV3.Builder<Answer.Builder> implements AnswerOrBuilder

Defines an answer.

Protobuf type google.cloud.discoveryengine.v1beta.Answer

Implements

AnswerOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllAnswerSkippedReasons(Iterable<? extends Answer.AnswerSkippedReason> values)

public Answer.Builder addAllAnswerSkippedReasons(Iterable<? extends Answer.AnswerSkippedReason> values)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason>

The answerSkippedReasons to add.

Returns
Type Description
Answer.Builder

This builder for chaining.

addAllAnswerSkippedReasonsValue(Iterable<Integer> values)

public Answer.Builder addAllAnswerSkippedReasonsValue(Iterable<Integer> values)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for answerSkippedReasons to add.

Returns
Type Description
Answer.Builder

This builder for chaining.

addAllCitations(Iterable<? extends Answer.Citation> values)

public Answer.Builder addAllCitations(Iterable<? extends Answer.Citation> values)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1beta.Answer.Citation>
Returns
Type Description
Answer.Builder

addAllReferences(Iterable<? extends Answer.Reference> values)

public Answer.Builder addAllReferences(Iterable<? extends Answer.Reference> values)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1beta.Answer.Reference>
Returns
Type Description
Answer.Builder

addAllRelatedQuestions(Iterable<String> values)

public Answer.Builder addAllRelatedQuestions(Iterable<String> values)

Suggested related questions.

repeated string related_questions = 6;

Parameter
Name Description
values Iterable<String>

The relatedQuestions to add.

Returns
Type Description
Answer.Builder

This builder for chaining.

addAllSteps(Iterable<? extends Answer.Step> values)

public Answer.Builder addAllSteps(Iterable<? extends Answer.Step> values)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1beta.Answer.Step>
Returns
Type Description
Answer.Builder

addAnswerSkippedReasons(Answer.AnswerSkippedReason value)

public Answer.Builder addAnswerSkippedReasons(Answer.AnswerSkippedReason value)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameter
Name Description
value Answer.AnswerSkippedReason

The answerSkippedReasons to add.

Returns
Type Description
Answer.Builder

This builder for chaining.

addAnswerSkippedReasonsValue(int value)

public Answer.Builder addAnswerSkippedReasonsValue(int value)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameter
Name Description
value int

The enum numeric value on the wire for answerSkippedReasons to add.

Returns
Type Description
Answer.Builder

This builder for chaining.

addCitations(Answer.Citation value)

public Answer.Builder addCitations(Answer.Citation value)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
value Answer.Citation
Returns
Type Description
Answer.Builder

addCitations(Answer.Citation.Builder builderForValue)

public Answer.Builder addCitations(Answer.Citation.Builder builderForValue)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
builderForValue Answer.Citation.Builder
Returns
Type Description
Answer.Builder

addCitations(int index, Answer.Citation value)

public Answer.Builder addCitations(int index, Answer.Citation value)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameters
Name Description
index int
value Answer.Citation
Returns
Type Description
Answer.Builder

addCitations(int index, Answer.Citation.Builder builderForValue)

public Answer.Builder addCitations(int index, Answer.Citation.Builder builderForValue)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameters
Name Description
index int
builderForValue Answer.Citation.Builder
Returns
Type Description
Answer.Builder

addCitationsBuilder()

public Answer.Citation.Builder addCitationsBuilder()

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Returns
Type Description
Answer.Citation.Builder

addCitationsBuilder(int index)

public Answer.Citation.Builder addCitationsBuilder(int index)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
index int
Returns
Type Description
Answer.Citation.Builder

addReferences(Answer.Reference value)

public Answer.Builder addReferences(Answer.Reference value)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
value Answer.Reference
Returns
Type Description
Answer.Builder

addReferences(Answer.Reference.Builder builderForValue)

public Answer.Builder addReferences(Answer.Reference.Builder builderForValue)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
builderForValue Answer.Reference.Builder
Returns
Type Description
Answer.Builder

addReferences(int index, Answer.Reference value)

public Answer.Builder addReferences(int index, Answer.Reference value)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameters
Name Description
index int
value Answer.Reference
Returns
Type Description
Answer.Builder

addReferences(int index, Answer.Reference.Builder builderForValue)

public Answer.Builder addReferences(int index, Answer.Reference.Builder builderForValue)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameters
Name Description
index int
builderForValue Answer.Reference.Builder
Returns
Type Description
Answer.Builder

addReferencesBuilder()

public Answer.Reference.Builder addReferencesBuilder()

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Returns
Type Description
Answer.Reference.Builder

addReferencesBuilder(int index)

public Answer.Reference.Builder addReferencesBuilder(int index)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
index int
Returns
Type Description
Answer.Reference.Builder

addRelatedQuestions(String value)

public Answer.Builder addRelatedQuestions(String value)

Suggested related questions.

repeated string related_questions = 6;

Parameter
Name Description
value String

The relatedQuestions to add.

Returns
Type Description
Answer.Builder

This builder for chaining.

addRelatedQuestionsBytes(ByteString value)

public Answer.Builder addRelatedQuestionsBytes(ByteString value)

Suggested related questions.

repeated string related_questions = 6;

Parameter
Name Description
value ByteString

The bytes of the relatedQuestions to add.

Returns
Type Description
Answer.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSteps(Answer.Step value)

public Answer.Builder addSteps(Answer.Step value)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
value Answer.Step
Returns
Type Description
Answer.Builder

addSteps(Answer.Step.Builder builderForValue)

public Answer.Builder addSteps(Answer.Step.Builder builderForValue)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
builderForValue Answer.Step.Builder
Returns
Type Description
Answer.Builder

addSteps(int index, Answer.Step value)

public Answer.Builder addSteps(int index, Answer.Step value)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameters
Name Description
index int
value Answer.Step
Returns
Type Description
Answer.Builder

addSteps(int index, Answer.Step.Builder builderForValue)

public Answer.Builder addSteps(int index, Answer.Step.Builder builderForValue)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameters
Name Description
index int
builderForValue Answer.Step.Builder
Returns
Type Description
Answer.Builder

addStepsBuilder()

public Answer.Step.Builder addStepsBuilder()

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Returns
Type Description
Answer.Step.Builder

addStepsBuilder(int index)

public Answer.Step.Builder addStepsBuilder(int index)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Builder

build()

public Answer build()
Returns
Type Description
Answer

buildPartial()

public Answer buildPartial()
Returns
Type Description
Answer

clear()

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

clearAnswerSkippedReasons()

public Answer.Builder clearAnswerSkippedReasons()

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Returns
Type Description
Answer.Builder

This builder for chaining.

clearAnswerText()

public Answer.Builder clearAnswerText()

The textual answer.

string answer_text = 3;

Returns
Type Description
Answer.Builder

This builder for chaining.

clearCitations()

public Answer.Builder clearCitations()

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Returns
Type Description
Answer.Builder

clearCompleteTime()

public Answer.Builder clearCompleteTime()

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Answer.Builder

clearCreateTime()

public Answer.Builder clearCreateTime()

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Answer.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public Answer.Builder clearName()

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Answer.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQueryUnderstandingInfo()

public Answer.Builder clearQueryUnderstandingInfo()

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Returns
Type Description
Answer.Builder

clearReferences()

public Answer.Builder clearReferences()

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Returns
Type Description
Answer.Builder

clearRelatedQuestions()

public Answer.Builder clearRelatedQuestions()

Suggested related questions.

repeated string related_questions = 6;

Returns
Type Description
Answer.Builder

This builder for chaining.

clearState()

public Answer.Builder clearState()

The state of the answer generation.

.google.cloud.discoveryengine.v1beta.Answer.State state = 2;

Returns
Type Description
Answer.Builder

This builder for chaining.

clearSteps()

public Answer.Builder clearSteps()

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Returns
Type Description
Answer.Builder

clone()

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

getAnswerSkippedReasons(int index)

public Answer.AnswerSkippedReason getAnswerSkippedReasons(int index)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Answer.AnswerSkippedReason

The answerSkippedReasons at the given index.

getAnswerSkippedReasonsCount()

public int getAnswerSkippedReasonsCount()

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Returns
Type Description
int

The count of answerSkippedReasons.

getAnswerSkippedReasonsList()

public List<Answer.AnswerSkippedReason> getAnswerSkippedReasonsList()

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Returns
Type Description
List<AnswerSkippedReason>

A list containing the answerSkippedReasons.

getAnswerSkippedReasonsValue(int index)

public int getAnswerSkippedReasonsValue(int index)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of answerSkippedReasons at the given index.

getAnswerSkippedReasonsValueList()

public List<Integer> getAnswerSkippedReasonsValueList()

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for answerSkippedReasons.

getAnswerText()

public String getAnswerText()

The textual answer.

string answer_text = 3;

Returns
Type Description
String

The answerText.

getAnswerTextBytes()

public ByteString getAnswerTextBytes()

The textual answer.

string answer_text = 3;

Returns
Type Description
ByteString

The bytes for answerText.

getCitations(int index)

public Answer.Citation getCitations(int index)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
index int
Returns
Type Description
Answer.Citation

getCitationsBuilder(int index)

public Answer.Citation.Builder getCitationsBuilder(int index)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
index int
Returns
Type Description
Answer.Citation.Builder

getCitationsBuilderList()

public List<Answer.Citation.Builder> getCitationsBuilderList()

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Returns
Type Description
List<Builder>

getCitationsCount()

public int getCitationsCount()

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Returns
Type Description
int

getCitationsList()

public List<Answer.Citation> getCitationsList()

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Returns
Type Description
List<Citation>

getCitationsOrBuilder(int index)

public Answer.CitationOrBuilder getCitationsOrBuilder(int index)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
index int
Returns
Type Description
Answer.CitationOrBuilder

getCitationsOrBuilderList()

public List<? extends Answer.CitationOrBuilder> getCitationsOrBuilderList()

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.Answer.CitationOrBuilder>

getCompleteTime()

public Timestamp getCompleteTime()

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The completeTime.

getCompleteTimeBuilder()

public Timestamp.Builder getCompleteTimeBuilder()

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCompleteTimeOrBuilder()

public TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Answer getDefaultInstanceForType()
Returns
Type Description
Answer

getDescriptorForType()

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

getName()

public String getName()

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getQueryUnderstandingInfo()

public Answer.QueryUnderstandingInfo getQueryUnderstandingInfo()

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Returns
Type Description
Answer.QueryUnderstandingInfo

The queryUnderstandingInfo.

getQueryUnderstandingInfoBuilder()

public Answer.QueryUnderstandingInfo.Builder getQueryUnderstandingInfoBuilder()

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Returns
Type Description
Answer.QueryUnderstandingInfo.Builder

getQueryUnderstandingInfoOrBuilder()

public Answer.QueryUnderstandingInfoOrBuilder getQueryUnderstandingInfoOrBuilder()

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Returns
Type Description
Answer.QueryUnderstandingInfoOrBuilder

getReferences(int index)

public Answer.Reference getReferences(int index)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
index int
Returns
Type Description
Answer.Reference

getReferencesBuilder(int index)

public Answer.Reference.Builder getReferencesBuilder(int index)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
index int
Returns
Type Description
Answer.Reference.Builder

getReferencesBuilderList()

public List<Answer.Reference.Builder> getReferencesBuilderList()

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Returns
Type Description
List<Builder>

getReferencesCount()

public int getReferencesCount()

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Returns
Type Description
int

getReferencesList()

public List<Answer.Reference> getReferencesList()

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Returns
Type Description
List<Reference>

getReferencesOrBuilder(int index)

public Answer.ReferenceOrBuilder getReferencesOrBuilder(int index)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
index int
Returns
Type Description
Answer.ReferenceOrBuilder

getReferencesOrBuilderList()

public List<? extends Answer.ReferenceOrBuilder> getReferencesOrBuilderList()

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.Answer.ReferenceOrBuilder>

getRelatedQuestions(int index)

public String getRelatedQuestions(int index)

Suggested related questions.

repeated string related_questions = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The relatedQuestions at the given index.

getRelatedQuestionsBytes(int index)

public ByteString getRelatedQuestionsBytes(int index)

Suggested related questions.

repeated string related_questions = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the relatedQuestions at the given index.

getRelatedQuestionsCount()

public int getRelatedQuestionsCount()

Suggested related questions.

repeated string related_questions = 6;

Returns
Type Description
int

The count of relatedQuestions.

getRelatedQuestionsList()

public ProtocolStringList getRelatedQuestionsList()

Suggested related questions.

repeated string related_questions = 6;

Returns
Type Description
ProtocolStringList

A list containing the relatedQuestions.

getState()

public Answer.State getState()

The state of the answer generation.

.google.cloud.discoveryengine.v1beta.Answer.State state = 2;

Returns
Type Description
Answer.State

The state.

getStateValue()

public int getStateValue()

The state of the answer generation.

.google.cloud.discoveryengine.v1beta.Answer.State state = 2;

Returns
Type Description
int

The enum numeric value on the wire for state.

getSteps(int index)

public Answer.Step getSteps(int index)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
index int
Returns
Type Description
Answer.Step

getStepsBuilder(int index)

public Answer.Step.Builder getStepsBuilder(int index)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Builder

getStepsBuilderList()

public List<Answer.Step.Builder> getStepsBuilderList()

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Returns
Type Description
List<Builder>

getStepsCount()

public int getStepsCount()

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Returns
Type Description
int

getStepsList()

public List<Answer.Step> getStepsList()

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Returns
Type Description
List<Step>

getStepsOrBuilder(int index)

public Answer.StepOrBuilder getStepsOrBuilder(int index)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
index int
Returns
Type Description
Answer.StepOrBuilder

getStepsOrBuilderList()

public List<? extends Answer.StepOrBuilder> getStepsOrBuilderList()

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.Answer.StepOrBuilder>

hasCompleteTime()

public boolean hasCompleteTime()

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the completeTime field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasQueryUnderstandingInfo()

public boolean hasQueryUnderstandingInfo()

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Returns
Type Description
boolean

Whether the queryUnderstandingInfo field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompleteTime(Timestamp value)

public Answer.Builder mergeCompleteTime(Timestamp value)

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Answer.Builder

mergeCreateTime(Timestamp value)

public Answer.Builder mergeCreateTime(Timestamp value)

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Answer.Builder

mergeFrom(Answer other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)

public Answer.Builder mergeQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Parameter
Name Description
value Answer.QueryUnderstandingInfo
Returns
Type Description
Answer.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeCitations(int index)

public Answer.Builder removeCitations(int index)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameter
Name Description
index int
Returns
Type Description
Answer.Builder

removeReferences(int index)

public Answer.Builder removeReferences(int index)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameter
Name Description
index int
Returns
Type Description
Answer.Builder

removeSteps(int index)

public Answer.Builder removeSteps(int index)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameter
Name Description
index int
Returns
Type Description
Answer.Builder

setAnswerSkippedReasons(int index, Answer.AnswerSkippedReason value)

public Answer.Builder setAnswerSkippedReasons(int index, Answer.AnswerSkippedReason value)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameters
Name Description
index int

The index to set the value at.

value Answer.AnswerSkippedReason

The answerSkippedReasons to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setAnswerSkippedReasonsValue(int index, int value)

public Answer.Builder setAnswerSkippedReasonsValue(int index, int value)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

repeated .google.cloud.discoveryengine.v1beta.Answer.AnswerSkippedReason answer_skipped_reasons = 11;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for answerSkippedReasons to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setAnswerText(String value)

public Answer.Builder setAnswerText(String value)

The textual answer.

string answer_text = 3;

Parameter
Name Description
value String

The answerText to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setAnswerTextBytes(ByteString value)

public Answer.Builder setAnswerTextBytes(ByteString value)

The textual answer.

string answer_text = 3;

Parameter
Name Description
value ByteString

The bytes for answerText to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setCitations(int index, Answer.Citation value)

public Answer.Builder setCitations(int index, Answer.Citation value)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameters
Name Description
index int
value Answer.Citation
Returns
Type Description
Answer.Builder

setCitations(int index, Answer.Citation.Builder builderForValue)

public Answer.Builder setCitations(int index, Answer.Citation.Builder builderForValue)

Citations.

repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;

Parameters
Name Description
index int
builderForValue Answer.Citation.Builder
Returns
Type Description
Answer.Builder

setCompleteTime(Timestamp value)

public Answer.Builder setCompleteTime(Timestamp value)

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Answer.Builder

setCompleteTime(Timestamp.Builder builderForValue)

public Answer.Builder setCompleteTime(Timestamp.Builder builderForValue)

Output only. Answer completed timestamp.

.google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Answer.Builder

setCreateTime(Timestamp value)

public Answer.Builder setCreateTime(Timestamp value)

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Answer.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Answer.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Answer creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Answer.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public Answer.Builder setName(String value)

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Answer.Builder setNameBytes(ByteString value)

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)

public Answer.Builder setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo value)

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Parameter
Name Description
value Answer.QueryUnderstandingInfo
Returns
Type Description
Answer.Builder

setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo.Builder builderForValue)

public Answer.Builder setQueryUnderstandingInfo(Answer.QueryUnderstandingInfo.Builder builderForValue)

Query understanding information.

.google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;

Parameter
Name Description
builderForValue Answer.QueryUnderstandingInfo.Builder
Returns
Type Description
Answer.Builder

setReferences(int index, Answer.Reference value)

public Answer.Builder setReferences(int index, Answer.Reference value)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameters
Name Description
index int
value Answer.Reference
Returns
Type Description
Answer.Builder

setReferences(int index, Answer.Reference.Builder builderForValue)

public Answer.Builder setReferences(int index, Answer.Reference.Builder builderForValue)

References.

repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;

Parameters
Name Description
index int
builderForValue Answer.Reference.Builder
Returns
Type Description
Answer.Builder

setRelatedQuestions(int index, String value)

public Answer.Builder setRelatedQuestions(int index, String value)

Suggested related questions.

repeated string related_questions = 6;

Parameters
Name Description
index int

The index to set the value at.

value String

The relatedQuestions to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

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

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

setState(Answer.State value)

public Answer.Builder setState(Answer.State value)

The state of the answer generation.

.google.cloud.discoveryengine.v1beta.Answer.State state = 2;

Parameter
Name Description
value Answer.State

The state to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setStateValue(int value)

public Answer.Builder setStateValue(int value)

The state of the answer generation.

.google.cloud.discoveryengine.v1beta.Answer.State state = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Answer.Builder

This builder for chaining.

setSteps(int index, Answer.Step value)

public Answer.Builder setSteps(int index, Answer.Step value)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameters
Name Description
index int
value Answer.Step
Returns
Type Description
Answer.Builder

setSteps(int index, Answer.Step.Builder builderForValue)

public Answer.Builder setSteps(int index, Answer.Step.Builder builderForValue)

Answer generation steps.

repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;

Parameters
Name Description
index int
builderForValue Answer.Step.Builder
Returns
Type Description
Answer.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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