Package com.google.cloud.discoveryengine.v1beta

Class SearchResponse.Summary

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.SearchResponse.Summary
All Implemented Interfaces:
SearchResponse.SummaryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
SearchResponse
public static final class SearchResponse.Summary extends com.google.protobuf.GeneratedMessage implements SearchResponse.SummaryOrBuilder
 Summary of the top N search results specified by the summary spec.
Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.Summary
See Also:

  • Field Details

    • SUMMARY_TEXT_FIELD_NUMBER

      public static final int SUMMARY_TEXT_FIELD_NUMBER
      See Also:

    • SUMMARY_SKIPPED_REASONS_FIELD_NUMBER

      public static final int SUMMARY_SKIPPED_REASONS_FIELD_NUMBER
      See Also:

    • SAFETY_ATTRIBUTES_FIELD_NUMBER

      public static final int SAFETY_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • SUMMARY_WITH_METADATA_FIELD_NUMBER

      public static final int SUMMARY_WITH_METADATA_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

    • getSummaryText

      public String getSummaryText()
       The summary content.
      string summary_text = 1;
      Specified by:
      getSummaryText in interface SearchResponse.SummaryOrBuilder
      Returns:
      The summaryText.

    • getSummaryTextBytes

      public com.google.protobuf.ByteString getSummaryTextBytes()
       The summary content.
      string summary_text = 1;
      Specified by:
      getSummaryTextBytes in interface SearchResponse.SummaryOrBuilder
      Returns:
      The bytes for summaryText.

    • getSummarySkippedReasonsList

      public List<SearchResponse.Summary.SummarySkippedReason> getSummarySkippedReasonsList()
       Additional summary-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
      Specified by:
      getSummarySkippedReasonsList in interface SearchResponse.SummaryOrBuilder
      Returns:
      A list containing the summarySkippedReasons.

    • getSummarySkippedReasonsCount

      public int getSummarySkippedReasonsCount()
       Additional summary-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
      Specified by:
      getSummarySkippedReasonsCount in interface SearchResponse.SummaryOrBuilder
      Returns:
      The count of summarySkippedReasons.

    • getSummarySkippedReasons

      public SearchResponse.Summary.SummarySkippedReason getSummarySkippedReasons(int index)
       Additional summary-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
      Specified by:
      getSummarySkippedReasons in interface SearchResponse.SummaryOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The summarySkippedReasons at the given index.

    • getSummarySkippedReasonsValueList

      public List<Integer> getSummarySkippedReasonsValueList()
       Additional summary-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
      Specified by:
      getSummarySkippedReasonsValueList in interface SearchResponse.SummaryOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for summarySkippedReasons.

    • getSummarySkippedReasonsValue

      public int getSummarySkippedReasonsValue(int index)
       Additional summary-skipped reasons. This provides the reason for ignored
 cases. If nothing is skipped, this field is not set.
      repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummarySkippedReason summary_skipped_reasons = 2;
      Specified by:
      getSummarySkippedReasonsValue in interface SearchResponse.SummaryOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of summarySkippedReasons at the given index.

    • hasSafetyAttributes

      public boolean hasSafetyAttributes()
       A collection of Safety Attribute categories and their associated
 confidence scores.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
      Specified by:
      hasSafetyAttributes in interface SearchResponse.SummaryOrBuilder
      Returns:
      Whether the safetyAttributes field is set.

    • getSafetyAttributes

      public SearchResponse.Summary.SafetyAttributes getSafetyAttributes()
       A collection of Safety Attribute categories and their associated
 confidence scores.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
      Specified by:
      getSafetyAttributes in interface SearchResponse.SummaryOrBuilder
      Returns:
      The safetyAttributes.

    • getSafetyAttributesOrBuilder

      public SearchResponse.Summary.SafetyAttributesOrBuilder getSafetyAttributesOrBuilder()
       A collection of Safety Attribute categories and their associated
 confidence scores.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
      Specified by:
      getSafetyAttributesOrBuilder in interface SearchResponse.SummaryOrBuilder

    • hasSummaryWithMetadata

      public boolean hasSummaryWithMetadata()
       Summary with metadata information.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
      Specified by:
      hasSummaryWithMetadata in interface SearchResponse.SummaryOrBuilder
      Returns:
      Whether the summaryWithMetadata field is set.

    • getSummaryWithMetadata

      public SearchResponse.Summary.SummaryWithMetadata getSummaryWithMetadata()
       Summary with metadata information.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
      Specified by:
      getSummaryWithMetadata in interface SearchResponse.SummaryOrBuilder
      Returns:
      The summaryWithMetadata.

    • getSummaryWithMetadataOrBuilder

      public SearchResponse.Summary.SummaryWithMetadataOrBuilder getSummaryWithMetadataOrBuilder()
       Summary with metadata information.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
      Specified by:
      getSummaryWithMetadataOrBuilder in interface SearchResponse.SummaryOrBuilder

    • 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 SearchResponse.Summary parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SearchResponse.Summary parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SearchResponse.Summary parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchResponse.Summary.Builder newBuilder()

    • newBuilder

      public static SearchResponse.Summary.Builder newBuilder(SearchResponse.Summary prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchResponse.Summary getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SearchResponse.Summary> 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 SearchResponse.Summary getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder