/*
 * 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 ScienceCitationFunding.
 *
 * <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 ScienceCitationFunding extends com.google.api.client.json.GenericJson {

  /**
   * values are from FundingAgency enum
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("Agency")
  private java.lang.Integer agency;

  /**
   * Text name of the agency. For analysis. Plus for agencies that don't have an enum.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("AgencyName")
  private java.lang.String agencyName;

  /**
   * Funding entries for the same agency and grant number can be merged during our extraction
   * process so we maintain a record of all the deduped ExtractionInfo messages within the remaining
   * entry.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("DebugExtractionInfo")
  private java.util.List<ScienceCitationFundingExtractionInfo> debugExtractionInfo;

  /**
   * Text block from which the funding entry was extracted. Intended to be used for offline
   * analysis. DEPRECATED
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("DebugFundingTextBlock")
  private java.lang.String debugFundingTextBlock;

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

  /**
   * funding recipient
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("Recipient")
  private java.lang.String recipient;

  /**
   * Original text for the funding acknowledgement
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("SourceText")
  private java.lang.String sourceText;

  /**
   * Whether this funding info was added because this article was at the exclusive repository for
   * this agency.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key("UrlBasedFundingSource")
  private java.lang.Boolean urlBasedFundingSource;

  /**
   * values are from FundingAgency enum
   * @return value or {@code null} for none
   */
  public java.lang.Integer getAgency() {
    return agency;
  }

  /**
   * values are from FundingAgency enum
   * @param agency agency or {@code null} for none
   */
  public ScienceCitationFunding setAgency(java.lang.Integer agency) {
    this.agency = agency;
    return this;
  }

  /**
   * Text name of the agency. For analysis. Plus for agencies that don't have an enum.
   * @return value or {@code null} for none
   */
  public java.lang.String getAgencyName() {
    return agencyName;
  }

  /**
   * Text name of the agency. For analysis. Plus for agencies that don't have an enum.
   * @param agencyName agencyName or {@code null} for none
   */
  public ScienceCitationFunding setAgencyName(java.lang.String agencyName) {
    this.agencyName = agencyName;
    return this;
  }

  /**
   * Funding entries for the same agency and grant number can be merged during our extraction
   * process so we maintain a record of all the deduped ExtractionInfo messages within the remaining
   * entry.
   * @return value or {@code null} for none
   */
  public java.util.List<ScienceCitationFundingExtractionInfo> getDebugExtractionInfo() {
    return debugExtractionInfo;
  }

  /**
   * Funding entries for the same agency and grant number can be merged during our extraction
   * process so we maintain a record of all the deduped ExtractionInfo messages within the remaining
   * entry.
   * @param debugExtractionInfo debugExtractionInfo or {@code null} for none
   */
  public ScienceCitationFunding setDebugExtractionInfo(java.util.List<ScienceCitationFundingExtractionInfo> debugExtractionInfo) {
    this.debugExtractionInfo = debugExtractionInfo;
    return this;
  }

  /**
   * Text block from which the funding entry was extracted. Intended to be used for offline
   * analysis. DEPRECATED
   * @return value or {@code null} for none
   */
  public java.lang.String getDebugFundingTextBlock() {
    return debugFundingTextBlock;
  }

  /**
   * Text block from which the funding entry was extracted. Intended to be used for offline
   * analysis. DEPRECATED
   * @param debugFundingTextBlock debugFundingTextBlock or {@code null} for none
   */
  public ScienceCitationFunding setDebugFundingTextBlock(java.lang.String debugFundingTextBlock) {
    this.debugFundingTextBlock = debugFundingTextBlock;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.lang.String getGrantNumber() {
    return grantNumber;
  }

  /**
   * @param grantNumber grantNumber or {@code null} for none
   */
  public ScienceCitationFunding setGrantNumber(java.lang.String grantNumber) {
    this.grantNumber = grantNumber;
    return this;
  }

  /**
   * funding recipient
   * @return value or {@code null} for none
   */
  public java.lang.String getRecipient() {
    return recipient;
  }

  /**
   * funding recipient
   * @param recipient recipient or {@code null} for none
   */
  public ScienceCitationFunding setRecipient(java.lang.String recipient) {
    this.recipient = recipient;
    return this;
  }

  /**
   * Original text for the funding acknowledgement
   * @return value or {@code null} for none
   */
  public java.lang.String getSourceText() {
    return sourceText;
  }

  /**
   * Original text for the funding acknowledgement
   * @param sourceText sourceText or {@code null} for none
   */
  public ScienceCitationFunding setSourceText(java.lang.String sourceText) {
    this.sourceText = sourceText;
    return this;
  }

  /**
   * Whether this funding info was added because this article was at the exclusive repository for
   * this agency.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUrlBasedFundingSource() {
    return urlBasedFundingSource;
  }

  /**
   * Whether this funding info was added because this article was at the exclusive repository for
   * this agency.
   * @param urlBasedFundingSource urlBasedFundingSource or {@code null} for none
   */
  public ScienceCitationFunding setUrlBasedFundingSource(java.lang.Boolean urlBasedFundingSource) {
    this.urlBasedFundingSource = urlBasedFundingSource;
    return this;
  }

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

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

}
