com.google.api.services.vision.v1

Class Vision.Projects.Locations.Products.ReferenceImages.Create

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.vision.v1.VisionRequest<ReferenceImage>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Vision.Projects.Locations.Products.ReferenceImages

public class Vision.Projects.Locations.Products.ReferenceImages.Create
extends VisionRequest<ReferenceImage>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Create(String parent, ReferenceImage content) Creates and returns a new ReferenceImage resource.

Method Summary

Modifier and Type	Method and Description
String	getParent() Resource name of the product in which to create the reference image.
String	getReferenceImageId() A user-supplied resource id for the ReferenceImage to be added.
Vision.Projects.Locations.Products.ReferenceImages.Create	set(String parameterName, Object value)
Vision.Projects.Locations.Products.ReferenceImages.Create	set$Xgafv(String $Xgafv) V1 error format.
Vision.Projects.Locations.Products.ReferenceImages.Create	setAccessToken(String accessToken) OAuth access token.
Vision.Projects.Locations.Products.ReferenceImages.Create	setAlt(String alt) Data format for response.
Vision.Projects.Locations.Products.ReferenceImages.Create	setCallback(String callback) JSONP
Vision.Projects.Locations.Products.ReferenceImages.Create	setFields(String fields) Selector specifying which fields to include in a partial response.
Vision.Projects.Locations.Products.ReferenceImages.Create	setKey(String key) API key.
Vision.Projects.Locations.Products.ReferenceImages.Create	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Vision.Projects.Locations.Products.ReferenceImages.Create	setParent(String parent) Resource name of the product in which to create the reference image.
Vision.Projects.Locations.Products.ReferenceImages.Create	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Vision.Projects.Locations.Products.ReferenceImages.Create	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Vision.Projects.Locations.Products.ReferenceImages.Create	setReferenceImageId(String referenceImageId) A user-supplied resource id for the ReferenceImage to be added.
Vision.Projects.Locations.Products.ReferenceImages.Create	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Vision.Projects.Locations.Products.ReferenceImages.Create	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.vision.v1.VisionRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Create

protected Create(String parent,
                 ReferenceImage content)

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

Vision.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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

content - the ReferenceImage

Since:

1.13

Method Detail

set$Xgafv

public Vision.Projects.Locations.Products.ReferenceImages.Create set$Xgafv(String $Xgafv)

Description copied from class: VisionRequest

V1 error format.

Overrides:

set$Xgafv in class VisionRequest<ReferenceImage>

setAccessToken

public Vision.Projects.Locations.Products.ReferenceImages.Create setAccessToken(String accessToken)

Description copied from class: VisionRequest

OAuth access token.

Overrides:

setAccessToken in class VisionRequest<ReferenceImage>

setAlt

public Vision.Projects.Locations.Products.ReferenceImages.Create setAlt(String alt)

Description copied from class: VisionRequest

Data format for response.

Overrides:

setAlt in class VisionRequest<ReferenceImage>

setCallback

public Vision.Projects.Locations.Products.ReferenceImages.Create setCallback(String callback)

Description copied from class: VisionRequest

JSONP

Overrides:

setCallback in class VisionRequest<ReferenceImage>

setFields

public Vision.Projects.Locations.Products.ReferenceImages.Create setFields(String fields)

Description copied from class: VisionRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class VisionRequest<ReferenceImage>

setKey

public Vision.Projects.Locations.Products.ReferenceImages.Create setKey(String key)

Description copied from class: VisionRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class VisionRequest<ReferenceImage>

setOauthToken

public Vision.Projects.Locations.Products.ReferenceImages.Create setOauthToken(String oauthToken)

Description copied from class: VisionRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class VisionRequest<ReferenceImage>

setPrettyPrint

public Vision.Projects.Locations.Products.ReferenceImages.Create setPrettyPrint(Boolean prettyPrint)

Description copied from class: VisionRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class VisionRequest<ReferenceImage>

setQuotaUser

public Vision.Projects.Locations.Products.ReferenceImages.Create setQuotaUser(String quotaUser)

Description copied from class: VisionRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class VisionRequest<ReferenceImage>

setUploadType

public Vision.Projects.Locations.Products.ReferenceImages.Create setUploadType(String uploadType)

Description copied from class: VisionRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class VisionRequest<ReferenceImage>

setUploadProtocol

public Vision.Projects.Locations.Products.ReferenceImages.Create setUploadProtocol(String uploadProtocol)

Description copied from class: VisionRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class VisionRequest<ReferenceImage>

getParent

public String getParent()

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

setParent

public Vision.Projects.Locations.Products.ReferenceImages.Create setParent(String parent)

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

getReferenceImageId

public String getReferenceImageId()

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

setReferenceImageId

public Vision.Projects.Locations.Products.ReferenceImages.Create setReferenceImageId(String referenceImageId)

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

set

public Vision.Projects.Locations.Products.ReferenceImages.Create set(String parameterName,
                                                                     Object value)

Overrides:

set in class VisionRequest<ReferenceImage>