Class protos.google.cloud.retail.v2beta.Control (1.7.0)

Represents a Control.

Package

Constructors

(constructor)(properties)

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

Constructs a new Control.

Parameter

Name	Description
properties	`IControl` Properties to set

Properties

associatedServingConfigIds

public associatedServingConfigIds: string[];

Control associatedServingConfigIds.

control

public control?: ("facetSpec"|"rule");

Control control.

displayName

public displayName: string;

Control displayName.

facetSpec

public facetSpec?: (google.cloud.retail.v2beta.SearchRequest.IFacetSpec|null);

Control facetSpec.

name

public name: string;

Control name.

rule

public rule?: (google.cloud.retail.v2beta.IRule|null);

Control rule.

solutionTypes

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

Control solutionTypes.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2beta.IControl): google.cloud.retail.v2beta.Control;

Creates a new Control instance using the specified properties.

Parameter

Name	Description
properties	`IControl` Properties to set

Returns

Type	Description
google.cloud.retail.v2beta.Control	Control instance

decode(reader, length)

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

Decodes a Control 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.Control	Control

decodeDelimited(reader)

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

Decodes a Control 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.Control	Control

encode(message, writer)

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

Encodes the specified Control message. Does not implicitly messages.

Parameters

Name	Description
message	`IControl` Control 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.IControl, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IControl` Control 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.Control;

Creates a Control 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.Control	Control

toJSON()

public toJSON(): { [k: string]: any };

Converts this Control to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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