Constructor
new CompleteQueryRequest(propertiesopt)
Constructs a new CompleteQueryRequest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.ICompleteQueryRequest |
<optional> |
Properties to set |
- Implements:
-
- ICompleteQueryRequest
Members
catalog
CompleteQueryRequest catalog.
dataset
CompleteQueryRequest dataset.
deviceType
CompleteQueryRequest deviceType.
enableAttributeSuggestions
CompleteQueryRequest enableAttributeSuggestions.
entity
CompleteQueryRequest entity.
languageCodes
CompleteQueryRequest languageCodes.
maxSuggestions
CompleteQueryRequest maxSuggestions.
query
CompleteQueryRequest query.
visitorId
CompleteQueryRequest visitorId.
Methods
toJSON() → {Object.<string, *>}
Converts this CompleteQueryRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.retail.v2.CompleteQueryRequest}
Creates a new CompleteQueryRequest instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.ICompleteQueryRequest |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.CompleteQueryRequest |
CompleteQueryRequest instance |
(static) decode(reader, lengthopt) → {google.cloud.retail.v2.CompleteQueryRequest}
Decodes a CompleteQueryRequest 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.CompleteQueryRequest |
CompleteQueryRequest |
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.CompleteQueryRequest}
Decodes a CompleteQueryRequest 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.CompleteQueryRequest |
CompleteQueryRequest |
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 CompleteQueryRequest message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.ICompleteQueryRequest |
CompleteQueryRequest 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 CompleteQueryRequest message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.ICompleteQueryRequest |
CompleteQueryRequest 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.CompleteQueryRequest}
Creates a CompleteQueryRequest 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.CompleteQueryRequest |
CompleteQueryRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for CompleteQueryRequest
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 CompleteQueryRequest message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.CompleteQueryRequest |
CompleteQueryRequest |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a CompleteQueryRequest message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|