Cloud Vision V1p4beta1 API - Class Google::Cloud::Vision::V1p4beta1::ProductSearch::Rest::ServiceStub (v0.7.2)

Version 0.7.2

• 0.8.1 (latest)
• 0.8.0
• 0.7.2
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.2

Reference documentation and code samples for the Cloud Vision V1p4beta1 API class Google::Cloud::Vision::V1p4beta1::ProductSearch::Rest::ServiceStub.

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

Inherits

• Object

Methods

#add_product_to_product_set

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

Baseline implementation for the add_product_to_product_set REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::AddProductToProductSetRequest) — 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)

#create_product

def create_product(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::Product

Baseline implementation for the create_product REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::CreateProductRequest) — 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::Vision::V1p4beta1::Product)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::Product) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_product_set

def create_product_set(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ProductSet

Baseline implementation for the create_product_set REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::CreateProductSetRequest) — 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::Vision::V1p4beta1::ProductSet)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ProductSet) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_reference_image

def create_reference_image(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ReferenceImage

Baseline implementation for the create_reference_image REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::CreateReferenceImageRequest) — 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::Vision::V1p4beta1::ReferenceImage)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ReferenceImage) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_product

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

Baseline implementation for the delete_product REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::DeleteProductRequest) — 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)

#delete_product_set

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

Baseline implementation for the delete_product_set REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::DeleteProductSetRequest) — 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)

#delete_reference_image

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

Baseline implementation for the delete_reference_image REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::DeleteReferenceImageRequest) — 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_product

def get_product(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::Product

Baseline implementation for the get_product REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::GetProductRequest) — 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::Vision::V1p4beta1::Product)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::Product) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_product_set

def get_product_set(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ProductSet

Baseline implementation for the get_product_set REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::GetProductSetRequest) — 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::Vision::V1p4beta1::ProductSet)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ProductSet) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_reference_image

def get_reference_image(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ReferenceImage

Baseline implementation for the get_reference_image REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::GetReferenceImageRequest) — 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::Vision::V1p4beta1::ReferenceImage)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ReferenceImage) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#import_product_sets

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

Baseline implementation for the import_product_sets REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::ImportProductSetsRequest) — 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_product_sets

def list_product_sets(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ListProductSetsResponse

Baseline implementation for the list_product_sets REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::ListProductSetsRequest) — 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::Vision::V1p4beta1::ListProductSetsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ListProductSetsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_products

def list_products(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ListProductsResponse

Baseline implementation for the list_products REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::ListProductsRequest) — 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::Vision::V1p4beta1::ListProductsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ListProductsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_products_in_product_set

def list_products_in_product_set(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ListProductsInProductSetResponse

Baseline implementation for the list_products_in_product_set REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::ListProductsInProductSetRequest) — 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::Vision::V1p4beta1::ListProductsInProductSetResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ListProductsInProductSetResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_reference_images

def list_reference_images(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ListReferenceImagesResponse

Baseline implementation for the list_reference_images REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::ListReferenceImagesRequest) — 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::Vision::V1p4beta1::ListReferenceImagesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ListReferenceImagesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#purge_products

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

Baseline implementation for the purge_products REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::PurgeProductsRequest) — 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)

#remove_product_from_product_set

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

Baseline implementation for the remove_product_from_product_set REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::RemoveProductFromProductSetRequest) — 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)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_product

def update_product(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::Product

Baseline implementation for the update_product REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::UpdateProductRequest) — 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::Vision::V1p4beta1::Product)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::Product) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_product_set

def update_product_set(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Vision::V1p4beta1::ProductSet

Baseline implementation for the update_product_set REST call

Parameters

• request_pb (::Google::Cloud::Vision::V1p4beta1::UpdateProductSetRequest) — 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::Vision::V1p4beta1::ProductSet)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Vision::V1p4beta1::ProductSet) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)