public static final class UserEventServiceGrpc.UserEventServiceFutureStub extends AbstractFutureStub<UserEventServiceGrpc.UserEventServiceFutureStub>
Service for ingesting end user actions on the customer website.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractFutureStub >
UserEventServiceGrpc.UserEventServiceFutureStub
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected UserEventServiceGrpc.UserEventServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
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 Retail API JavaScript pixel and Google Tag
Manager. Users should not call this method directly.
Parameter
Returns
Type | Description |
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
rejoinUserEvents(RejoinUserEventsRequest request)
public ListenableFuture<Operation> rejoinUserEvents(RejoinUserEventsRequest request)
Starts a user event rejoin operation with latest product catalog. Events
will not be annotated with detailed product information if product is
missing from the catalog at the time the user event is ingested, and these
events are stored as unjoined events with a limited usage on training and
serving. This method can be used to start a join operation on specified
events with latest version of product catalog. It can also be used to
correct events joined with the wrong product catalog. A rejoin operation
can take hours or days to complete.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
writeUserEvent(WriteUserEventRequest request)
public ListenableFuture<UserEvent> writeUserEvent(WriteUserEventRequest request)
Writes a single user event.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<UserEvent> | |