/*
 * 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.contentwarehouse.v1.model;

/**
 * Model definition for OceanVolumeViewability.
 *
 * <p> 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 Document AI Warehouse API. For a detailed explanation
 * see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class OceanVolumeViewability extends com.google.api.client.json.GenericJson {

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("DEPRECATEDDefaultViewType")
  private java.lang.Integer dEPRECATEDDefaultViewType;

  /**
   * The viewability for any locale that is not explicitly listed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private OceanLocaleViewability defaultViewability;

  /**
   * DEPRECATED: Viewability-Limbo was a state that prevented indexing from running if the
   * viewability of a volume had dropped significantly. It was removed during viewability
   * refactoring: http://go/viewability
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean inViewabilityLimbo;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<OceanVolumeViewabilityLocale> locale;

  /**
   * Whether the volume viewability was updated by the indexer as opposed to a direct update in
   * goovols. The absense of this bit will indicate to the indexer that it should not short-circuit
   * indexing side effects that should occur when viewability changes.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean updatedByIndexer;

  /**
   * @return value or {@code null} for none
   */
  public java.lang.Integer getDEPRECATEDDefaultViewType() {
    return dEPRECATEDDefaultViewType;
  }

  /**
   * @param dEPRECATEDDefaultViewType dEPRECATEDDefaultViewType or {@code null} for none
   */
  public OceanVolumeViewability setDEPRECATEDDefaultViewType(java.lang.Integer dEPRECATEDDefaultViewType) {
    this.dEPRECATEDDefaultViewType = dEPRECATEDDefaultViewType;
    return this;
  }

  /**
   * The viewability for any locale that is not explicitly listed.
   * @return value or {@code null} for none
   */
  public OceanLocaleViewability getDefaultViewability() {
    return defaultViewability;
  }

  /**
   * The viewability for any locale that is not explicitly listed.
   * @param defaultViewability defaultViewability or {@code null} for none
   */
  public OceanVolumeViewability setDefaultViewability(OceanLocaleViewability defaultViewability) {
    this.defaultViewability = defaultViewability;
    return this;
  }

  /**
   * DEPRECATED: Viewability-Limbo was a state that prevented indexing from running if the
   * viewability of a volume had dropped significantly. It was removed during viewability
   * refactoring: http://go/viewability
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getInViewabilityLimbo() {
    return inViewabilityLimbo;
  }

  /**
   * DEPRECATED: Viewability-Limbo was a state that prevented indexing from running if the
   * viewability of a volume had dropped significantly. It was removed during viewability
   * refactoring: http://go/viewability
   * @param inViewabilityLimbo inViewabilityLimbo or {@code null} for none
   */
  public OceanVolumeViewability setInViewabilityLimbo(java.lang.Boolean inViewabilityLimbo) {
    this.inViewabilityLimbo = inViewabilityLimbo;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.util.List<OceanVolumeViewabilityLocale> getLocale() {
    return locale;
  }

  /**
   * @param locale locale or {@code null} for none
   */
  public OceanVolumeViewability setLocale(java.util.List<OceanVolumeViewabilityLocale> locale) {
    this.locale = locale;
    return this;
  }

  /**
   * Whether the volume viewability was updated by the indexer as opposed to a direct update in
   * goovols. The absense of this bit will indicate to the indexer that it should not short-circuit
   * indexing side effects that should occur when viewability changes.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUpdatedByIndexer() {
    return updatedByIndexer;
  }

  /**
   * Whether the volume viewability was updated by the indexer as opposed to a direct update in
   * goovols. The absense of this bit will indicate to the indexer that it should not short-circuit
   * indexing side effects that should occur when viewability changes.
   * @param updatedByIndexer updatedByIndexer or {@code null} for none
   */
  public OceanVolumeViewability setUpdatedByIndexer(java.lang.Boolean updatedByIndexer) {
    this.updatedByIndexer = updatedByIndexer;
    return this;
  }

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

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

}
