
com.google.api.services.vision.v1.Vision Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/google/apis-client-generator/
* (build: 2016-05-27 16:00:31 UTC)
* on 2016-07-26 at 19:10:38 UTC
* Modify at your own risk.
*/
package com.google.api.services.vision.v1;
/**
* Service definition for Vision (v1).
*
*
* Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.
*
*
*
* For more information about this service, see the
* API Documentation
*
*
*
* This service uses {@link VisionRequestInitializer} to initialize global parameters via its
* {@link Builder}.
*
*
* @since 1.3
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public class Vision extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient {
// Note: Leave this static initializer at the top of the file.
static {
com.google.api.client.util.Preconditions.checkState(
com.google.api.client.googleapis.GoogleUtils.MAJOR_VERSION == 1 &&
com.google.api.client.googleapis.GoogleUtils.MINOR_VERSION >= 15,
"You are currently running with version %s of google-api-client. " +
"You need at least version 1.15 of google-api-client to run version " +
"1.22.0 of the Google Cloud Vision API library.", com.google.api.client.googleapis.GoogleUtils.VERSION);
}
/**
* The default encoded root URL of the service. This is determined when the library is generated
* and normally should not be changed.
*
* @since 1.7
*/
public static final String DEFAULT_ROOT_URL = "https://vision.googleapis.com/";
/**
* The default encoded service path of the service. This is determined when the library is
* generated and normally should not be changed.
*
* @since 1.7
*/
public static final String DEFAULT_SERVICE_PATH = "";
/**
* The default encoded base URL of the service. This is determined when the library is generated
* and normally should not be changed.
*/
public static final String DEFAULT_BASE_URL = DEFAULT_ROOT_URL + DEFAULT_SERVICE_PATH;
/**
* Constructor.
*
*
* Use {@link Builder} if you need to specify any of the optional parameters.
*
*
* @param transport HTTP transport, which should normally be:
*
* - Google App Engine:
* {@code com.google.api.client.extensions.appengine.http.UrlFetchTransport}
* - Android: {@code newCompatibleTransport} from
* {@code com.google.api.client.extensions.android.http.AndroidHttp}
* - Java: {@link com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()}
*
*
* @param jsonFactory JSON factory, which may be:
*
* - Jackson: {@code com.google.api.client.json.jackson2.JacksonFactory}
* - Google GSON: {@code com.google.api.client.json.gson.GsonFactory}
* - Android Honeycomb or higher:
* {@code com.google.api.client.extensions.android.json.AndroidJsonFactory}
*
* @param httpRequestInitializer HTTP request initializer or {@code null} for none
* @since 1.7
*/
public Vision(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory,
com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) {
this(new Builder(transport, jsonFactory, httpRequestInitializer));
}
/**
* @param builder builder
*/
Vision(Builder builder) {
super(builder);
}
@Override
protected void initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest> httpClientRequest) throws java.io.IOException {
super.initialize(httpClientRequest);
}
/**
* An accessor for creating requests from the Images collection.
*
* The typical use is:
*
* {@code Vision vision = new Vision(...);}
* {@code Vision.Images.List request = vision.images().list(parameters ...)}
*
*
* @return the resource collection
*/
public Images images() {
return new Images();
}
/**
* The "images" collection of methods.
*/
public class Images {
/**
* Run image detection and annotation for a batch of images.
*
* Create a request for the method "images.annotate".
*
* This request holds the parameters needed by the vision server. After setting any optional
* parameters, call the {@link Annotate#execute()} method to invoke the remote operation.
*
* @param content the {@link com.google.api.services.vision.v1.model.BatchAnnotateImagesRequest}
* @return the request
*/
public Annotate annotate(com.google.api.services.vision.v1.model.BatchAnnotateImagesRequest content) throws java.io.IOException {
Annotate result = new Annotate(content);
initialize(result);
return result;
}
public class Annotate extends VisionRequest {
private static final String REST_PATH = "v1/images:annotate";
/**
* Run image detection and annotation for a batch of images.
*
* Create a request for the method "images.annotate".
*
* This request holds the parameters needed by the the vision server. After setting any optional
* parameters, call the {@link Annotate#execute()} method to invoke the remote operation.
* {@link
* Annotate#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)}
* must be called to initialize this instance immediately after invoking the constructor.
*
* @param content the {@link com.google.api.services.vision.v1.model.BatchAnnotateImagesRequest}
* @since 1.13
*/
protected Annotate(com.google.api.services.vision.v1.model.BatchAnnotateImagesRequest content) {
super(Vision.this, "POST", REST_PATH, content, com.google.api.services.vision.v1.model.BatchAnnotateImagesResponse.class);
}
@Override
public Annotate set$Xgafv(java.lang.String $Xgafv) {
return (Annotate) super.set$Xgafv($Xgafv);
}
@Override
public Annotate setAccessToken(java.lang.String accessToken) {
return (Annotate) super.setAccessToken(accessToken);
}
@Override
public Annotate setAlt(java.lang.String alt) {
return (Annotate) super.setAlt(alt);
}
@Override
public Annotate setBearerToken(java.lang.String bearerToken) {
return (Annotate) super.setBearerToken(bearerToken);
}
@Override
public Annotate setCallback(java.lang.String callback) {
return (Annotate) super.setCallback(callback);
}
@Override
public Annotate setFields(java.lang.String fields) {
return (Annotate) super.setFields(fields);
}
@Override
public Annotate setKey(java.lang.String key) {
return (Annotate) super.setKey(key);
}
@Override
public Annotate setOauthToken(java.lang.String oauthToken) {
return (Annotate) super.setOauthToken(oauthToken);
}
@Override
public Annotate setPp(java.lang.Boolean pp) {
return (Annotate) super.setPp(pp);
}
@Override
public Annotate setPrettyPrint(java.lang.Boolean prettyPrint) {
return (Annotate) super.setPrettyPrint(prettyPrint);
}
@Override
public Annotate setQuotaUser(java.lang.String quotaUser) {
return (Annotate) super.setQuotaUser(quotaUser);
}
@Override
public Annotate setUploadType(java.lang.String uploadType) {
return (Annotate) super.setUploadType(uploadType);
}
@Override
public Annotate setUploadProtocol(java.lang.String uploadProtocol) {
return (Annotate) super.setUploadProtocol(uploadProtocol);
}
@Override
public Annotate set(String parameterName, Object value) {
return (Annotate) super.set(parameterName, value);
}
}
}
/**
* Builder for {@link Vision}.
*
*
* Implementation is not thread-safe.
*
*
* @since 1.3.0
*/
public static final class Builder extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient.Builder {
/**
* Returns an instance of a new builder.
*
* @param transport HTTP transport, which should normally be:
*
* - Google App Engine:
* {@code com.google.api.client.extensions.appengine.http.UrlFetchTransport}
* - Android: {@code newCompatibleTransport} from
* {@code com.google.api.client.extensions.android.http.AndroidHttp}
* - Java: {@link com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()}
*
*
* @param jsonFactory JSON factory, which may be:
*
* - Jackson: {@code com.google.api.client.json.jackson2.JacksonFactory}
* - Google GSON: {@code com.google.api.client.json.gson.GsonFactory}
* - Android Honeycomb or higher:
* {@code com.google.api.client.extensions.android.json.AndroidJsonFactory}
*
* @param httpRequestInitializer HTTP request initializer or {@code null} for none
* @since 1.7
*/
public Builder(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory,
com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) {
super(
transport,
jsonFactory,
DEFAULT_ROOT_URL,
DEFAULT_SERVICE_PATH,
httpRequestInitializer,
false);
}
/** Builds a new instance of {@link Vision}. */
@Override
public Vision build() {
return new Vision(this);
}
@Override
public Builder setRootUrl(String rootUrl) {
return (Builder) super.setRootUrl(rootUrl);
}
@Override
public Builder setServicePath(String servicePath) {
return (Builder) super.setServicePath(servicePath);
}
@Override
public Builder setHttpRequestInitializer(com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) {
return (Builder) super.setHttpRequestInitializer(httpRequestInitializer);
}
@Override
public Builder setApplicationName(String applicationName) {
return (Builder) super.setApplicationName(applicationName);
}
@Override
public Builder setSuppressPatternChecks(boolean suppressPatternChecks) {
return (Builder) super.setSuppressPatternChecks(suppressPatternChecks);
}
@Override
public Builder setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks) {
return (Builder) super.setSuppressRequiredParameterChecks(suppressRequiredParameterChecks);
}
@Override
public Builder setSuppressAllChecks(boolean suppressAllChecks) {
return (Builder) super.setSuppressAllChecks(suppressAllChecks);
}
/**
* Set the {@link VisionRequestInitializer}.
*
* @since 1.12
*/
public Builder setVisionRequestInitializer(
VisionRequestInitializer visionRequestInitializer) {
return (Builder) super.setGoogleClientRequestInitializer(visionRequestInitializer);
}
@Override
public Builder setGoogleClientRequestInitializer(
com.google.api.client.googleapis.services.GoogleClientRequestInitializer googleClientRequestInitializer) {
return (Builder) super.setGoogleClientRequestInitializer(googleClientRequestInitializer);
}
}
}