Package com.google.cloud.discoveryengine.v1

Class SearchRequest.FacetSpec.FacetKey

    • 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

      • getKey

        public String getKey()
         Required. Supported textual and numerical facet keys in
 [Document][google.cloud.discoveryengine.v1.Document] object, over which
 the facet values are computed. Facet key is case-sensitive.
        string key = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getKey in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The key.

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         Required. Supported textual and numerical facet keys in
 [Document][google.cloud.discoveryengine.v1.Document] object, over which
 the facet values are computed. Facet key is case-sensitive.
        string key = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getKeyBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The bytes for key.

      • getIntervalsList

        public List<Interval> getIntervalsList()
         Set only if values should be bucketed into intervals. Must be set
 for facets with numerical values. Must not be set for facet with text
 values. Maximum number of intervals is 30.
        repeated .google.cloud.discoveryengine.v1.Interval intervals = 2;
        Specified by:
        getIntervalsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

      • getIntervalsOrBuilderList

        public List<? extends IntervalOrBuilder> getIntervalsOrBuilderList()
         Set only if values should be bucketed into intervals. Must be set
 for facets with numerical values. Must not be set for facet with text
 values. Maximum number of intervals is 30.
        repeated .google.cloud.discoveryengine.v1.Interval intervals = 2;
        Specified by:
        getIntervalsOrBuilderList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

      • getIntervalsCount

        public int getIntervalsCount()
         Set only if values should be bucketed into intervals. Must be set
 for facets with numerical values. Must not be set for facet with text
 values. Maximum number of intervals is 30.
        repeated .google.cloud.discoveryengine.v1.Interval intervals = 2;
        Specified by:
        getIntervalsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

      • getIntervals

        public Interval getIntervals​(int index)
         Set only if values should be bucketed into intervals. Must be set
 for facets with numerical values. Must not be set for facet with text
 values. Maximum number of intervals is 30.
        repeated .google.cloud.discoveryengine.v1.Interval intervals = 2;
        Specified by:
        getIntervals in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

      • getIntervalsOrBuilder

        public IntervalOrBuilder getIntervalsOrBuilder​(int index)
         Set only if values should be bucketed into intervals. Must be set
 for facets with numerical values. Must not be set for facet with text
 values. Maximum number of intervals is 30.
        repeated .google.cloud.discoveryengine.v1.Interval intervals = 2;
        Specified by:
        getIntervalsOrBuilder in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

      • getRestrictedValuesList

        public com.google.protobuf.ProtocolStringList getRestrictedValuesList()
         Only get facet for the given restricted values. Only supported on
 textual fields. For example, suppose "category" has three values
 "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
 "restricted_values" to "Action > 2022", the "category" facet only
 contains "Action > 2022". Only supported on textual fields. Maximum
 is 10.
        repeated string restricted_values = 3;
        Specified by:
        getRestrictedValuesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        A list containing the restrictedValues.

      • getRestrictedValuesCount

        public int getRestrictedValuesCount()
         Only get facet for the given restricted values. Only supported on
 textual fields. For example, suppose "category" has three values
 "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
 "restricted_values" to "Action > 2022", the "category" facet only
 contains "Action > 2022". Only supported on textual fields. Maximum
 is 10.
        repeated string restricted_values = 3;
        Specified by:
        getRestrictedValuesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The count of restrictedValues.

      • getRestrictedValues

        public String getRestrictedValues​(int index)
         Only get facet for the given restricted values. Only supported on
 textual fields. For example, suppose "category" has three values
 "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
 "restricted_values" to "Action > 2022", the "category" facet only
 contains "Action > 2022". Only supported on textual fields. Maximum
 is 10.
        repeated string restricted_values = 3;
        Specified by:
        getRestrictedValues in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The restrictedValues at the given index.

      • getRestrictedValuesBytes

        public com.google.protobuf.ByteString getRestrictedValuesBytes​(int index)
         Only get facet for the given restricted values. Only supported on
 textual fields. For example, suppose "category" has three values
 "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
 "restricted_values" to "Action > 2022", the "category" facet only
 contains "Action > 2022". Only supported on textual fields. Maximum
 is 10.
        repeated string restricted_values = 3;
        Specified by:
        getRestrictedValuesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the restrictedValues at the given index.

      • getPrefixesList

        public com.google.protobuf.ProtocolStringList getPrefixesList()
         Only get facet values that start with the given string prefix. For
 example, suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
 "category" facet only contains "Action > 2022" and "Action > 2021".
 Only supported on textual fields. Maximum is 10.
        repeated string prefixes = 4;
        Specified by:
        getPrefixesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        A list containing the prefixes.

      • getPrefixesCount

        public int getPrefixesCount()
         Only get facet values that start with the given string prefix. For
 example, suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
 "category" facet only contains "Action > 2022" and "Action > 2021".
 Only supported on textual fields. Maximum is 10.
        repeated string prefixes = 4;
        Specified by:
        getPrefixesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The count of prefixes.

      • getPrefixes

        public String getPrefixes​(int index)
         Only get facet values that start with the given string prefix. For
 example, suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
 "category" facet only contains "Action > 2022" and "Action > 2021".
 Only supported on textual fields. Maximum is 10.
        repeated string prefixes = 4;
        Specified by:
        getPrefixes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The prefixes at the given index.

      • getPrefixesBytes

        public com.google.protobuf.ByteString getPrefixesBytes​(int index)
         Only get facet values that start with the given string prefix. For
 example, suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
 "category" facet only contains "Action > 2022" and "Action > 2021".
 Only supported on textual fields. Maximum is 10.
        repeated string prefixes = 4;
        Specified by:
        getPrefixesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the prefixes at the given index.

      • getContainsList

        public com.google.protobuf.ProtocolStringList getContainsList()
         Only get facet values that contains the given strings. For example,
 suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
 "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
 Only supported on textual fields. Maximum is 10.
        repeated string contains = 5;
        Specified by:
        getContainsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        A list containing the contains.

      • getContainsCount

        public int getContainsCount()
         Only get facet values that contains the given strings. For example,
 suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
 "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
 Only supported on textual fields. Maximum is 10.
        repeated string contains = 5;
        Specified by:
        getContainsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The count of contains.

      • getContains

        public String getContains​(int index)
         Only get facet values that contains the given strings. For example,
 suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
 "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
 Only supported on textual fields. Maximum is 10.
        repeated string contains = 5;
        Specified by:
        getContains in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The contains at the given index.

      • getContainsBytes

        public com.google.protobuf.ByteString getContainsBytes​(int index)
         Only get facet values that contains the given strings. For example,
 suppose "category" has three values "Action > 2022",
 "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
 "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
 Only supported on textual fields. Maximum is 10.
        repeated string contains = 5;
        Specified by:
        getContainsBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the contains at the given index.

      • getCaseInsensitive

        public boolean getCaseInsensitive()
         True to make facet keys case insensitive when getting faceting
 values with prefixes or contains; false otherwise.
        bool case_insensitive = 6;
        Specified by:
        getCaseInsensitive in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The caseInsensitive.

      • getOrderBy

        public String getOrderBy()
         The order in which documents are returned.

 Allowed values are:

 * "count desc", which means order by
 [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.value]
 descending.
   Only applies to textual facets.

 If not set, textual values are sorted in [natural
 order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
 intervals are sorted in the order given by
 [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.intervals].
        string order_by = 7;
        Specified by:
        getOrderBy in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         The order in which documents are returned.

 Allowed values are:

 * "count desc", which means order by
 [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue.value]
 descending.
   Only applies to textual facets.

 If not set, textual values are sorted in [natural
 order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
 intervals are sorted in the order given by
 [FacetSpec.FacetKey.intervals][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.intervals].
        string order_by = 7;
        Specified by:
        getOrderByBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder
        Returns:
        The bytes for orderBy.

      • 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 SearchRequest.FacetSpec.FacetKey parseFrom​(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest.FacetSpec.FacetKey parseFrom​(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest.FacetSpec.FacetKey parseFrom​(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest.FacetSpec.FacetKey parseFrom​(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SearchRequest.FacetSpec.FacetKey.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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