Retail V2 API - Class Google::Cloud::Retail::V2::UserEventService::Rest::ServiceStub (v0.18.2)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::UserEventService::Rest::ServiceStub.

REST service stub for the UserEventService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

Object

Methods

#collect_user_event

def collect_user_event(request_pb, options = nil) { |result, operation| ... } -> ::Google::Api::HttpBody

Baseline implementation for the collect_user_event REST call

Parameters

request_pb (::Google::Cloud::Retail::V2::CollectUserEventRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Api::HttpBody)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Api::HttpBody) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#import_user_events

def import_user_events(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the import_user_events REST call

Parameters

request_pb (::Google::Cloud::Retail::V2::ImportUserEventsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#purge_user_events

def purge_user_events(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the purge_user_events REST call

Parameters

request_pb (::Google::Cloud::Retail::V2::PurgeUserEventsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#rejoin_user_events

def rejoin_user_events(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the rejoin_user_events REST call

Parameters

request_pb (::Google::Cloud::Retail::V2::RejoinUserEventsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#write_user_event

def write_user_event(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Retail::V2::UserEvent

Baseline implementation for the write_user_event REST call

Parameters

request_pb (::Google::Cloud::Retail::V2::WriteUserEventRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Retail::V2::UserEvent)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Retail::V2::UserEvent) — A result object deserialized from the server's reply

Raises

(::ArgumentError)