Class protos.google.cloud.retail.v2beta.CollectUserEventRequest (3.5.0)

Represents a CollectUserEventRequest.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

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

Constructs a new CollectUserEventRequest.

Parameter
Name Description
properties ICollectUserEventRequest

Properties to set

Properties

conversionRule

public conversionRule?: "prebuiltRule";

CollectUserEventRequest conversionRule.

ets

public ets: (number|Long|string);

CollectUserEventRequest ets.

parent

public parent: string;

CollectUserEventRequest parent.

prebuiltRule

public prebuiltRule?: (string|null);

CollectUserEventRequest prebuiltRule.

rawJson

public rawJson: string;

CollectUserEventRequest rawJson.

uri

public uri: string;

CollectUserEventRequest uri.

userEvent

public userEvent: string;

CollectUserEventRequest userEvent.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2beta.ICollectUserEventRequest): google.cloud.retail.v2beta.CollectUserEventRequest;

Creates a new CollectUserEventRequest instance using the specified properties.

Parameter
Name Description
properties ICollectUserEventRequest

Properties to set

Returns
Type Description
CollectUserEventRequest

CollectUserEventRequest instance

decode(reader, length)

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

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

CollectUserEventRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CollectUserEventRequest

CollectUserEventRequest

encode(message, writer)

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

Encodes the specified CollectUserEventRequest message. Does not implicitly messages.

Parameters
Name Description
message ICollectUserEventRequest

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

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

Parameters
Name Description
message ICollectUserEventRequest

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

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

CollectUserEventRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CollectUserEventRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message CollectUserEventRequest

CollectUserEventRequest

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