com.google.api.services.vision.v1

Class Vision.Projects.Locations.ProductSets

java.lang.Object

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

Enclosing class:

Vision.Projects.Locations

public class Vision.Projects.Locations.ProductSets
extends Object

The "productSets" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Vision.Projects.Locations.ProductSets.AddProduct
class	Vision.Projects.Locations.ProductSets.Create
class	Vision.Projects.Locations.ProductSets.Delete
class	Vision.Projects.Locations.ProductSets.Get
class	Vision.Projects.Locations.ProductSets.List
class	Vision.Projects.Locations.ProductSets.Patch
class	Vision.Projects.Locations.ProductSets.Products The "products" collection of methods.
class	Vision.Projects.Locations.ProductSets.RemoveProduct
class	Vision.Projects.Locations.ProductSets.VisionImport

Constructor Summary

Constructors

Constructor and Description
ProductSets()

Method Summary

Modifier and Type	Method and Description
Vision.Projects.Locations.ProductSets.AddProduct	addProduct(String name, AddProductToProductSetRequest content) Adds a Product to the specified ProductSet.
Vision.Projects.Locations.ProductSets.Create	create(String parent, ProductSet content) Creates and returns a new ProductSet resource.
Vision.Projects.Locations.ProductSets.Delete	delete(String name) Permanently deletes a ProductSet.
Vision.Projects.Locations.ProductSets.Get	get(String name) Gets information associated with a ProductSet.
Vision.Projects.Locations.ProductSets.List	list(String parent) Lists ProductSets in an unspecified order.
Vision.Projects.Locations.ProductSets.Patch	patch(String name, ProductSet content) Makes changes to a ProductSet resource.
Vision.Projects.Locations.ProductSets.Products	products() An accessor for creating requests from the Products collection.
Vision.Projects.Locations.ProductSets.RemoveProduct	removeProduct(String name, RemoveProductFromProductSetRequest content) Removes a Product from the specified ProductSet.
Vision.Projects.Locations.ProductSets.VisionImport	visionImport(String parent, ImportProductSetsRequest content) Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductSets

public ProductSets()

Method Detail

addProduct

public Vision.Projects.Locations.ProductSets.AddProduct addProduct(String name,
                                                                   AddProductToProductSetRequest content)
                                                            throws IOException

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. Create a request for the method "productSets.addProduct". 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 for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

content - the AddProductToProductSetRequest

Returns:

the request

Throws:

IOException

create

public Vision.Projects.Locations.ProductSets.Create create(String parent,
                                                           ProductSet content)
                                                    throws IOException

Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters. Create a request for the method "productSets.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 - The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`.

content - the ProductSet

Returns:

the request

Throws:

IOException

delete

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

Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. Create a request for the method "productSets.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 - Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

Returns:

the request

Throws:

IOException

get

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

Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. Create a request for the method "productSets.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 - Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID`

Returns:

the request

Throws:

IOException

visionImport

public Vision.Projects.Locations.ProductSets.VisionImport visionImport(String parent,
                                                                       ImportProductSetsRequest content)
                                                                throws IOException

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The 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. Create a request for the method "productSets.import". 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 - The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`.

content - the ImportProductSetsRequest

Returns:

the request

Throws:

IOException

list

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

Lists ProductSets 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 "productSets.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 - The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`.

Returns:

the request

Throws:

IOException

patch

public Vision.Projects.Locations.ProductSets.Patch patch(String name,
                                                         ProductSet content)
                                                  throws IOException

Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters. Create a request for the method "productSets.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 ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet.

content - the ProductSet

Returns:

the request

Throws:

IOException

removeProduct

public Vision.Projects.Locations.ProductSets.RemoveProduct removeProduct(String name,
                                                                         RemoveProductFromProductSetRequest content)
                                                                  throws IOException

Removes a Product from the specified ProductSet. Create a request for the method "productSets.removeProduct". 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 for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

content - the RemoveProductFromProductSetRequest

Returns:

the request

Throws:

IOException

products

public Vision.Projects.Locations.ProductSets.Products products()

An accessor for creating requests from the Products collection.

The typical use is:

    Vision vision = new Vision(...);
    Vision.Products.List request = vision.products().list(parameters ...)
 

Returns:

the resource collection