Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Retail V2 API - Class Google::Cloud::Retail::V2::SearchService::Rest::ServiceStub (v1.0.1)

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

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

Inherits

Object

Methods

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#initialize

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

Returns

(ServiceStub) — a new instance of ServiceStub

#search

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

Baseline implementation for the search REST call

Parameters

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

Returns

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

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)