Package com.google.cloud.discoveryengine.v1beta

Interface SearchResponse.SummaryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchResponse.Summary, SearchResponse.Summary.Builder
Enclosing class:
SearchResponse
public static interface SearchResponse.SummaryOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSummaryText

      String getSummaryText()
       The summary content.
      string summary_text = 1;
      Returns:
      The summaryText.

    • getSummaryTextBytes

      com.google.protobuf.ByteString getSummaryTextBytes()
       The summary content.
      string summary_text = 1;
      Returns:
      The bytes for summaryText.

    • getSummarySkippedReasonsList

      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;
      Returns:
      A list containing the summarySkippedReasons.

    • getSummarySkippedReasonsCount

      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;
      Returns:
      The count of summarySkippedReasons.

    • getSummarySkippedReasons

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The summarySkippedReasons at the given index.

    • getSummarySkippedReasonsValueList

      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;
      Returns:
      A list containing the enum numeric values on the wire for summarySkippedReasons.

    • getSummarySkippedReasonsValue

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of summarySkippedReasons at the given index.

    • hasSafetyAttributes

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

    • getSafetyAttributes

      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;
      Returns:
      The safetyAttributes.

    • getSafetyAttributesOrBuilder

      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;

    • hasSummaryWithMetadata

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

    • getSummaryWithMetadata

      SearchResponse.Summary.SummaryWithMetadata getSummaryWithMetadata()
       Summary with metadata information.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;
      Returns:
      The summaryWithMetadata.

    • getSummaryWithMetadataOrBuilder

      SearchResponse.Summary.SummaryWithMetadataOrBuilder getSummaryWithMetadataOrBuilder()
       Summary with metadata information.
      .google.cloud.discoveryengine.v1beta.SearchResponse.Summary.SummaryWithMetadata summary_with_metadata = 4;