com.shopify.buy3

Class Storefront.QueryRootQuery.PredictiveSearchArguments

java.lang.Object

com.shopify.graphql.support.Arguments

com.shopify.buy3.Storefront.QueryRootQuery.PredictiveSearchArguments

Enclosing class:

Storefront.QueryRootQuery

public class Storefront.QueryRootQuery.PredictiveSearchArguments
extends Arguments

Method Summary

Modifier and Type	Method and Description
Storefront.QueryRootQuery.PredictiveSearchArguments	limit(java.lang.Integer value) Limits the number of results based on `limit_scope`.
Storefront.QueryRootQuery.PredictiveSearchArguments	limitScope(Storefront.PredictiveSearchLimitScope value) Decides the distribution of results.
Storefront.QueryRootQuery.PredictiveSearchArguments	searchableFields(java.util.List<Storefront.SearchableField> value) Specifies the list of resource fields to use for search.
Storefront.QueryRootQuery.PredictiveSearchArguments	types(java.util.List<Storefront.PredictiveSearchType> value) The types of resources to search for.
Storefront.QueryRootQuery.PredictiveSearchArguments	unavailableProducts(Storefront.SearchUnavailableProductsType value) Specifies how unavailable products are displayed in the search results.

Methods inherited from class com.shopify.graphql.support.Arguments

end, startArgument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

limit

public Storefront.QueryRootQuery.PredictiveSearchArguments limit(java.lang.Integer value)

Limits the number of results based on `limit_scope`. The value can range from 1 to 10, and the default is 10.

limitScope

public Storefront.QueryRootQuery.PredictiveSearchArguments limitScope(Storefront.PredictiveSearchLimitScope value)

Decides the distribution of results.

searchableFields

public Storefront.QueryRootQuery.PredictiveSearchArguments searchableFields(java.util.List<Storefront.SearchableField> value)

Specifies the list of resource fields to use for search. The default fields searched on are TITLE, PRODUCT_TYPE, VARIANT_TITLE, and VENDOR. For the best search experience, you should search on the default field set. The input must not contain more than `250` values.

types

public Storefront.QueryRootQuery.PredictiveSearchArguments types(java.util.List<Storefront.PredictiveSearchType> value)

The types of resources to search for. The input must not contain more than `250` values.

unavailableProducts

public Storefront.QueryRootQuery.PredictiveSearchArguments unavailableProducts(Storefront.SearchUnavailableProductsType value)

Specifies how unavailable products are displayed in the search results.