Package com.google.cloud.discoveryengine.v1beta

Class Answer

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.Answer
All Implemented Interfaces:
AnswerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Answer extends com.google.protobuf.GeneratedMessage implements AnswerOrBuilder
 Defines an answer.
Protobuf type google.cloud.discoveryengine.v1beta.Answer
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • ANSWER_TEXT_FIELD_NUMBER

      public static final int ANSWER_TEXT_FIELD_NUMBER
      See Also:

    • CITATIONS_FIELD_NUMBER

      public static final int CITATIONS_FIELD_NUMBER
      See Also:

    • REFERENCES_FIELD_NUMBER

      public static final int REFERENCES_FIELD_NUMBER
      See Also:

    • STEPS_FIELD_NUMBER

      public static final int STEPS_FIELD_NUMBER
      See Also:

    • QUERY_UNDERSTANDING_INFO_FIELD_NUMBER

      public static final int QUERY_UNDERSTANDING_INFO_FIELD_NUMBER
      See Also:

    • ANSWER_SKIPPED_REASONS_FIELD_NUMBER

      public static final int ANSWER_SKIPPED_REASONS_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • COMPLETE_TIME_FIELD_NUMBER

      public static final int COMPLETE_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface AnswerOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Immutable. Fully qualified name
 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNameBytes in interface AnswerOrBuilder
      Returns:
      The bytes for name.

    • getStateValue

      public int getStateValue()
       The state of the answer generation.
      .google.cloud.discoveryengine.v1beta.Answer.State state = 2;
      Specified by:
      getStateValue in interface AnswerOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Answer.State getState()
       The state of the answer generation.
      .google.cloud.discoveryengine.v1beta.Answer.State state = 2;
      Specified by:
      getState in interface AnswerOrBuilder
      Returns:
      The state.

    • getAnswerText

      public String getAnswerText()
       The textual answer.
      string answer_text = 3;
      Specified by:
      getAnswerText in interface AnswerOrBuilder
      Returns:
      The answerText.

    • getAnswerTextBytes

      public com.google.protobuf.ByteString getAnswerTextBytes()
       The textual answer.
      string answer_text = 3;
      Specified by:
      getAnswerTextBytes in interface AnswerOrBuilder
      Returns:
      The bytes for answerText.

    • getCitationsList

      public List<Answer.Citation> getCitationsList()
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;
      Specified by:
      getCitationsList in interface AnswerOrBuilder

    • getCitationsOrBuilderList

      public List<? extends Answer.CitationOrBuilder> getCitationsOrBuilderList()
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;
      Specified by:
      getCitationsOrBuilderList in interface AnswerOrBuilder

    • getCitationsCount

      public int getCitationsCount()
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;
      Specified by:
      getCitationsCount in interface AnswerOrBuilder

    • getCitations

      public Answer.Citation getCitations(int index)
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;
      Specified by:
      getCitations in interface AnswerOrBuilder

    • getCitationsOrBuilder

      public Answer.CitationOrBuilder getCitationsOrBuilder(int index)
       Citations.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Citation citations = 4;
      Specified by:
      getCitationsOrBuilder in interface AnswerOrBuilder

    • getReferencesList

      public List<Answer.Reference> getReferencesList()
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;
      Specified by:
      getReferencesList in interface AnswerOrBuilder

    • getReferencesOrBuilderList

      public List<? extends Answer.ReferenceOrBuilder> getReferencesOrBuilderList()
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;
      Specified by:
      getReferencesOrBuilderList in interface AnswerOrBuilder

    • getReferencesCount

      public int getReferencesCount()
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;
      Specified by:
      getReferencesCount in interface AnswerOrBuilder

    • getReferences

      public Answer.Reference getReferences(int index)
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;
      Specified by:
      getReferences in interface AnswerOrBuilder

    • getReferencesOrBuilder

      public Answer.ReferenceOrBuilder getReferencesOrBuilder(int index)
       References.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Reference references = 5;
      Specified by:
      getReferencesOrBuilder in interface AnswerOrBuilder

    • getRelatedQuestionsList

      public com.google.protobuf.ProtocolStringList getRelatedQuestionsList()
       Suggested related questions.
      repeated string related_questions = 6;
      Specified by:
      getRelatedQuestionsList in interface AnswerOrBuilder
      Returns:
      A list containing the relatedQuestions.

    • getRelatedQuestionsCount

      public int getRelatedQuestionsCount()
       Suggested related questions.
      repeated string related_questions = 6;
      Specified by:
      getRelatedQuestionsCount in interface AnswerOrBuilder
      Returns:
      The count of relatedQuestions.

    • getRelatedQuestions

      public String getRelatedQuestions(int index)
       Suggested related questions.
      repeated string related_questions = 6;
      Specified by:
      getRelatedQuestions in interface AnswerOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The relatedQuestions at the given index.

    • getRelatedQuestionsBytes

      public com.google.protobuf.ByteString getRelatedQuestionsBytes(int index)
       Suggested related questions.
      repeated string related_questions = 6;
      Specified by:
      getRelatedQuestionsBytes in interface AnswerOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the relatedQuestions at the given index.

    • getStepsList

      public List<Answer.Step> getStepsList()
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;
      Specified by:
      getStepsList in interface AnswerOrBuilder

    • getStepsOrBuilderList

      public List<? extends Answer.StepOrBuilder> getStepsOrBuilderList()
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;
      Specified by:
      getStepsOrBuilderList in interface AnswerOrBuilder

    • getStepsCount

      public int getStepsCount()
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;
      Specified by:
      getStepsCount in interface AnswerOrBuilder

    • getSteps

      public Answer.Step getSteps(int index)
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;
      Specified by:
      getSteps in interface AnswerOrBuilder

    • getStepsOrBuilder

      public Answer.StepOrBuilder getStepsOrBuilder(int index)
       Answer generation steps.
      repeated .google.cloud.discoveryengine.v1beta.Answer.Step steps = 7;
      Specified by:
      getStepsOrBuilder in interface AnswerOrBuilder

    • hasQueryUnderstandingInfo

      public boolean hasQueryUnderstandingInfo()
       Query understanding information.
      .google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;
      Specified by:
      hasQueryUnderstandingInfo in interface AnswerOrBuilder
      Returns:
      Whether the queryUnderstandingInfo field is set.

    • getQueryUnderstandingInfo

      public Answer.QueryUnderstandingInfo getQueryUnderstandingInfo()
       Query understanding information.
      .google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;
      Specified by:
      getQueryUnderstandingInfo in interface AnswerOrBuilder
      Returns:
      The queryUnderstandingInfo.

    • getQueryUnderstandingInfoOrBuilder

      public Answer.QueryUnderstandingInfoOrBuilder getQueryUnderstandingInfoOrBuilder()
       Query understanding information.
      .google.cloud.discoveryengine.v1beta.Answer.QueryUnderstandingInfo query_understanding_info = 10;
      Specified by:
      getQueryUnderstandingInfoOrBuilder in interface AnswerOrBuilder

    • 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;
      Specified by:
      getAnswerSkippedReasonsList in interface AnswerOrBuilder
      Returns:
      A list containing the answerSkippedReasons.

    • 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;
      Specified by:
      getAnswerSkippedReasonsCount in interface AnswerOrBuilder
      Returns:
      The count of answerSkippedReasons.

    • getAnswerSkippedReasons

      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;
      Specified by:
      getAnswerSkippedReasons in interface AnswerOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The 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;
      Specified by:
      getAnswerSkippedReasonsValueList in interface AnswerOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for answerSkippedReasons.

    • getAnswerSkippedReasonsValue

      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;
      Specified by:
      getAnswerSkippedReasonsValue in interface AnswerOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of answerSkippedReasons at the given index.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Answer creation timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface AnswerOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Answer creation timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface AnswerOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Answer creation timestamp.
      .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface AnswerOrBuilder

    • hasCompleteTime

      public boolean hasCompleteTime()
       Output only. Answer completed timestamp.
      .google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCompleteTime in interface AnswerOrBuilder
      Returns:
      Whether the completeTime field is set.

    • getCompleteTime

      public com.google.protobuf.Timestamp getCompleteTime()
       Output only. Answer completed timestamp.
      .google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCompleteTime in interface AnswerOrBuilder
      Returns:
      The completeTime.

    • getCompleteTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCompleteTimeOrBuilder()
       Output only. Answer completed timestamp.
      .google.protobuf.Timestamp complete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCompleteTimeOrBuilder in interface AnswerOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Answer parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Answer parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Answer parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Answer parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Answer parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Answer parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Answer parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Answer parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Answer parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Answer parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Answer parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Answer parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Answer.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Answer.Builder newBuilder()

    • newBuilder

      public static Answer.Builder newBuilder(Answer prototype)

    • toBuilder

      public Answer.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Answer.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Answer getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Answer> parser()

    • getParserForType

      public com.google.protobuf.Parser<Answer> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Answer getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder