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

/**
 * Request message for BatchProcessDocuments.
 *
 *  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 GoogleCloudDocumentaiV1BatchProcessRequest extends com.google.api.client.json.GenericJson {

  /**
   * The output configuration for the BatchProcessDocuments method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1DocumentOutputConfig documentOutputConfig;

  /**
   * The input documents for the BatchProcessDocuments method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1BatchDocumentsInputConfig inputDocuments;

  /**
   * Optional. The labels with user-defined metadata for the request. Label keys and values can be
   * no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters,
   * numeric characters, underscores, and dashes. International characters are allowed. Label values
   * are optional. Label keys must start with a letter.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map labels;

  /**
   * Inference-time options for the process API
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1ProcessOptions processOptions;

  /**
   * Whether human review should be skipped for this request. Default to `false`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean skipHumanReview;

  /**
   * The output configuration for the BatchProcessDocuments method.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1DocumentOutputConfig getDocumentOutputConfig() {
    return documentOutputConfig;
  }

  /**
   * The output configuration for the BatchProcessDocuments method.
   * @param documentOutputConfig documentOutputConfig or {@code null} for none
   */
  public GoogleCloudDocumentaiV1BatchProcessRequest setDocumentOutputConfig(GoogleCloudDocumentaiV1DocumentOutputConfig documentOutputConfig) {
    this.documentOutputConfig = documentOutputConfig;
    return this;
  }

  /**
   * The input documents for the BatchProcessDocuments method.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1BatchDocumentsInputConfig getInputDocuments() {
    return inputDocuments;
  }

  /**
   * The input documents for the BatchProcessDocuments method.
   * @param inputDocuments inputDocuments or {@code null} for none
   */
  public GoogleCloudDocumentaiV1BatchProcessRequest setInputDocuments(GoogleCloudDocumentaiV1BatchDocumentsInputConfig inputDocuments) {
    this.inputDocuments = inputDocuments;
    return this;
  }

  /**
   * Optional. The labels with user-defined metadata for the request. Label keys and values can be
   * no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters,
   * numeric characters, underscores, and dashes. International characters are allowed. Label values
   * are optional. Label keys must start with a letter.
   * @return value or {@code null} for none
   */
  public java.util.Map getLabels() {
    return labels;
  }

  /**
   * Optional. The labels with user-defined metadata for the request. Label keys and values can be
   * no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters,
   * numeric characters, underscores, and dashes. International characters are allowed. Label values
   * are optional. Label keys must start with a letter.
   * @param labels labels or {@code null} for none
   */
  public GoogleCloudDocumentaiV1BatchProcessRequest setLabels(java.util.Map labels) {
    this.labels = labels;
    return this;
  }

  /**
   * Inference-time options for the process API
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1ProcessOptions getProcessOptions() {
    return processOptions;
  }

  /**
   * Inference-time options for the process API
   * @param processOptions processOptions or {@code null} for none
   */
  public GoogleCloudDocumentaiV1BatchProcessRequest setProcessOptions(GoogleCloudDocumentaiV1ProcessOptions processOptions) {
    this.processOptions = processOptions;
    return this;
  }

  /**
   * Whether human review should be skipped for this request. Default to `false`.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSkipHumanReview() {
    return skipHumanReview;
  }

  /**
   * Whether human review should be skipped for this request. Default to `false`.
   * @param skipHumanReview skipHumanReview or {@code null} for none
   */
  public GoogleCloudDocumentaiV1BatchProcessRequest setSkipHumanReview(java.lang.Boolean skipHumanReview) {
    this.skipHumanReview = skipHumanReview;
    return this;
  }

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

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

}