Constructor
new Rule(propertiesopt)
Constructs a new Rule.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.IRule |
<optional> |
Properties to set |
- Implements:
-
- IRule
Classes
- BoostAction
- DoNotAssociateAction
- FilterAction
- ForceReturnFacetAction
- IgnoreAction
- OnewaySynonymsAction
- RedirectAction
- RemoveFacetAction
- ReplacementAction
- TwowaySynonymsAction
Members
action
Rule action.
boostAction
Rule boostAction.
condition
Rule condition.
doNotAssociateAction
Rule doNotAssociateAction.
filterAction
Rule filterAction.
forceReturnFacetAction
Rule forceReturnFacetAction.
ignoreAction
Rule ignoreAction.
onewaySynonymsAction
Rule onewaySynonymsAction.
redirectAction
Rule redirectAction.
removeFacetAction
Rule removeFacetAction.
replacementAction
Rule replacementAction.
twowaySynonymsAction
Rule twowaySynonymsAction.
Methods
toJSON() → {Object.<string, *>}
Converts this Rule to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.retail.v2.Rule}
Creates a new Rule instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.IRule |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.Rule |
Rule instance |
(static) decode(reader, lengthopt) → {google.cloud.retail.v2.Rule}
Decodes a Rule 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.Rule |
Rule |
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.Rule}
Decodes a Rule 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.Rule |
Rule |
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 Rule message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.IRule |
Rule 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 Rule message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.IRule |
Rule 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.Rule}
Creates a Rule 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.Rule |
Rule |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Rule
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 Rule message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.Rule |
Rule |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Rule message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|