Class protos.google.cloud.discoveryengine.v1.UserEventService (1.14.0)

Represents a UserEventService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1.UserEventService

Package

@google-cloud/discoveryengine

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.discoveryengine.v1.ICollectUserEventRequest, callback: google.cloud.discoveryengine.v1.UserEventService.CollectUserEventCallback): void;

Calls CollectUserEvent.

Parameters
Name Description
request ICollectUserEventRequest

CollectUserEventRequest message or plain object

callback CollectUserEventCallback

Node-style callback called with the error, if any, and HttpBody

Returns
Type Description
void

collectUserEvent(request)

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

Calls CollectUserEvent.

Parameter
Name Description
request 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.discoveryengine.v1.IImportUserEventsRequest, callback: google.cloud.discoveryengine.v1.UserEventService.ImportUserEventsCallback): void;

Calls ImportUserEvents.

Parameters
Name Description
request IImportUserEventsRequest

ImportUserEventsRequest message or plain object

callback ImportUserEventsCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

importUserEvents(request)

public importUserEvents(request: google.cloud.discoveryengine.v1.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.discoveryengine.v1.IPurgeUserEventsRequest, callback: google.cloud.discoveryengine.v1.UserEventService.PurgeUserEventsCallback): void;

Calls PurgeUserEvents.

Parameters
Name Description
request IPurgeUserEventsRequest

PurgeUserEventsRequest message or plain object

callback PurgeUserEventsCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

purgeUserEvents(request)

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

Calls PurgeUserEvents.

Parameter
Name Description
request IPurgeUserEventsRequest

PurgeUserEventsRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

writeUserEvent(request, callback)

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

Calls WriteUserEvent.

Parameters
Name Description
request IWriteUserEventRequest

WriteUserEventRequest message or plain object

callback WriteUserEventCallback

Node-style callback called with the error, if any, and UserEvent

Returns
Type Description
void

writeUserEvent(request)

public writeUserEvent(request: google.cloud.discoveryengine.v1.IWriteUserEventRequest): Promise<google.cloud.discoveryengine.v1.UserEvent>;

Calls WriteUserEvent.

Parameter
Name Description
request IWriteUserEventRequest

WriteUserEventRequest message or plain object

Returns
Type Description
Promise<google.cloud.discoveryengine.v1.UserEvent>

Promise