Recommendations AI V1beta1 API - Class Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Rest::ServiceStub (v0.8.2)

Reference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Rest::ServiceStub.

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

Inherits

Object

Methods

#create_catalog_item

def create_catalog_item(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

Baseline implementation for the create_catalog_item REST call

Parameters

request_pb (::Google::Cloud::RecommendationEngine::V1beta1::CreateCatalogItemRequest) — 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::RecommendationEngine::V1beta1::CatalogItem)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_catalog_item

def delete_catalog_item(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_catalog_item REST call

Parameters

request_pb (::Google::Cloud::RecommendationEngine::V1beta1::DeleteCatalogItemRequest) — 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::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get_catalog_item

def get_catalog_item(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

Baseline implementation for the get_catalog_item REST call

Parameters

request_pb (::Google::Cloud::RecommendationEngine::V1beta1::GetCatalogItemRequest) — 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::RecommendationEngine::V1beta1::CatalogItem)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#import_catalog_items

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

Baseline implementation for the import_catalog_items REST call

Parameters

request_pb (::Google::Cloud::RecommendationEngine::V1beta1::ImportCatalogItemsRequest) — 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

#list_catalog_items

def list_catalog_items(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsResponse

Baseline implementation for the list_catalog_items REST call

Parameters

request_pb (::Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsRequest) — 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::RecommendationEngine::V1beta1::ListCatalogItemsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::RecommendationEngine::V1beta1::ListCatalogItemsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_catalog_item

def update_catalog_item(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem

Baseline implementation for the update_catalog_item REST call

Parameters

request_pb (::Google::Cloud::RecommendationEngine::V1beta1::UpdateCatalogItemRequest) — 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::RecommendationEngine::V1beta1::CatalogItem)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::RecommendationEngine::V1beta1::CatalogItem) — A result object deserialized from the server's reply

Raises

(::ArgumentError)