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

/**
 * The status of human review on a processed document.
 *
 *  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 GoogleCloudDocumentaiV1beta3HumanReviewStatus extends com.google.api.client.json.GenericJson {

  /**
   * The name of the operation triggered by the processed document. This field is populated only
   * when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the
   * long-running operation returned by ReviewDocument.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String humanReviewOperation;

  /**
   * The state of human review on the processing request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * A message providing more details about the human review state.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String stateMessage;

  /**
   * The name of the operation triggered by the processed document. This field is populated only
   * when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the
   * long-running operation returned by ReviewDocument.
   * @return value or {@code null} for none
   */
  public java.lang.String getHumanReviewOperation() {
    return humanReviewOperation;
  }

  /**
   * The name of the operation triggered by the processed document. This field is populated only
   * when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the
   * long-running operation returned by ReviewDocument.
   * @param humanReviewOperation humanReviewOperation or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3HumanReviewStatus setHumanReviewOperation(java.lang.String humanReviewOperation) {
    this.humanReviewOperation = humanReviewOperation;
    return this;
  }

  /**
   * The state of human review on the processing request.
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * The state of human review on the processing request.
   * @param state state or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3HumanReviewStatus setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  /**
   * A message providing more details about the human review state.
   * @return value or {@code null} for none
   */
  public java.lang.String getStateMessage() {
    return stateMessage;
  }

  /**
   * A message providing more details about the human review state.
   * @param stateMessage stateMessage or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3HumanReviewStatus setStateMessage(java.lang.String stateMessage) {
    this.stateMessage = stateMessage;
    return this;
  }

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

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

}