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

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

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

Inherits

Object

Methods

#complete_query

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

Baseline implementation for the complete_query REST call

Parameters

request_pb (::Google::Cloud::Retail::V2::CompleteQueryRequest) — 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::CompleteQueryResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#import_completion_data

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

Baseline implementation for the import_completion_data REST call

Parameters

request_pb (::Google::Cloud::Retail::V2::ImportCompletionDataRequest) — 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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)