Represents a Model.
Package
@google-cloud/retailConstructors
(constructor)(properties)
constructor(properties?: google.cloud.retail.v2alpha.IModel);Constructs a new Model.
| Parameter | |
|---|---|
| Name | Description |
properties |
IModel
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Model createTime.
dataState
public dataState: (google.cloud.retail.v2alpha.Model.DataState|keyof typeof google.cloud.retail.v2alpha.Model.DataState);Model dataState.
displayName
public displayName: string;Model displayName.
filteringOption
public filteringOption: (google.cloud.retail.v2alpha.RecommendationsFilteringOption|keyof typeof google.cloud.retail.v2alpha.RecommendationsFilteringOption);Model filteringOption.
lastTuneTime
public lastTuneTime?: (google.protobuf.ITimestamp|null);Model lastTuneTime.
modelFeaturesConfig
public modelFeaturesConfig?: (google.cloud.retail.v2alpha.Model.IModelFeaturesConfig|null);Model modelFeaturesConfig.
name
public name: string;Model name.
optimizationObjective
public optimizationObjective: string;Model optimizationObjective.
pageOptimizationConfig
public pageOptimizationConfig?: (google.cloud.retail.v2alpha.Model.IPageOptimizationConfig|null);Model pageOptimizationConfig.
periodicTuningState
public periodicTuningState: (google.cloud.retail.v2alpha.Model.PeriodicTuningState|keyof typeof google.cloud.retail.v2alpha.Model.PeriodicTuningState);Model periodicTuningState.
servingConfigLists
public servingConfigLists: google.cloud.retail.v2alpha.Model.IServingConfigList[];Model servingConfigLists.
servingState
public servingState: (google.cloud.retail.v2alpha.Model.ServingState|keyof typeof google.cloud.retail.v2alpha.Model.ServingState);Model servingState.
trainingConfig
public trainingConfig?: "pageOptimizationConfig";Model trainingConfig.
trainingState
public trainingState: (google.cloud.retail.v2alpha.Model.TrainingState|keyof typeof google.cloud.retail.v2alpha.Model.TrainingState);Model trainingState.
tuningOperation
public tuningOperation: string;Model tuningOperation.
type
public type: string;Model type.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Model updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.retail.v2alpha.IModel): google.cloud.retail.v2alpha.Model;Creates a new Model instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IModel
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Model |
Model instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2alpha.Model;Decodes a Model message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Model |
Model |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2alpha.Model;Decodes a Model message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Model |
Model |
encode(message, writer)
public static encode(message: google.cloud.retail.v2alpha.IModel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Model message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IModel
Model message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.retail.v2alpha.IModel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Model message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IModel
Model message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2alpha.Model;Creates a Model message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Model |
Model |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Model
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Model to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.retail.v2alpha.Model, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Model message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Model
Model |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Model message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|