Package com.google.cloud.discoveryengine.v1beta

Class UserEventServiceGrpc.UserEventServiceBlockingV2Stub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<UserEventServiceGrpc.UserEventServiceBlockingV2Stub>

com.google.cloud.discoveryengine.v1beta.UserEventServiceGrpc.UserEventServiceBlockingV2Stub

Enclosing class:

UserEventServiceGrpc

public static final class UserEventServiceGrpc.UserEventServiceBlockingV2Stub
extends io.grpc.stub.AbstractBlockingStub<UserEventServiceGrpc.UserEventServiceBlockingV2Stub>

A stub to allow clients to do synchronous 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.UserEventServiceBlockingV2Stub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
HttpBody	collectUserEvent(CollectUserEventRequest request)	Writes a single user event from the browser.
Operation	importUserEvents(ImportUserEventsRequest request)	Bulk import of user events.
Operation	purgeUserEvents(PurgeUserEventsRequest request)	Deletes permanently all user events specified by the filter provided.
UserEvent	writeUserEvent(WriteUserEventRequest request)	Writes a single user event.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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.UserEventServiceBlockingV2Stub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<UserEventServiceGrpc.UserEventServiceBlockingV2Stub>

writeUserEvent

public UserEvent writeUserEvent(WriteUserEventRequest request)
                         throws io.grpc.StatusException

 Writes a single user event.
 

Throws:

io.grpc.StatusException

collectUserEvent

public HttpBody collectUserEvent(CollectUserEventRequest request)
                          throws io.grpc.StatusException

 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.
 

Throws:

io.grpc.StatusException

purgeUserEvents

public Operation purgeUserEvents(PurgeUserEventsRequest request)
                          throws io.grpc.StatusException

 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.
 

Throws:

io.grpc.StatusException

importUserEvents

public Operation importUserEvents(ImportUserEventsRequest request)
                           throws io.grpc.StatusException

 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.
 

Throws:

io.grpc.StatusException