Class protos.google.cloud.retail.v2beta.ServingConfig (2.3.1)

Represents a ServingConfig.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2beta.IServingConfig);

Constructs a new ServingConfig.

Parameter
Name	Description
`properties`	`IServingConfig` Properties to set

Properties

boostControlIds

public boostControlIds: string[];

ServingConfig boostControlIds.

displayName

public displayName: string;

ServingConfig displayName.

diversityLevel

public diversityLevel: string;

ServingConfig diversityLevel.

diversityType

public diversityType: (google.cloud.retail.v2beta.ServingConfig.DiversityType|keyof typeof google.cloud.retail.v2beta.ServingConfig.DiversityType);

ServingConfig diversityType.

doNotAssociateControlIds

public doNotAssociateControlIds: string[];

ServingConfig doNotAssociateControlIds.

dynamicFacetSpec

public dynamicFacetSpec?: (google.cloud.retail.v2beta.SearchRequest.IDynamicFacetSpec|null);

ServingConfig dynamicFacetSpec.

enableCategoryFilterLevel

public enableCategoryFilterLevel: string;

ServingConfig enableCategoryFilterLevel.

facetControlIds

public facetControlIds: string[];

ServingConfig facetControlIds.

filterControlIds

public filterControlIds: string[];

ServingConfig filterControlIds.

ignoreControlIds

public ignoreControlIds: string[];

ServingConfig ignoreControlIds.

modelId

public modelId: string;

ServingConfig modelId.

name

public name: string;

ServingConfig name.

onewaySynonymsControlIds

public onewaySynonymsControlIds: string[];

ServingConfig onewaySynonymsControlIds.

personalizationSpec

public personalizationSpec?: (google.cloud.retail.v2beta.SearchRequest.IPersonalizationSpec|null);

ServingConfig personalizationSpec.

priceRerankingLevel

public priceRerankingLevel: string;

ServingConfig priceRerankingLevel.

redirectControlIds

public redirectControlIds: string[];

ServingConfig redirectControlIds.

replacementControlIds

public replacementControlIds: string[];

ServingConfig replacementControlIds.

solutionTypes

public solutionTypes: google.cloud.retail.v2beta.SolutionType[];

ServingConfig solutionTypes.

twowaySynonymsControlIds

public twowaySynonymsControlIds: string[];

ServingConfig twowaySynonymsControlIds.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2beta.IServingConfig): google.cloud.retail.v2beta.ServingConfig;

Creates a new ServingConfig instance using the specified properties.

Parameter
Name	Description
`properties`	`IServingConfig` Properties to set

Returns
Type	Description
`google.cloud.retail.v2beta.ServingConfig`	ServingConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2beta.ServingConfig;

Decodes a ServingConfig message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`google.cloud.retail.v2beta.ServingConfig`	ServingConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2beta.ServingConfig;

Decodes a ServingConfig message from the specified reader or buffer, length delimited.

Parameter
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`google.cloud.retail.v2beta.ServingConfig`	ServingConfig

encode(message, writer)

public static encode(message: google.cloud.retail.v2beta.IServingConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ServingConfig message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IServingConfig` ServingConfig 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.v2beta.IServingConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ServingConfig message, length delimited. Does not implicitly messages.

Parameters
Name	Description
`message`	`IServingConfig` ServingConfig 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.v2beta.ServingConfig;

Creates a ServingConfig 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
`google.cloud.retail.v2beta.ServingConfig`	ServingConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ServingConfig

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 ServingConfig to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.retail.v2beta.ServingConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ServingConfig message. Also converts values to other types if specified.

Parameters
Name	Description
`message`	`google.cloud.retail.v2beta.ServingConfig` ServingConfig
`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 ServingConfig message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not