Constructor
new SearchResponse(propertiesopt)
Constructs a new SearchResponse.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.ISearchResponse |
<optional> |
Properties to set |
- Implements:
-
- ISearchResponse
Classes
Members
appliedControls
SearchResponse appliedControls.
attributionToken
SearchResponse attributionToken.
conversationalSearchResult
SearchResponse conversationalSearchResult.
correctedQuery
SearchResponse correctedQuery.
experimentInfo
SearchResponse experimentInfo.
facets
SearchResponse facets.
invalidConditionBoostSpecs
SearchResponse invalidConditionBoostSpecs.
nextPageToken
SearchResponse nextPageToken.
queryExpansionInfo
SearchResponse queryExpansionInfo.
redirectUri
SearchResponse redirectUri.
results
SearchResponse results.
tileNavigationResult
SearchResponse tileNavigationResult.
totalSize
SearchResponse totalSize.
Methods
toJSON() → {Object.<string, *>}
Converts this SearchResponse to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.retail.v2.SearchResponse}
Creates a new SearchResponse instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.ISearchResponse |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.SearchResponse |
SearchResponse instance |
(static) decode(reader, lengthopt) → {google.cloud.retail.v2.SearchResponse}
Decodes a SearchResponse 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.SearchResponse |
SearchResponse |
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.SearchResponse}
Decodes a SearchResponse 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.SearchResponse |
SearchResponse |
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 SearchResponse message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.ISearchResponse |
SearchResponse 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 SearchResponse message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.ISearchResponse |
SearchResponse 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.SearchResponse}
Creates a SearchResponse 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.SearchResponse |
SearchResponse |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for SearchResponse
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 SearchResponse message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.SearchResponse |
SearchResponse |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a SearchResponse message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|