Package com.google.cloud.retail.v2alpha

Class UserEventServiceGrpc.UserEventServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

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

com.google.cloud.retail.v2alpha.UserEventServiceGrpc.UserEventServiceBlockingStub

Enclosing class:

UserEventServiceGrpc

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

A stub to allow clients to do synchronous rpc calls to service UserEventService.

 Service for ingesting end user actions on the customer website.
 

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.UserEventServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.api.HttpBody	collectUserEvent(CollectUserEventRequest request)	Writes a single user event from the browser.
com.google.longrunning.Operation	importUserEvents(ImportUserEventsRequest request)	Bulk import of User events.
com.google.longrunning.Operation	purgeUserEvents(PurgeUserEventsRequest request)	Deletes permanently all user events specified by the filter provided.
com.google.longrunning.Operation	rejoinUserEvents(RejoinUserEventsRequest request)	Starts a user-event rejoin operation with latest product catalog.
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, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected UserEventServiceGrpc.UserEventServiceBlockingStub build(io.grpc.Channel channel,
                                                                  io.grpc.CallOptions callOptions)

Specified by:

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

writeUserEvent

public UserEvent writeUserEvent(WriteUserEventRequest request)

 Writes a single user event.
 

collectUserEvent

public 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 Retail API JavaScript pixel and Google Tag
 Manager. Users should not call this method directly.
 

purgeUserEvents

public 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.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`.
 

rejoinUserEvents

public com.google.longrunning.Operation rejoinUserEvents(RejoinUserEventsRequest request)

 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.