Package com.google.cloud.retail.v2
Class UserEventServiceGrpc.UserEventServiceStub
- java.lang.Object
-
- io.grpc.stub.AbstractStub<S>
-
- io.grpc.stub.AbstractAsyncStub<UserEventServiceGrpc.UserEventServiceStub>
-
- com.google.cloud.retail.v2.UserEventServiceGrpc.UserEventServiceStub
-
- Enclosing class:
- UserEventServiceGrpc
public static final class UserEventServiceGrpc.UserEventServiceStub extends io.grpc.stub.AbstractAsyncStub<UserEventServiceGrpc.UserEventServiceStub>
A stub to allow clients to do asynchronous rpc calls to service UserEventService.Service for ingesting end user actions on the customer website.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected UserEventServiceGrpc.UserEventServiceStub
build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void
collectUserEvent(CollectUserEventRequest request, io.grpc.stub.StreamObserver<com.google.api.HttpBody> responseObserver)
Writes a single user event from the browser.void
importUserEvents(ImportUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Bulk import of User events.void
purgeUserEvents(PurgeUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Deletes permanently all user events specified by the filter provided.void
rejoinUserEvents(RejoinUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Starts a user-event rejoin operation with latest product catalog.void
writeUserEvent(WriteUserEventRequest request, io.grpc.stub.StreamObserver<UserEvent> responseObserver)
Writes a single user event.
-
-
-
Method Detail
-
build
protected UserEventServiceGrpc.UserEventServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
- Specified by:
build
in classio.grpc.stub.AbstractStub<UserEventServiceGrpc.UserEventServiceStub>
-
writeUserEvent
public void writeUserEvent(WriteUserEventRequest request, io.grpc.stub.StreamObserver<UserEvent> responseObserver)
Writes a single user event.
-
collectUserEvent
public void collectUserEvent(CollectUserEventRequest request, io.grpc.stub.StreamObserver<com.google.api.HttpBody> responseObserver)
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.
-
purgeUserEvents
public void purgeUserEvents(PurgeUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
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.
-
importUserEvents
public void importUserEvents(ImportUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
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`.
-
rejoinUserEvents
public void rejoinUserEvents(RejoinUserEventsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.
-
-