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
- request_pb (::Google::Cloud::Retail::V2::AddCatalogAttributeRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::AttributesConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::AttributesConfig) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (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
- request_pb (::Google::Cloud::Retail::V2::GetAttributesConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::AttributesConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::AttributesConfig) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Retail::V2::GetCompletionConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::CompletionConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::CompletionConfig) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Retail::V2::GetDefaultBranchRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::GetDefaultBranchResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::GetDefaultBranchResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_catalogs
def list_catalogs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Retail::V2::ListCatalogsResponse
Baseline implementation for the list_catalogs REST call
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::ListCatalogsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::ListCatalogsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#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
- request_pb (::Google::Cloud::Retail::V2::RemoveCatalogAttributeRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::AttributesConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::AttributesConfig) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Retail::V2::ReplaceCatalogAttributeRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::AttributesConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::AttributesConfig) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Retail::V2::SetDefaultBranchRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (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
- request_pb (::Google::Cloud::Retail::V2::UpdateAttributesConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::AttributesConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::AttributesConfig) — A result object deserialized from the server's reply
- (::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
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::Catalog)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::Catalog) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Retail::V2::UpdateCompletionConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Retail::V2::CompletionConfig)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Retail::V2::CompletionConfig) — A result object deserialized from the server's reply
- (::ArgumentError)