Class UserEventServiceGrpc.UserEventServiceFutureStub

  • Enclosing class:
    UserEventServiceGrpc

    public static final class UserEventServiceGrpc.UserEventServiceFutureStub
    extends io.grpc.stub.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.
     
    • Method Detail

      • writeUserEvent

        public com.google.common.util.concurrent.ListenableFuture<UserEvent> writeUserEvent​(WriteUserEventRequest request)
         Writes a single user event.
         
      • collectUserEvent

        public com.google.common.util.concurrent.ListenableFuture<com.google.api.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.
         
      • listUserEvents

        public com.google.common.util.concurrent.ListenableFuture<ListUserEventsResponse> listUserEvents​(ListUserEventsRequest request)
         Gets a list of user events within a time range, with potential filtering.
         
      • purgeUserEvents

        public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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.
         
      • importUserEvents

        public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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.