Class ProductSearch.ProductSearchClient (2.5.0)

public class ProductSearchClient : ClientBase<ProductSearch.ProductSearchClient>

Client for ProductSearch

Inheritance

Object > ClientBase > ClientBase<ProductSearch.ProductSearchClient> > ProductSearch.ProductSearchClient

Inherited Members

ClientBase<ProductSearch.ProductSearchClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

ProductSearchClient()

protected ProductSearchClient()

Protected parameterless constructor to allow creation of test doubles.

ProductSearchClient(CallInvoker)

public ProductSearchClient(CallInvoker callInvoker)

Creates a new client for ProductSearch that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

ProductSearchClient(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public ProductSearchClient(Channel channel)

Creates a new client using a channel.

Parameter
Name	Description
`channel`	`Grpc.Core.Channel` The channel to use to make remote calls.

ProductSearchClient(ChannelBase)

public ProductSearchClient(ChannelBase channel)

Creates a new client for ProductSearch

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

ProductSearchClient(ClientBase.ClientBaseConfiguration)

protected ProductSearchClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

AddProductToProductSet(AddProductToProductSetRequest, CallOptions)

public virtual Empty AddProductToProductSet(AddProductToProductSetRequest request, CallOptions options)

Adds a Product to the specified ProductSet. If the Product is already present, no change is made.

One Product can be added to at most 100 ProductSets.

Possible errors:

Returns NOT_FOUND if the Product or the ProductSet doesn't exist.

Parameters
Name	Description
`request`	`AddProductToProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

AddProductToProductSet(AddProductToProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty AddProductToProductSet(AddProductToProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Adds a Product to the specified ProductSet. If the Product is already present, no change is made.

One Product can be added to at most 100 ProductSets.

Possible errors:

Returns NOT_FOUND if the Product or the ProductSet doesn't exist.

Parameters
Name	Description
`request`	`AddProductToProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

AddProductToProductSetAsync(AddProductToProductSetRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> AddProductToProductSetAsync(AddProductToProductSetRequest request, CallOptions options)

Adds a Product to the specified ProductSet. If the Product is already present, no change is made.

One Product can be added to at most 100 ProductSets.

Possible errors:

Returns NOT_FOUND if the Product or the ProductSet doesn't exist.

Parameters
Name	Description
`request`	`AddProductToProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

AddProductToProductSetAsync(AddProductToProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> AddProductToProductSetAsync(AddProductToProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Adds a Product to the specified ProductSet. If the Product is already present, no change is made.

One Product can be added to at most 100 ProductSets.

Possible errors:

Returns NOT_FOUND if the Product or the ProductSet doesn't exist.

Parameters
Name	Description
`request`	`AddProductToProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`Operations.OperationsClient`	A new Operations client for the same target as this client.

CreateProduct(CreateProductRequest, CallOptions)

public virtual Product CreateProduct(CreateProductRequest request, CallOptions options)

Creates and returns a new product resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if description is longer than 4096 characters.
Returns INVALID_ARGUMENT if product_category is missing or invalid.

Parameters
Name	Description
`request`	`CreateProductRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Product`	The response received from the server.

CreateProduct(CreateProductRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Product CreateProduct(CreateProductRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates and returns a new product resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if description is longer than 4096 characters.
Returns INVALID_ARGUMENT if product_category is missing or invalid.

Parameters
Name	Description
`request`	`CreateProductRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Product`	The response received from the server.

CreateProductAsync(CreateProductRequest, CallOptions)

public virtual AsyncUnaryCall<Product> CreateProductAsync(CreateProductRequest request, CallOptions options)

Creates and returns a new product resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if description is longer than 4096 characters.
Returns INVALID_ARGUMENT if product_category is missing or invalid.

Parameters
Name	Description
`request`	`CreateProductRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Product>`	The call object.

CreateProductAsync(CreateProductRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Product> CreateProductAsync(CreateProductRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates and returns a new product resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if description is longer than 4096 characters.
Returns INVALID_ARGUMENT if product_category is missing or invalid.

Parameters
Name	Description
`request`	`CreateProductRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Product>`	The call object.

CreateProductSet(CreateProductSetRequest, CallOptions)

public virtual ProductSet CreateProductSet(CreateProductSetRequest request, CallOptions options)

Creates and returns a new ProductSet resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Parameters
Name	Description
`request`	`CreateProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ProductSet`	The response received from the server.

CreateProductSet(CreateProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ProductSet CreateProductSet(CreateProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates and returns a new ProductSet resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Parameters
Name	Description
`request`	`CreateProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ProductSet`	The response received from the server.

CreateProductSetAsync(CreateProductSetRequest, CallOptions)

public virtual AsyncUnaryCall<ProductSet> CreateProductSetAsync(CreateProductSetRequest request, CallOptions options)

Creates and returns a new ProductSet resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Parameters
Name	Description
`request`	`CreateProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ProductSet>`	The call object.

CreateProductSetAsync(CreateProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ProductSet> CreateProductSetAsync(CreateProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates and returns a new ProductSet resource.

Possible errors:

Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Parameters
Name	Description
`request`	`CreateProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ProductSet>`	The call object.

CreateReferenceImage(CreateReferenceImageRequest, CallOptions)

public virtual ReferenceImage CreateReferenceImage(CreateReferenceImageRequest request, CallOptions options)

Creates and returns a new ReferenceImage resource.

The bounding_poly field is optional. If bounding_poly is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles.

Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP).

Possible errors:

Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if the product does not exist.
Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected.
Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Parameters
Name	Description
`request`	`CreateReferenceImageRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ReferenceImage`	The response received from the server.

CreateReferenceImage(CreateReferenceImageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ReferenceImage CreateReferenceImage(CreateReferenceImageRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates and returns a new ReferenceImage resource.

Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP).

Possible errors:

Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if the product does not exist.
Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected.
Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Parameters
Name	Description
`request`	`CreateReferenceImageRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ReferenceImage`	The response received from the server.

CreateReferenceImageAsync(CreateReferenceImageRequest, CallOptions)

public virtual AsyncUnaryCall<ReferenceImage> CreateReferenceImageAsync(CreateReferenceImageRequest request, CallOptions options)

Creates and returns a new ReferenceImage resource.

Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP).

Possible errors:

Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if the product does not exist.
Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected.
Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Parameters
Name	Description
`request`	`CreateReferenceImageRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ReferenceImage>`	The call object.

CreateReferenceImageAsync(CreateReferenceImageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ReferenceImage> CreateReferenceImageAsync(CreateReferenceImageRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates and returns a new ReferenceImage resource.

Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP).

Possible errors:

Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters.
Returns INVALID_ARGUMENT if the product does not exist.
Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected.
Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Parameters
Name	Description
`request`	`CreateReferenceImageRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ReferenceImage>`	The call object.

DeleteProduct(DeleteProductRequest, CallOptions)

public virtual Empty DeleteProduct(DeleteProductRequest request, CallOptions options)

Permanently deletes a product and its reference images.

Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.

Parameters
Name	Description
`request`	`DeleteProductRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteProduct(DeleteProductRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteProduct(DeleteProductRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Permanently deletes a product and its reference images.

Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.

Parameters
Name	Description
`request`	`DeleteProductRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteProductAsync(DeleteProductRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteProductAsync(DeleteProductRequest request, CallOptions options)

Permanently deletes a product and its reference images.

Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.

Parameters
Name	Description
`request`	`DeleteProductRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

DeleteProductAsync(DeleteProductRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteProductAsync(DeleteProductRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Permanently deletes a product and its reference images.

Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.

Parameters
Name	Description
`request`	`DeleteProductRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

DeleteProductSet(DeleteProductSetRequest, CallOptions)

public virtual Empty DeleteProductSet(DeleteProductSetRequest request, CallOptions options)

Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteProductSet(DeleteProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteProductSet(DeleteProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteProductSetAsync(DeleteProductSetRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteProductSetAsync(DeleteProductSetRequest request, CallOptions options)

Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

DeleteProductSetAsync(DeleteProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteProductSetAsync(DeleteProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

DeleteReferenceImage(DeleteReferenceImageRequest, CallOptions)

public virtual Empty DeleteReferenceImage(DeleteReferenceImageRequest request, CallOptions options)

Permanently deletes a reference image.

The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteReferenceImageRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteReferenceImage(DeleteReferenceImageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteReferenceImage(DeleteReferenceImageRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Permanently deletes a reference image.

The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteReferenceImageRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteReferenceImageAsync(DeleteReferenceImageRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteReferenceImageAsync(DeleteReferenceImageRequest request, CallOptions options)

Permanently deletes a reference image.

The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteReferenceImageRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

DeleteReferenceImageAsync(DeleteReferenceImageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteReferenceImageAsync(DeleteReferenceImageRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Permanently deletes a reference image.

The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.

The actual image files are not deleted from Google Cloud Storage.

Parameters
Name	Description
`request`	`DeleteReferenceImageRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

GetProduct(GetProductRequest, CallOptions)

public virtual Product GetProduct(GetProductRequest request, CallOptions options)

Gets information associated with a Product.

Possible errors:

Returns NOT_FOUND if the Product does not exist.

Parameters
Name	Description
`request`	`GetProductRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Product`	The response received from the server.

GetProduct(GetProductRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Product GetProduct(GetProductRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets information associated with a Product.

Possible errors:

Returns NOT_FOUND if the Product does not exist.

Parameters
Name	Description
`request`	`GetProductRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Product`	The response received from the server.

GetProductAsync(GetProductRequest, CallOptions)

public virtual AsyncUnaryCall<Product> GetProductAsync(GetProductRequest request, CallOptions options)

Gets information associated with a Product.

Possible errors:

Returns NOT_FOUND if the Product does not exist.

Parameters
Name	Description
`request`	`GetProductRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Product>`	The call object.

GetProductAsync(GetProductRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Product> GetProductAsync(GetProductRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets information associated with a Product.

Possible errors:

Returns NOT_FOUND if the Product does not exist.

Parameters
Name	Description
`request`	`GetProductRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Product>`	The call object.

GetProductSet(GetProductSetRequest, CallOptions)

public virtual ProductSet GetProductSet(GetProductSetRequest request, CallOptions options)

Gets information associated with a ProductSet.

Possible errors:

Returns NOT_FOUND if the ProductSet does not exist.

Parameters
Name	Description
`request`	`GetProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ProductSet`	The response received from the server.

GetProductSet(GetProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ProductSet GetProductSet(GetProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets information associated with a ProductSet.

Possible errors:

Returns NOT_FOUND if the ProductSet does not exist.

Parameters
Name	Description
`request`	`GetProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ProductSet`	The response received from the server.

GetProductSetAsync(GetProductSetRequest, CallOptions)

public virtual AsyncUnaryCall<ProductSet> GetProductSetAsync(GetProductSetRequest request, CallOptions options)

Gets information associated with a ProductSet.

Possible errors:

Returns NOT_FOUND if the ProductSet does not exist.

Parameters
Name	Description
`request`	`GetProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ProductSet>`	The call object.

GetProductSetAsync(GetProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ProductSet> GetProductSetAsync(GetProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets information associated with a ProductSet.

Possible errors:

Returns NOT_FOUND if the ProductSet does not exist.

Parameters
Name	Description
`request`	`GetProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ProductSet>`	The call object.

GetReferenceImage(GetReferenceImageRequest, CallOptions)

public virtual ReferenceImage GetReferenceImage(GetReferenceImageRequest request, CallOptions options)

Gets information associated with a ReferenceImage.

Possible errors:

Returns NOT_FOUND if the specified image does not exist.

Parameters
Name	Description
`request`	`GetReferenceImageRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ReferenceImage`	The response received from the server.

GetReferenceImage(GetReferenceImageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ReferenceImage GetReferenceImage(GetReferenceImageRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets information associated with a ReferenceImage.

Possible errors:

Returns NOT_FOUND if the specified image does not exist.

Parameters
Name	Description
`request`	`GetReferenceImageRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ReferenceImage`	The response received from the server.

GetReferenceImageAsync(GetReferenceImageRequest, CallOptions)

public virtual AsyncUnaryCall<ReferenceImage> GetReferenceImageAsync(GetReferenceImageRequest request, CallOptions options)

Gets information associated with a ReferenceImage.

Possible errors:

Returns NOT_FOUND if the specified image does not exist.

Parameters
Name	Description
`request`	`GetReferenceImageRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ReferenceImage>`	The call object.

GetReferenceImageAsync(GetReferenceImageRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ReferenceImage> GetReferenceImageAsync(GetReferenceImageRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets information associated with a ReferenceImage.

Possible errors:

Returns NOT_FOUND if the specified image does not exist.

Parameters
Name	Description
`request`	`GetReferenceImageRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ReferenceImage>`	The call object.

ImportProductSets(ImportProductSetsRequest, CallOptions)

public virtual Operation ImportProductSets(ImportProductSetsRequest request, CallOptions options)

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the progress and results of the request. Operation.metadata contains BatchOperationMetadata. (progress) Operation.response contains ImportProductSetsResponse. (results)

The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri].

Parameters
Name	Description
`request`	`ImportProductSetsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

ImportProductSets(ImportProductSetsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ImportProductSets(ImportProductSetsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

Parameters
Name	Description
`request`	`ImportProductSetsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

ImportProductSetsAsync(ImportProductSetsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportProductSetsAsync(ImportProductSetsRequest request, CallOptions options)

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

Parameters
Name	Description
`request`	`ImportProductSetsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

ImportProductSetsAsync(ImportProductSetsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportProductSetsAsync(ImportProductSetsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

Parameters
Name	Description
`request`	`ImportProductSetsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

ListProducts(ListProductsRequest, CallOptions)

public virtual ListProductsResponse ListProducts(ListProductsRequest request, CallOptions options)

Lists products in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
Name	Description
`request`	`ListProductsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListProductsResponse`	The response received from the server.

ListProducts(ListProductsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListProductsResponse ListProducts(ListProductsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists products in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
Name	Description
`request`	`ListProductsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListProductsResponse`	The response received from the server.

ListProductsAsync(ListProductsRequest, CallOptions)

public virtual AsyncUnaryCall<ListProductsResponse> ListProductsAsync(ListProductsRequest request, CallOptions options)

Lists products in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
Name	Description
`request`	`ListProductsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListProductsResponse>`	The call object.

ListProductsAsync(ListProductsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListProductsResponse> ListProductsAsync(ListProductsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists products in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
Name	Description
`request`	`ListProductsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ListProductsResponse>`	The call object.

ListProductSets(ListProductSetsRequest, CallOptions)

public virtual ListProductSetsResponse ListProductSets(ListProductSetsRequest request, CallOptions options)

Lists ProductSets in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Parameters
Name	Description
`request`	`ListProductSetsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListProductSetsResponse`	The response received from the server.

ListProductSets(ListProductSetsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListProductSetsResponse ListProductSets(ListProductSetsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists ProductSets in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Parameters
Name	Description
`request`	`ListProductSetsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListProductSetsResponse`	The response received from the server.

ListProductSetsAsync(ListProductSetsRequest, CallOptions)

public virtual AsyncUnaryCall<ListProductSetsResponse> ListProductSetsAsync(ListProductSetsRequest request, CallOptions options)

Lists ProductSets in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Parameters
Name	Description
`request`	`ListProductSetsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListProductSetsResponse>`	The call object.

ListProductSetsAsync(ListProductSetsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListProductSetsResponse> ListProductSetsAsync(ListProductSetsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists ProductSets in an unspecified order.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Parameters
Name	Description
`request`	`ListProductSetsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ListProductSetsResponse>`	The call object.

ListProductsInProductSet(ListProductsInProductSetRequest, CallOptions)

public virtual ListProductsInProductSetResponse ListProductsInProductSet(ListProductsInProductSetRequest request, CallOptions options)

Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
Name	Description
`request`	`ListProductsInProductSetRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListProductsInProductSetResponse`	The response received from the server.

ListProductsInProductSet(ListProductsInProductSetRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListProductsInProductSetResponse ListProductsInProductSet(ListProductsInProductSetRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty.

Possible errors:

Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
Name	Description
`request`	`ListProductsInProductSetRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`