/*
 * 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;

/**
 * Desktop interstitials signal. The message contains both fields for site-level signal lookup in
 * Index Signals (go/index-signals) and fields for final attachment in DocJoin.
 *
 * <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 IndexingMobileInterstitialsProtoDesktopInterstitials extends com.google.api.client.json.GenericJson {

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

  /**
   * Epoch of the interstitial offline pipeline generating this signal.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pipelineEpoch;

  /**
   * If present, pipeline_pattern identifies the cluster of URLs for which the signal value was
   * smeared.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pipelinePattern;

  /**
   * URL tree of interstitial patterns belong to the host, to be used as site-level signal in Index
   * Signals. A pattern may contain a payload InterstitialPatternPayload, which will indicate the
   * violated interstitial types of this pattern.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private IndexingUrlPatternUrlTreeUrlTree urlTree;

  /**
   * Overall policy violation status. If this is true, at least one of the InterstitialSignal below
   * indicates a violation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean violatesDesktopInterstitialPolicy;

  /**
   * @return value or {@code null} for none
   */
  public java.util.List<IndexingMobileInterstitialsProtoDesktopInterstitialsDetails> getDetails() {
    return details;
  }

  /**
   * @param details details or {@code null} for none
   */
  public IndexingMobileInterstitialsProtoDesktopInterstitials setDetails(java.util.List<IndexingMobileInterstitialsProtoDesktopInterstitialsDetails> details) {
    this.details = details;
    return this;
  }

  /**
   * Epoch of the interstitial offline pipeline generating this signal.
   * @return value or {@code null} for none
   */
  public java.lang.String getPipelineEpoch() {
    return pipelineEpoch;
  }

  /**
   * Epoch of the interstitial offline pipeline generating this signal.
   * @param pipelineEpoch pipelineEpoch or {@code null} for none
   */
  public IndexingMobileInterstitialsProtoDesktopInterstitials setPipelineEpoch(java.lang.String pipelineEpoch) {
    this.pipelineEpoch = pipelineEpoch;
    return this;
  }

  /**
   * If present, pipeline_pattern identifies the cluster of URLs for which the signal value was
   * smeared.
   * @return value or {@code null} for none
   */
  public java.lang.String getPipelinePattern() {
    return pipelinePattern;
  }

  /**
   * If present, pipeline_pattern identifies the cluster of URLs for which the signal value was
   * smeared.
   * @param pipelinePattern pipelinePattern or {@code null} for none
   */
  public IndexingMobileInterstitialsProtoDesktopInterstitials setPipelinePattern(java.lang.String pipelinePattern) {
    this.pipelinePattern = pipelinePattern;
    return this;
  }

  /**
   * URL tree of interstitial patterns belong to the host, to be used as site-level signal in Index
   * Signals. A pattern may contain a payload InterstitialPatternPayload, which will indicate the
   * violated interstitial types of this pattern.
   * @return value or {@code null} for none
   */
  public IndexingUrlPatternUrlTreeUrlTree getUrlTree() {
    return urlTree;
  }

  /**
   * URL tree of interstitial patterns belong to the host, to be used as site-level signal in Index
   * Signals. A pattern may contain a payload InterstitialPatternPayload, which will indicate the
   * violated interstitial types of this pattern.
   * @param urlTree urlTree or {@code null} for none
   */
  public IndexingMobileInterstitialsProtoDesktopInterstitials setUrlTree(IndexingUrlPatternUrlTreeUrlTree urlTree) {
    this.urlTree = urlTree;
    return this;
  }

  /**
   * Overall policy violation status. If this is true, at least one of the InterstitialSignal below
   * indicates a violation.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getViolatesDesktopInterstitialPolicy() {
    return violatesDesktopInterstitialPolicy;
  }

  /**
   * Overall policy violation status. If this is true, at least one of the InterstitialSignal below
   * indicates a violation.
   * @param violatesDesktopInterstitialPolicy violatesDesktopInterstitialPolicy or {@code null} for none
   */
  public IndexingMobileInterstitialsProtoDesktopInterstitials setViolatesDesktopInterstitialPolicy(java.lang.Boolean violatesDesktopInterstitialPolicy) {
    this.violatesDesktopInterstitialPolicy = violatesDesktopInterstitialPolicy;
    return this;
  }

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

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

}
