Class protos.google.cloud.retail.v2.UserEventService (2.3.1)

Represents a UserEventService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.retail.v2.UserEventService

Package

@google-cloud/retail

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new UserEventService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

collectUserEvent(request, callback)

public collectUserEvent(request: google.cloud.retail.v2.ICollectUserEventRequest, callback: google.cloud.retail.v2.UserEventService.CollectUserEventCallback): void;

Calls CollectUserEvent.

Parameters
Name Description
request google.cloud.retail.v2.ICollectUserEventRequest

CollectUserEventRequest message or plain object
callback google.cloud.retail.v2.UserEventService.CollectUserEventCallback

Node-style callback called with the error, if any, and HttpBody
Returns
Type Description
void

collectUserEvent(request)

public collectUserEvent(request: google.cloud.retail.v2.ICollectUserEventRequest): Promise<google.api.HttpBody>;

Calls CollectUserEvent.

Parameter
Name Description
request google.cloud.retail.v2.ICollectUserEventRequest

CollectUserEventRequest message or plain object
Returns
Type Description
Promise<google.api.HttpBody>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): UserEventService;

Creates new UserEventService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
UserEventService

RPC service. Useful where requests and/or responses are streamed.

importUserEvents(request, callback)

public importUserEvents(request: google.cloud.retail.v2.IImportUserEventsRequest, callback: google.cloud.retail.v2.UserEventService.ImportUserEventsCallback): void;

Calls ImportUserEvents.

Parameters
Name Description
request IImportUserEventsRequest

ImportUserEventsRequest message or plain object
callback google.cloud.retail.v2.UserEventService.ImportUserEventsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

importUserEvents(request)

public importUserEvents(request: google.cloud.retail.v2.IImportUserEventsRequest): Promise<google.longrunning.Operation>;

Calls ImportUserEvents.

Parameter
Name Description
request IImportUserEventsRequest

ImportUserEventsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

purgeUserEvents(request, callback)

public purgeUserEvents(request: google.cloud.retail.v2.IPurgeUserEventsRequest, callback: google.cloud.retail.v2.UserEventService.PurgeUserEventsCallback): void;

Calls PurgeUserEvents.

Parameters
Name Description
request google.cloud.retail.v2.IPurgeUserEventsRequest

PurgeUserEventsRequest message or plain object
callback google.cloud.retail.v2.UserEventService.PurgeUserEventsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

purgeUserEvents(request)

public purgeUserEvents(request: google.cloud.retail.v2.IPurgeUserEventsRequest): Promise<google.longrunning.Operation>;

Calls PurgeUserEvents.

Parameter
Name Description
request google.cloud.retail.v2.IPurgeUserEventsRequest

PurgeUserEventsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

rejoinUserEvents(request, callback)

public rejoinUserEvents(request: google.cloud.retail.v2.IRejoinUserEventsRequest, callback: google.cloud.retail.v2.UserEventService.RejoinUserEventsCallback): void;

Calls RejoinUserEvents.

Parameters
Name Description
request google.cloud.retail.v2.IRejoinUserEventsRequest

RejoinUserEventsRequest message or plain object
callback google.cloud.retail.v2.UserEventService.RejoinUserEventsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

rejoinUserEvents(request)

public rejoinUserEvents(request: google.cloud.retail.v2.IRejoinUserEventsRequest): Promise<google.longrunning.Operation>;

Calls RejoinUserEvents.

Parameter
Name Description
request google.cloud.retail.v2.IRejoinUserEventsRequest

RejoinUserEventsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

writeUserEvent(request, callback)

public writeUserEvent(request: google.cloud.retail.v2.IWriteUserEventRequest, callback: google.cloud.retail.v2.UserEventService.WriteUserEventCallback): void;

Calls WriteUserEvent.

Parameters
Name Description
request google.cloud.retail.v2.IWriteUserEventRequest

WriteUserEventRequest message or plain object
callback google.cloud.retail.v2.UserEventService.WriteUserEventCallback

Node-style callback called with the error, if any, and UserEvent
Returns
Type Description
void

writeUserEvent(request)

public writeUserEvent(request: google.cloud.retail.v2.IWriteUserEventRequest): Promise<google.cloud.retail.v2.UserEvent>;

Calls WriteUserEvent.

Parameter
Name Description
request google.cloud.retail.v2.IWriteUserEventRequest

WriteUserEventRequest message or plain object
Returns
Type Description
Promise<google.cloud.retail.v2.UserEvent>

Promise