com.google.api.services.people.v1.model.UpdateContactPhotoRequest 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.people.v1.model;

/**
 * A request to update an existing contact's photo. All requests must have a valid photo format:
 * JPEG or PNG.
 *
 *  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 People 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 UpdateContactPhotoRequest extends com.google.api.client.json.GenericJson {

  /**
   * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can
   * be specified by separating them with commas. Defaults to empty if not set, which will skip the
   * post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays *
   * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders *
   * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names *
   * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses *
   * skills * urls * userDefined
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String personFields;

  /**
   * Required. Raw photo bytes
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String photoBytes;

  /**
   * Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and
   * READ_SOURCE_TYPE_PROFILE if not set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List sources;

  /**
   * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can
   * be specified by separating them with commas. Defaults to empty if not set, which will skip the
   * post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays *
   * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders *
   * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names *
   * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses *
   * skills * urls * userDefined
   * @return value or {@code null} for none
   */
  public String getPersonFields() {
    return personFields;
  }

  /**
   * Optional. A field mask to restrict which fields on the person are returned. Multiple fields can
   * be specified by separating them with commas. Defaults to empty if not set, which will skip the
   * post mutate get. Valid values are: * addresses * ageRanges * biographies * birthdays *
   * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders *
   * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names *
   * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses *
   * skills * urls * userDefined
   * @param personFields personFields or {@code null} for none
   */
  public UpdateContactPhotoRequest setPersonFields(String personFields) {
    this.personFields = personFields;
    return this;
  }

  /**
   * Required. Raw photo bytes
   * @see #decodePhotoBytes()
   * @return value or {@code null} for none
   */
  public java.lang.String getPhotoBytes() {
    return photoBytes;
  }

  /**
   * Required. Raw photo bytes
   * @see #getPhotoBytes()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodePhotoBytes() {
    return com.google.api.client.util.Base64.decodeBase64(photoBytes);
  }

  /**
   * Required. Raw photo bytes
   * @see #encodePhotoBytes()
   * @param photoBytes photoBytes or {@code null} for none
   */
  public UpdateContactPhotoRequest setPhotoBytes(java.lang.String photoBytes) {
    this.photoBytes = photoBytes;
    return this;
  }

  /**
   * Required. Raw photo bytes
   * @see #setPhotoBytes()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public UpdateContactPhotoRequest encodePhotoBytes(byte[] photoBytes) {
    this.photoBytes = com.google.api.client.util.Base64.encodeBase64URLSafeString(photoBytes);
    return this;
  }

  /**
   * Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and
   * READ_SOURCE_TYPE_PROFILE if not set.
   * @return value or {@code null} for none
   */
  public java.util.List getSources() {
    return sources;
  }

  /**
   * Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and
   * READ_SOURCE_TYPE_PROFILE if not set.
   * @param sources sources or {@code null} for none
   */
  public UpdateContactPhotoRequest setSources(java.util.List sources) {
    this.sources = sources;
    return this;
  }

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

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

}