com.google.api.services.streetviewpublish.v1.model.UpdatePhotoRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-streetviewpublish Show documentation
There is a newer version: v1-rev20240224-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://code.google.com/p/google-apis-client-generator/
 * (build: 2017-09-26 19:19:48 UTC)
 * on 2017-10-27 at 19:25:16 UTC 
 * Modify at your own risk.
 */

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

/**
 * Request to update the metadata of a Photo. Updating the pixels of a photo is not supported.
 *
 *  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 Street View Publish API. For a detailed explanation
 * see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class UpdatePhotoRequest extends com.google.api.client.json.GenericJson {

  /**
   * Required. Photo object containing the new metadata.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Photo photo;

  /**
   * Mask that identifies fields on the photo metadata to update. If not present, the old Photo
   * metadata will be entirely replaced with the new Photo metadata in this request. The update
   * fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited
   * list.
   *
   * The following fields are valid:
   *
   * * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` *
   * `pose.altitude` * `connections` * `places`
   *
   * Note: Repeated fields in updateMask mean the entire set of repeated values will be replaced
   * with the new contents. For example, if updateMask contains `connections` and
   * `UpdatePhotoRequest.photo.connections` is empty, all connections will be removed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String updateMask;

  /**
   * Required. Photo object containing the new metadata.
   * @return value or {@code null} for none
   */
  public Photo getPhoto() {
    return photo;
  }

  /**
   * Required. Photo object containing the new metadata.
   * @param photo photo or {@code null} for none
   */
  public UpdatePhotoRequest setPhoto(Photo photo) {
    this.photo = photo;
    return this;
  }

  /**
   * Mask that identifies fields on the photo metadata to update. If not present, the old Photo
   * metadata will be entirely replaced with the new Photo metadata in this request. The update
   * fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited
   * list.
   *
   * The following fields are valid:
   *
   * * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` *
   * `pose.altitude` * `connections` * `places`
   *
   * Note: Repeated fields in updateMask mean the entire set of repeated values will be replaced
   * with the new contents. For example, if updateMask contains `connections` and
   * `UpdatePhotoRequest.photo.connections` is empty, all connections will be removed.
   * @return value or {@code null} for none
   */
  public String getUpdateMask() {
    return updateMask;
  }

  /**
   * Mask that identifies fields on the photo metadata to update. If not present, the old Photo
   * metadata will be entirely replaced with the new Photo metadata in this request. The update
   * fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited
   * list.
   *
   * The following fields are valid:
   *
   * * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` *
   * `pose.altitude` * `connections` * `places`
   *
   * Note: Repeated fields in updateMask mean the entire set of repeated values will be replaced
   * with the new contents. For example, if updateMask contains `connections` and
   * `UpdatePhotoRequest.photo.connections` is empty, all connections will be removed.
   * @param updateMask updateMask or {@code null} for none
   */
  public UpdatePhotoRequest setUpdateMask(String updateMask) {
    this.updateMask = updateMask;
    return this;
  }

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

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

}