Package com.google.cloud.discoveryengine.v1

Class 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.GeneratedMessageV3
implements SearchResponse.SummaryOrBuilder
     Summary of the top N search result specified by the summary spec.
    Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Summary
    See Also:
    Serialized Form

    • Field Detail

      • SUMMARY_TEXT_FIELD_NUMBER

        public static final int SUMMARY_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUMMARY_SKIPPED_REASONS_FIELD_NUMBER

        public static final int SUMMARY_SKIPPED_REASONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SAFETY_ATTRIBUTES_FIELD_NUMBER

        public static final int SAFETY_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • 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.v1.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.v1.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.v1.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.v1.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.v1.SearchResponse.Summary.SafetyAttributes safety_attributes = 3;
        Specified by:
        hasSafetyAttributes in interface SearchResponse.SummaryOrBuilder
        Returns:
        Whether the safetyAttributes field is set.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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