Google Cloud Retail V2 Client - Class SearchMode (1.0.1)

Version 1.0.1

• 2.1.1 (latest)
• 2.1.0
• 2.0.0
• 1.7.0
• 1.6.4
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.1

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

Methods

name

Parameter
Name	Description
value	mixed

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;