Constructor
new ServingConfig(propertiesopt)
Constructs a new ServingConfig.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.IServingConfig |
<optional> |
Properties to set |
- Implements:
-
- IServingConfig
Members
boostControlIds
ServingConfig boostControlIds.
displayName
ServingConfig displayName.
diversityLevel
ServingConfig diversityLevel.
diversityType
ServingConfig diversityType.
doNotAssociateControlIds
ServingConfig doNotAssociateControlIds.
dynamicFacetSpec
ServingConfig dynamicFacetSpec.
enableCategoryFilterLevel
ServingConfig enableCategoryFilterLevel.
facetControlIds
ServingConfig facetControlIds.
filterControlIds
ServingConfig filterControlIds.
ignoreControlIds
ServingConfig ignoreControlIds.
ignoreRecsDenylist
ServingConfig ignoreRecsDenylist.
modelId
ServingConfig modelId.
name
ServingConfig name.
onewaySynonymsControlIds
ServingConfig onewaySynonymsControlIds.
personalizationSpec
ServingConfig personalizationSpec.
priceRerankingLevel
ServingConfig priceRerankingLevel.
redirectControlIds
ServingConfig redirectControlIds.
replacementControlIds
ServingConfig replacementControlIds.
solutionTypes
ServingConfig solutionTypes.
twowaySynonymsControlIds
ServingConfig twowaySynonymsControlIds.
DiversityType
DiversityType enum.
Properties:
| Name | Type | Description |
|---|---|---|
DIVERSITY_TYPE_UNSPECIFIED |
number |
DIVERSITY_TYPE_UNSPECIFIED value |
RULE_BASED_DIVERSITY |
number |
RULE_BASED_DIVERSITY value |
DATA_DRIVEN_DIVERSITY |
number |
DATA_DRIVEN_DIVERSITY value |
Methods
toJSON() → {Object.<string, *>}
Converts this ServingConfig to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.retail.v2.ServingConfig}
Creates a new ServingConfig instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.IServingConfig |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.ServingConfig |
ServingConfig instance |
(static) decode(reader, lengthopt) → {google.cloud.retail.v2.ServingConfig}
Decodes a ServingConfig 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.ServingConfig |
ServingConfig |
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.ServingConfig}
Decodes a ServingConfig 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.ServingConfig |
ServingConfig |
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 ServingConfig message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.IServingConfig |
ServingConfig 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 ServingConfig message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.IServingConfig |
ServingConfig 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.ServingConfig}
Creates a ServingConfig 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.ServingConfig |
ServingConfig |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ServingConfig
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 ServingConfig message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.ServingConfig |
ServingConfig |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a ServingConfig message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|