Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource

The "referenceImages" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Vision.v1
Assembly: Google.Apis.Vision.v1.dll
Syntax
public class ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource

Constructors

ReferenceImagesResource(IClientService)

Constructs a new resource.

Declaration
public ReferenceImagesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(ReferenceImage, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.CreateRequest Create(ReferenceImage body, string parent)
Parameters
Type Name Description
ReferenceImage body

The body of the request.

string parent

Required. Resource name of the product in which to create the reference image. Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Returns
Type Description
ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.CreateRequest

Delete(string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The resource name of the reference image to delete. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

Returns
Type Description
ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.DeleteRequest

Get(string)

Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist.

Declaration
public virtual ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The resource name of the ReferenceImage to get. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

Returns
Type Description
ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.GetRequest

List(string)

Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.

Declaration
public virtual ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Resource name of the product containing the reference images. Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Returns
Type Description
ProjectsResource.LocationsResource.ProductsResource.ReferenceImagesResource.ListRequest
In this article
Back to top Generated by DocFX