Class UserEventServiceGrpc.UserEventServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<UserEventServiceGrpc.UserEventServiceFutureStub>
com.google.cloud.discoveryengine.v1beta.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 a website to Discovery Engine API.
 
  • Method Details

    • build

      protected UserEventServiceGrpc.UserEventServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<UserEventServiceGrpc.UserEventServiceFutureStub>
    • 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<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 third-party domain.
       This method is used only by the Discovery Engine API JavaScript pixel and
       Google Tag Manager. Users should not call this method directly.
       
    • purgeUserEvents

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

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