Package com.google.cloud.discoveryengine.v1

Class UserEventServiceGrpc.UserEventServiceStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractAsyncStub<UserEventServiceGrpc.UserEventServiceStub>
com.google.cloud.discoveryengine.v1.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 a website to Discovery Engine API.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

  • Method Summary

    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<HttpBody> responseObserver)
    Writes a single user event from the browser.
    void
    importUserEvents(ImportUserEventsRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
    Bulk import of user events.
    void
    purgeUserEvents(PurgeUserEventsRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
    Deletes permanently all user events specified by the filter provided.
    void
    writeUserEvent(WriteUserEventRequest request, io.grpc.stub.StreamObserver<UserEvent> responseObserver)
    Writes a single user event.

    Methods inherited from class io.grpc.stub.AbstractAsyncStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • build

      protected UserEventServiceGrpc.UserEventServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.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<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 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 void purgeUserEvents(PurgeUserEventsRequest request, io.grpc.stub.StreamObserver<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<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.