Class UserEventServiceGrpc.UserEventServiceFutureStub (0.31.0)

public static final class UserEventServiceGrpc.UserEventServiceFutureStub extends AbstractFutureStub<UserEventServiceGrpc.UserEventServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service UserEventService.

Service for ingesting end user actions on the customer website.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > UserEventServiceGrpc.UserEventServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected UserEventServiceGrpc.UserEventServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
UserEventServiceGrpc.UserEventServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

collectUserEvent(CollectUserEventRequest request)

public ListenableFuture<HttpBody> collectUserEvent(CollectUserEventRequest request)

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.

Parameter
NameDescription
requestCollectUserEventRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<com.google.api.HttpBody>

importUserEvents(ImportUserEventsRequest request)

public ListenableFuture<Operation> importUserEvents(ImportUserEventsRequest request)

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.

Parameter
NameDescription
requestImportUserEventsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

listUserEvents(ListUserEventsRequest request)

public ListenableFuture<ListUserEventsResponse> listUserEvents(ListUserEventsRequest request)

Gets a list of user events within a time range, with potential filtering.

Parameter
NameDescription
requestListUserEventsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListUserEventsResponse>

purgeUserEvents(PurgeUserEventsRequest request)

public ListenableFuture<Operation> purgeUserEvents(PurgeUserEventsRequest request)

Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

Parameter
NameDescription
requestPurgeUserEventsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

writeUserEvent(WriteUserEventRequest request)

public ListenableFuture<UserEvent> writeUserEvent(WriteUserEventRequest request)

Writes a single user event.

Parameter
NameDescription
requestWriteUserEventRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<UserEvent>