Google Cloud Retail V2 Client - Class SearchMode (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class SearchMode.

The search mode of each search request.

Protobuf type google.cloud.retail.v2.SearchRequest.SearchMode

Namespace

Google \ Cloud \ Retail \ V2 \ SearchRequest

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

SEARCH_MODE_UNSPECIFIED

Value: 0

Default value. In this case both product search and faceted search will be performed. Both SearchResponse.SearchResult and SearchResponse.Facet will be returned.

Generated from protobuf enum SEARCH_MODE_UNSPECIFIED = 0;

PRODUCT_SEARCH_ONLY

Value: 1

Only product search will be performed. The faceted search will be disabled.

Only SearchResponse.SearchResult will be returned. SearchResponse.Facet will not be returned, even if SearchRequest.facet_specs or SearchRequest.dynamic_facet_spec is set.

Generated from protobuf enum PRODUCT_SEARCH_ONLY = 1;

FACETED_SEARCH_ONLY

Value: 2

Only faceted search will be performed. The product search will be disabled.

When in this mode, one or both of SearchRequest.facet_specs and SearchRequest.dynamic_facet_spec should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only SearchResponse.Facet will be returned. SearchResponse.SearchResult will not be returned.

Generated from protobuf enum FACETED_SEARCH_ONLY = 2;