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

/**
 * Gives a short summary of an evaluation, and links to the evaluation itself.
 *
 *  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 Cloud Document AI 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 GoogleCloudDocumentaiV1EvaluationReference extends com.google.api.client.json.GenericJson {

  /**
   * An aggregate of the statistics for the evaluation with fuzzy matching on.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1EvaluationMetrics aggregateMetrics;

  /**
   * An aggregate of the statistics for the evaluation with fuzzy matching off.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1EvaluationMetrics aggregateMetricsExact;

  /**
   * The resource name of the evaluation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String evaluation;

  /**
   * The resource name of the Long Running Operation for the evaluation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String operation;

  /**
   * An aggregate of the statistics for the evaluation with fuzzy matching on.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1EvaluationMetrics getAggregateMetrics() {
    return aggregateMetrics;
  }

  /**
   * An aggregate of the statistics for the evaluation with fuzzy matching on.
   * @param aggregateMetrics aggregateMetrics or {@code null} for none
   */
  public GoogleCloudDocumentaiV1EvaluationReference setAggregateMetrics(GoogleCloudDocumentaiV1EvaluationMetrics aggregateMetrics) {
    this.aggregateMetrics = aggregateMetrics;
    return this;
  }

  /**
   * An aggregate of the statistics for the evaluation with fuzzy matching off.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1EvaluationMetrics getAggregateMetricsExact() {
    return aggregateMetricsExact;
  }

  /**
   * An aggregate of the statistics for the evaluation with fuzzy matching off.
   * @param aggregateMetricsExact aggregateMetricsExact or {@code null} for none
   */
  public GoogleCloudDocumentaiV1EvaluationReference setAggregateMetricsExact(GoogleCloudDocumentaiV1EvaluationMetrics aggregateMetricsExact) {
    this.aggregateMetricsExact = aggregateMetricsExact;
    return this;
  }

  /**
   * The resource name of the evaluation.
   * @return value or {@code null} for none
   */
  public java.lang.String getEvaluation() {
    return evaluation;
  }

  /**
   * The resource name of the evaluation.
   * @param evaluation evaluation or {@code null} for none
   */
  public GoogleCloudDocumentaiV1EvaluationReference setEvaluation(java.lang.String evaluation) {
    this.evaluation = evaluation;
    return this;
  }

  /**
   * The resource name of the Long Running Operation for the evaluation.
   * @return value or {@code null} for none
   */
  public java.lang.String getOperation() {
    return operation;
  }

  /**
   * The resource name of the Long Running Operation for the evaluation.
   * @param operation operation or {@code null} for none
   */
  public GoogleCloudDocumentaiV1EvaluationReference setOperation(java.lang.String operation) {
    this.operation = operation;
    return this;
  }

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

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

}