Package com.google.cloud.discoveryengine.v1beta

Interface SearchRequest.FacetSpec.FacetKeyOrBuilder

    • Method Detail

      • getKey

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

      • getKeyBytes

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

      • getIntervalsList

        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.v1beta.Interval intervals = 2;

      • getIntervals

        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.v1beta.Interval intervals = 2;

      • getIntervalsCount

        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.v1beta.Interval intervals = 2;

      • getIntervalsOrBuilderList

        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.v1beta.Interval intervals = 2;

      • getIntervalsOrBuilder

        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.v1beta.Interval intervals = 2;

      • getRestrictedValuesList

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

      • getRestrictedValuesCount

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

      • getRestrictedValues

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

      • getRestrictedValuesBytes

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

      • getPrefixesList

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

      • getPrefixesCount

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

      • getPrefixes

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

      • getPrefixesBytes

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

      • getContainsList

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

      • getContainsCount

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

      • getContains

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

      • getContainsBytes

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

      • getCaseInsensitive

        boolean getCaseInsensitive()
         True to make facet keys case insensitive when getting faceting
 values with prefixes or contains; false otherwise.
        bool case_insensitive = 6;
        Returns:
        The caseInsensitive.

      • getOrderBy

        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.v1beta.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
        string order_by = 7;
        Returns:
        The orderBy.

      • getOrderByBytes

        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.v1beta.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
        string order_by = 7;
        Returns:
        The bytes for orderBy.