Retail V2 API - Class Google::Cloud::Retail::V2::CatalogService::Rest::ServiceStub (v1.2.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::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

#add_catalog_attribute

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

Baseline implementation for the add_catalog_attribute REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_attributes_config

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

Baseline implementation for the get_attributes_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_completion_config

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

Baseline implementation for the get_completion_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_default_branch

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

Baseline implementation for the get_default_branch REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_catalogs

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

Baseline implementation for the list_catalogs REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::ListCatalogsRequest) — 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
Returns
Raises
  • (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#remove_catalog_attribute

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

Baseline implementation for the remove_catalog_attribute REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#replace_catalog_attribute

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

Baseline implementation for the replace_catalog_attribute REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#set_default_branch

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

Baseline implementation for the set_default_branch REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_attributes_config

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

Baseline implementation for the update_attributes_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_catalog

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

Baseline implementation for the update_catalog REST call

Parameters
  • request_pb (::Google::Cloud::Retail::V2::UpdateCatalogRequest) — 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
Returns
Raises
  • (::ArgumentError)

#update_completion_config

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

Baseline implementation for the update_completion_config REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)