Class protos.google.cloud.retail.v2beta.AddControlRequest (3.1.0)

Represents an AddControlRequest.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

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

Constructs a new AddControlRequest.

Parameter
Name Description
properties IAddControlRequest

Properties to set

Properties

controlId

public controlId: string;

AddControlRequest controlId.

servingConfig

public servingConfig: string;

AddControlRequest servingConfig.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2beta.IAddControlRequest): google.cloud.retail.v2beta.AddControlRequest;

Creates a new AddControlRequest instance using the specified properties.

Parameter
Name Description
properties IAddControlRequest

Properties to set
Returns
Type Description
AddControlRequest

AddControlRequest instance

decode(reader, length)

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

Decodes an AddControlRequest 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
AddControlRequest

AddControlRequest

decodeDelimited(reader)

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

Decodes an AddControlRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
AddControlRequest

AddControlRequest

encode(message, writer)

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

Encodes the specified AddControlRequest message. Does not implicitly messages.

Parameters
Name Description
message IAddControlRequest

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

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

Parameters
Name Description
message IAddControlRequest

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

Creates an AddControlRequest 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