com.google.api.services.vision.v1

Class Vision.Projects.Locations.Products.ReferenceImages.List

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<ListReferenceImagesResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Vision.Projects.Locations.Products.ReferenceImages

public class Vision.Projects.Locations.Products.ReferenceImages.List
extends VisionRequest<ListReferenceImagesResponse>

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	List(String parent) Lists reference images.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() The maximum number of items to return.
String	getPageToken() A token identifying a page of results to be returned.
String	getParent() Required.
Vision.Projects.Locations.Products.ReferenceImages.List	set(String parameterName, Object value)
Vision.Projects.Locations.Products.ReferenceImages.List	set$Xgafv(String $Xgafv) V1 error format.
Vision.Projects.Locations.Products.ReferenceImages.List	setAccessToken(String accessToken) OAuth access token.
Vision.Projects.Locations.Products.ReferenceImages.List	setAlt(String alt) Data format for response.
Vision.Projects.Locations.Products.ReferenceImages.List	setCallback(String callback) JSONP
Vision.Projects.Locations.Products.ReferenceImages.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Vision.Projects.Locations.Products.ReferenceImages.List	setKey(String key) API key.
Vision.Projects.Locations.Products.ReferenceImages.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Vision.Projects.Locations.Products.ReferenceImages.List	setPageSize(Integer pageSize) The maximum number of items to return.
Vision.Projects.Locations.Products.ReferenceImages.List	setPageToken(String pageToken) A token identifying a page of results to be returned.
Vision.Projects.Locations.Products.ReferenceImages.List	setParent(String parent) Required.
Vision.Projects.Locations.Products.ReferenceImages.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Vision.Projects.Locations.Products.ReferenceImages.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Vision.Projects.Locations.Products.ReferenceImages.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Vision.Projects.Locations.Products.ReferenceImages.List	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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, 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

List

protected List(String parent)

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. Create a request for the method "referenceImages.list". 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 - Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListReferenceImagesResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListReferenceImagesResponse>

Throws:

IOException

set$Xgafv

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

Description copied from class: VisionRequest

V1 error format.

Overrides:

set$Xgafv in class VisionRequest<ListReferenceImagesResponse>

setAccessToken

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

Description copied from class: VisionRequest

OAuth access token.

Overrides:

setAccessToken in class VisionRequest<ListReferenceImagesResponse>

setAlt

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

Description copied from class: VisionRequest

Data format for response.

Overrides:

setAlt in class VisionRequest<ListReferenceImagesResponse>

setCallback

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

Description copied from class: VisionRequest

JSONP

Overrides:

setCallback in class VisionRequest<ListReferenceImagesResponse>

setFields

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

Description copied from class: VisionRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class VisionRequest<ListReferenceImagesResponse>

setKey

public Vision.Projects.Locations.Products.ReferenceImages.List 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<ListReferenceImagesResponse>

setOauthToken

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

Description copied from class: VisionRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class VisionRequest<ListReferenceImagesResponse>

setPrettyPrint

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

Description copied from class: VisionRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class VisionRequest<ListReferenceImagesResponse>

setQuotaUser

public Vision.Projects.Locations.Products.ReferenceImages.List 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<ListReferenceImagesResponse>

setUploadType

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

Description copied from class: VisionRequest

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

Overrides:

setUploadType in class VisionRequest<ListReferenceImagesResponse>

setUploadProtocol

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

Description copied from class: VisionRequest

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

Overrides:

setUploadProtocol in class VisionRequest<ListReferenceImagesResponse>

getParent

public String getParent()

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

setParent

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

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

getPageSize

public Integer getPageSize()

The maximum number of items to return. Default 10, maximum 100.

setPageSize

public Vision.Projects.Locations.Products.ReferenceImages.List setPageSize(Integer pageSize)

The maximum number of items to return. Default 10, maximum 100.

getPageToken

public String getPageToken()

A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified.

setPageToken

public Vision.Projects.Locations.Products.ReferenceImages.List setPageToken(String pageToken)

A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified.

set

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

Overrides:

set in class VisionRequest<ListReferenceImagesResponse>