com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-document-ai-v1beta3 Show documentation
PROTO library for proto-google-cloud-document-ai-v1beta3
There is a newer version: 0.71.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/documentai/v1beta3/document_processor_service.proto

// Protobuf Java Version: 3.25.2
package com.google.cloud.documentai.v1beta3;

public interface TrainProcessorVersionRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.TrainProcessorVersionRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Options to control Custom Document Extraction (CDE) Processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;
   * 
   *
   * @return Whether the customDocumentExtractionOptions field is set.
   */
  boolean hasCustomDocumentExtractionOptions();
  /**
   *
   *
   *    * Options to control Custom Document Extraction (CDE) Processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;
   * 
   *
   * @return The customDocumentExtractionOptions.
   */
  com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.CustomDocumentExtractionOptions
      getCustomDocumentExtractionOptions();
  /**
   *
   *
   *    * Options to control Custom Document Extraction (CDE) Processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.CustomDocumentExtractionOptions custom_document_extraction_options = 5;
   * 
   */
  com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequest
          .CustomDocumentExtractionOptionsOrBuilder
      getCustomDocumentExtractionOptionsOrBuilder();

  /**
   *
   *
   *    * Options to control foundation model tuning of a processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;
   * 
   *
   * @return Whether the foundationModelTuningOptions field is set.
   */
  boolean hasFoundationModelTuningOptions();
  /**
   *
   *
   *    * Options to control foundation model tuning of a processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;
   * 
   *
   * @return The foundationModelTuningOptions.
   */
  com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.FoundationModelTuningOptions
      getFoundationModelTuningOptions();
  /**
   *
   *
   *    * Options to control foundation model tuning of a processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.FoundationModelTuningOptions foundation_model_tuning_options = 12;
   * 
   */
  com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequest
          .FoundationModelTuningOptionsOrBuilder
      getFoundationModelTuningOptionsOrBuilder();

  /**
   *
   *
   *    * Required. The parent (project, location and processor) to create the new
   * version for. Format:
   * `projects/{project}/locations/{location}/processors/{processor}`.
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. The parent (project, location and processor) to create the new
   * version for. Format:
   * `projects/{project}/locations/{location}/processors/{processor}`.
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Required. The processor version to be created.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the processorVersion field is set.
   */
  boolean hasProcessorVersion();
  /**
   *
   *
   *    * Required. The processor version to be created.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The processorVersion.
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersion getProcessorVersion();
  /**
   *
   *
   *    * Required. The processor version to be created.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.ProcessorVersion processor_version = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersionOrBuilder getProcessorVersionOrBuilder();

  /**
   *
   *
   *    * Optional. The schema the processor version will be trained with.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the documentSchema field is set.
   */
  boolean hasDocumentSchema();
  /**
   *
   *
   *    * Optional. The schema the processor version will be trained with.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The documentSchema.
   */
  com.google.cloud.documentai.v1beta3.DocumentSchema getDocumentSchema();
  /**
   *
   *
   *    * Optional. The schema the processor version will be trained with.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.DocumentSchema document_schema = 10 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.documentai.v1beta3.DocumentSchemaOrBuilder getDocumentSchemaOrBuilder();

  /**
   *
   *
   *    * Optional. The input data used to train the
   * [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the inputData field is set.
   */
  boolean hasInputData();
  /**
   *
   *
   *    * Optional. The input data used to train the
   * [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The inputData.
   */
  com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputData getInputData();
  /**
   *
   *
   *    * Optional. The input data used to train the
   * [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputData input_data = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.InputDataOrBuilder
      getInputDataOrBuilder();

  /**
   *
   *
   *    * 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}/processorVersions/{processorVersion}`.
   * 
   *
   * string base_processor_version = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The baseProcessorVersion.
   */
  java.lang.String getBaseProcessorVersion();
  /**
   *
   *
   *    * 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}/processorVersions/{processorVersion}`.
   * 
   *
   * string base_processor_version = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for baseProcessorVersion.
   */
  com.google.protobuf.ByteString getBaseProcessorVersionBytes();

  com.google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.ProcessorFlagsCase
      getProcessorFlagsCase();
}