com.google.api.services.vision.v1.model.Image Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-vision Show documentation
There is a newer version: v1-rev20241115-2.0.0
Show newest version
/*
 * 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.model;

/**
 * Client image to perform Google Cloud Vision API tasks over.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Google Cloud Vision API. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class Image extends com.google.api.client.json.GenericJson {

  /**
   * Image content, represented as a stream of bytes. Note: as with all `bytes` fields, protobuffers
   * use a pure binary representation, whereas JSON representations use base64.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String content;

  /**
   * Google Cloud Storage image location. If both 'content' and 'source' are filled for an image,
   * 'content' takes precedence and it will be used for performing the image annotation request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ImageSource source;

  /**
   * Image content, represented as a stream of bytes. Note: as with all `bytes` fields, protobuffers
   * use a pure binary representation, whereas JSON representations use base64.
   * @see #decodeContent()
   * @return value or {@code null} for none
   */
  public java.lang.String getContent() {
    return content;
  }

  /**
   * Image content, represented as a stream of bytes. Note: as with all `bytes` fields, protobuffers
   * use a pure binary representation, whereas JSON representations use base64.
   * @see #getContent()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeContent() {
    return com.google.api.client.util.Base64.decodeBase64(content);
  }

  /**
   * Image content, represented as a stream of bytes. Note: as with all `bytes` fields, protobuffers
   * use a pure binary representation, whereas JSON representations use base64.
   * @see #encodeContent()
   * @param content content or {@code null} for none
   */
  public Image setContent(java.lang.String content) {
    this.content = content;
    return this;
  }

  /**
   * Image content, represented as a stream of bytes. Note: as with all `bytes` fields, protobuffers
   * use a pure binary representation, whereas JSON representations use base64.
   * @see #setContent()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public Image encodeContent(byte[] content) {
    this.content = com.google.api.client.util.Base64.encodeBase64URLSafeString(content);
    return this;
  }

  /**
   * Google Cloud Storage image location. If both 'content' and 'source' are filled for an image,
   * 'content' takes precedence and it will be used for performing the image annotation request.
   * @return value or {@code null} for none
   */
  public ImageSource getSource() {
    return source;
  }

  /**
   * Google Cloud Storage image location. If both 'content' and 'source' are filled for an image,
   * 'content' takes precedence and it will be used for performing the image annotation request.
   * @param source source or {@code null} for none
   */
  public Image setSource(ImageSource source) {
    this.source = source;
    return this;
  }

  @Override
  public Image set(String fieldName, Object value) {
    return (Image) super.set(fieldName, value);
  }

  @Override
  public Image clone() {
    return (Image) super.clone();
  }

}