Class protos.google.cloud.retail.v2alpha.Rule (3.6.0)

Represents a Rule.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2alpha.IRule);

Constructs a new Rule.

Parameter
Name Description
properties IRule

Properties to set

Properties

action

public action?: ("boostAction"|"redirectAction"|"onewaySynonymsAction"|"doNotAssociateAction"|"replacementAction"|"ignoreAction"|"filterAction"|"twowaySynonymsAction"|"forceReturnFacetAction"|"removeFacetAction");

Rule action.

boostAction

public boostAction?: (google.cloud.retail.v2alpha.Rule.IBoostAction|null);

Rule boostAction.

condition

public condition?: (google.cloud.retail.v2alpha.ICondition|null);

Rule condition.

doNotAssociateAction

public doNotAssociateAction?: (google.cloud.retail.v2alpha.Rule.IDoNotAssociateAction|null);

Rule doNotAssociateAction.

filterAction

public filterAction?: (google.cloud.retail.v2alpha.Rule.IFilterAction|null);

Rule filterAction.

forceReturnFacetAction

public forceReturnFacetAction?: (google.cloud.retail.v2alpha.Rule.IForceReturnFacetAction|null);

Rule forceReturnFacetAction.

ignoreAction

public ignoreAction?: (google.cloud.retail.v2alpha.Rule.IIgnoreAction|null);

Rule ignoreAction.

onewaySynonymsAction

public onewaySynonymsAction?: (google.cloud.retail.v2alpha.Rule.IOnewaySynonymsAction|null);

Rule onewaySynonymsAction.

redirectAction

public redirectAction?: (google.cloud.retail.v2alpha.Rule.IRedirectAction|null);

Rule redirectAction.

removeFacetAction

public removeFacetAction?: (google.cloud.retail.v2alpha.Rule.IRemoveFacetAction|null);

Rule removeFacetAction.

replacementAction

public replacementAction?: (google.cloud.retail.v2alpha.Rule.IReplacementAction|null);

Rule replacementAction.

twowaySynonymsAction

public twowaySynonymsAction?: (google.cloud.retail.v2alpha.Rule.ITwowaySynonymsAction|null);

Rule twowaySynonymsAction.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2alpha.IRule): google.cloud.retail.v2alpha.Rule;

Creates a new Rule instance using the specified properties.

Parameter
Name Description
properties IRule

Properties to set

Returns
Type Description
Rule

Rule instance

decode(reader, length)

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

Decodes a Rule 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
Rule

Rule

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Rule

Rule

encode(message, writer)

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

Encodes the specified Rule message. Does not implicitly messages.

Parameters
Name Description
message IRule

Rule 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.IRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRule

Rule 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.Rule;

Creates a Rule 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
Rule

Rule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Rule

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Rule

Rule

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 Rule 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