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

Go to download
/*
 * 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/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.transcoder.v1.model;

/**
 * Overlaid image.
 *
 *  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 Transcoder 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 {

  /**
   * Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent),
   * exclusive. Set this to a value greater than `0.0`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double alpha;

  /**
   * Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To
   * respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original
   * image resolution, set both `x` and `y` to `0.0`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private NormalizedCoordinate resolution;

  /**
   * Required. URI of the image in Cloud Storage. For example, `gs://bucket/inputs/image.png`. Only
   * PNG and JPEG images are supported.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String uri;

  /**
   * Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent),
   * exclusive. Set this to a value greater than `0.0`.
   * @return value or {@code null} for none
   */
  public java.lang.Double getAlpha() {
    return alpha;
  }

  /**
   * Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent),
   * exclusive. Set this to a value greater than `0.0`.
   * @param alpha alpha or {@code null} for none
   */
  public Image setAlpha(java.lang.Double alpha) {
    this.alpha = alpha;
    return this;
  }

  /**
   * Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To
   * respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original
   * image resolution, set both `x` and `y` to `0.0`.
   * @return value or {@code null} for none
   */
  public NormalizedCoordinate getResolution() {
    return resolution;
  }

  /**
   * Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To
   * respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original
   * image resolution, set both `x` and `y` to `0.0`.
   * @param resolution resolution or {@code null} for none
   */
  public Image setResolution(NormalizedCoordinate resolution) {
    this.resolution = resolution;
    return this;
  }

  /**
   * Required. URI of the image in Cloud Storage. For example, `gs://bucket/inputs/image.png`. Only
   * PNG and JPEG images are supported.
   * @return value or {@code null} for none
   */
  public java.lang.String getUri() {
    return uri;
  }

  /**
   * Required. URI of the image in Cloud Storage. For example, `gs://bucket/inputs/image.png`. Only
   * PNG and JPEG images are supported.
   * @param uri uri or {@code null} for none
   */
  public Image setUri(java.lang.String uri) {
    this.uri = uri;
    return this;
  }

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

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

}