com.google.api.services.documentai.v1.model.GoogleCloudDocumentaiV1TrainProcessorVersionRequest 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 the TrainProcessorVersion method.
 *
 *  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 GoogleCloudDocumentaiV1TrainProcessorVersionRequest extends com.google.api.client.json.GenericJson {

  /**
   * Optional. The processor version to use as a base for training. This processor version must be a
   * child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/proc
   * essorVersions/{processorVersion}`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String baseProcessorVersion;

  /**
   * Options to control Custom Document Extraction (CDE) Processor.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions customDocumentExtractionOptions;

  /**
   * Optional. The schema the processor version will be trained with.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1DocumentSchema documentSchema;

  /**
   * Options to control foundation model tuning of a processor.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions foundationModelTuningOptions;

  /**
   * Optional. The input data used to train the ProcessorVersion.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData inputData;

  /**
   * Required. The processor version to be created.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1ProcessorVersion processorVersion;

  /**
   * Optional. The processor version to use as a base for training. This processor version must be a
   * child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/proc
   * essorVersions/{processorVersion}`.
   * @return value or {@code null} for none
   */
  public java.lang.String getBaseProcessorVersion() {
    return baseProcessorVersion;
  }

  /**
   * Optional. The processor version to use as a base for training. This processor version must be a
   * child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/proc
   * essorVersions/{processorVersion}`.
   * @param baseProcessorVersion baseProcessorVersion or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequest setBaseProcessorVersion(java.lang.String baseProcessorVersion) {
    this.baseProcessorVersion = baseProcessorVersion;
    return this;
  }

  /**
   * Options to control Custom Document Extraction (CDE) Processor.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions getCustomDocumentExtractionOptions() {
    return customDocumentExtractionOptions;
  }

  /**
   * Options to control Custom Document Extraction (CDE) Processor.
   * @param customDocumentExtractionOptions customDocumentExtractionOptions or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequest setCustomDocumentExtractionOptions(GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions customDocumentExtractionOptions) {
    this.customDocumentExtractionOptions = customDocumentExtractionOptions;
    return this;
  }

  /**
   * Optional. The schema the processor version will be trained with.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1DocumentSchema getDocumentSchema() {
    return documentSchema;
  }

  /**
   * Optional. The schema the processor version will be trained with.
   * @param documentSchema documentSchema or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequest setDocumentSchema(GoogleCloudDocumentaiV1DocumentSchema documentSchema) {
    this.documentSchema = documentSchema;
    return this;
  }

  /**
   * Options to control foundation model tuning of a processor.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions getFoundationModelTuningOptions() {
    return foundationModelTuningOptions;
  }

  /**
   * Options to control foundation model tuning of a processor.
   * @param foundationModelTuningOptions foundationModelTuningOptions or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequest setFoundationModelTuningOptions(GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions foundationModelTuningOptions) {
    this.foundationModelTuningOptions = foundationModelTuningOptions;
    return this;
  }

  /**
   * Optional. The input data used to train the ProcessorVersion.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData getInputData() {
    return inputData;
  }

  /**
   * Optional. The input data used to train the ProcessorVersion.
   * @param inputData inputData or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequest setInputData(GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData inputData) {
    this.inputData = inputData;
    return this;
  }

  /**
   * Required. The processor version to be created.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1ProcessorVersion getProcessorVersion() {
    return processorVersion;
  }

  /**
   * Required. The processor version to be created.
   * @param processorVersion processorVersion or {@code null} for none
   */
  public GoogleCloudDocumentaiV1TrainProcessorVersionRequest setProcessorVersion(GoogleCloudDocumentaiV1ProcessorVersion processorVersion) {
    this.processorVersion = processorVersion;
    return this;
  }

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

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

}