com.google.api.services.vision.v1

Class Vision.Projects.Locations.Products

java.lang.Object

com.google.api.services.vision.v1.Vision.Projects.Locations.Products

Enclosing class:

Vision.Projects.Locations

public class Vision.Projects.Locations.Products
extends Object

The "products" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Vision.Projects.Locations.Products.Create
class	Vision.Projects.Locations.Products.Delete
class	Vision.Projects.Locations.Products.Get
class	Vision.Projects.Locations.Products.List
class	Vision.Projects.Locations.Products.Patch
class	Vision.Projects.Locations.Products.Purge
class	Vision.Projects.Locations.Products.ReferenceImages The "referenceImages" collection of methods.

Constructor Summary

Constructors

Constructor and Description
Products()

Method Summary

Modifier and Type	Method and Description
Vision.Projects.Locations.Products.Create	create(String parent, Product content) Creates and returns a new product resource.
Vision.Projects.Locations.Products.Delete	delete(String name) Permanently deletes a product and its reference images.
Vision.Projects.Locations.Products.Get	get(String name) Gets information associated with a Product.
Vision.Projects.Locations.Products.List	list(String parent) Lists products in an unspecified order.
Vision.Projects.Locations.Products.Patch	patch(String name, Product content) Makes changes to a Product resource.
Vision.Projects.Locations.Products.Purge	purge(String parent, PurgeProductsRequest content) Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
Vision.Projects.Locations.Products.ReferenceImages	referenceImages() An accessor for creating requests from the ReferenceImages collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Products

public Products()

Method Detail

create

public Vision.Projects.Locations.Products.Create create(String parent,
                                                        Product content)
                                                 throws IOException

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. Create a request for the method "products.create". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`.

content - the Product

Returns:

the request

Throws:

IOException

delete

public Vision.Projects.Locations.Products.Delete delete(String name)
                                                 throws IOException

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. Create a request for the method "products.delete". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Returns:

the request

Throws:

IOException

get

public Vision.Projects.Locations.Products.Get get(String name)
                                           throws IOException

Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist. Create a request for the method "products.get". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Returns:

the request

Throws:

IOException

list

public Vision.Projects.Locations.Products.List list(String parent)
                                             throws IOException

Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. Create a request for the method "products.list". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID`

Returns:

the request

Throws:

IOException

patch

public Vision.Projects.Locations.Products.Patch patch(String name,
                                                      Product content)
                                               throws IOException

Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask. Create a request for the method "products.patch". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.

content - the Product

Returns:

the request

Throws:

IOException

purge

public Vision.Projects.Locations.Products.Purge purge(String parent,
                                                      PurgeProductsRequest content)
                                               throws IOException

Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted. It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted. It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion. If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) Create a request for the method "products.purge". This request holds the parameters needed by the vision server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`.

content - the PurgeProductsRequest

Returns:

the request

Throws:

IOException

referenceImages

public Vision.Projects.Locations.Products.ReferenceImages referenceImages()

An accessor for creating requests from the ReferenceImages collection.

The typical use is:

    Vision vision = new Vision(...);
    Vision.ReferenceImages.List request = vision.referenceImages().list(parameters ...)
 

Returns:

the resource collection