Constructor
new SearchRequest(propertiesopt)
Constructs a new SearchRequest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.ISearchRequest |
<optional> |
Properties to set |
- Implements:
-
- ISearchRequest
Classes
- BoostSpec
- ConversationalSearchSpec
- DynamicFacetSpec
- FacetSpec
- PersonalizationSpec
- QueryExpansionSpec
- SpellCorrectionSpec
- TileNavigationSpec
Members
_spellCorrectionSpec
SearchRequest _spellCorrectionSpec.
boostSpec
SearchRequest boostSpec.
branch
SearchRequest branch.
canonicalFilter
SearchRequest canonicalFilter.
conversationalSearchSpec
SearchRequest conversationalSearchSpec.
dynamicFacetSpec
SearchRequest dynamicFacetSpec.
entity
SearchRequest entity.
facetSpecs
SearchRequest facetSpecs.
filter
SearchRequest filter.
labels
SearchRequest labels.
offset
SearchRequest offset.
orderBy
SearchRequest orderBy.
pageCategories
SearchRequest pageCategories.
pageSize
SearchRequest pageSize.
pageToken
SearchRequest pageToken.
personalizationSpec
SearchRequest personalizationSpec.
placement
SearchRequest placement.
query
SearchRequest query.
queryExpansionSpec
SearchRequest queryExpansionSpec.
searchMode
SearchRequest searchMode.
spellCorrectionSpec
SearchRequest spellCorrectionSpec.
tileNavigationSpec
SearchRequest tileNavigationSpec.
userInfo
SearchRequest userInfo.
variantRollupKeys
SearchRequest variantRollupKeys.
visitorId
SearchRequest visitorId.
SearchMode
SearchMode enum.
Properties:
| Name | Type | Description |
|---|---|---|
SEARCH_MODE_UNSPECIFIED |
number |
SEARCH_MODE_UNSPECIFIED value |
PRODUCT_SEARCH_ONLY |
number |
PRODUCT_SEARCH_ONLY value |
FACETED_SEARCH_ONLY |
number |
FACETED_SEARCH_ONLY value |
Methods
toJSON() → {Object.<string, *>}
Converts this SearchRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.retail.v2.SearchRequest}
Creates a new SearchRequest instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.ISearchRequest |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.SearchRequest |
SearchRequest instance |
(static) decode(reader, lengthopt) → {google.cloud.retail.v2.SearchRequest}
Decodes a SearchRequest message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.SearchRequest |
SearchRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.retail.v2.SearchRequest}
Decodes a SearchRequest message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.SearchRequest |
SearchRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified SearchRequest message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.ISearchRequest |
SearchRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified SearchRequest message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.ISearchRequest |
SearchRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.retail.v2.SearchRequest}
Creates a SearchRequest message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.SearchRequest |
SearchRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for SearchRequest
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a SearchRequest message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.SearchRequest |
SearchRequest |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a SearchRequest message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|