com.google.cloud.documentai.v1beta3.BatchProcessRequestOrBuilder 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 BatchProcessRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.BatchProcessRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The resource name of
   * [Processor][google.cloud.documentai.v1beta3.Processor] or
   * [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
   * Format: `projects/{project}/locations/{location}/processors/{processor}`,
   * or
   * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Required. The resource name of
   * [Processor][google.cloud.documentai.v1beta3.Processor] or
   * [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
   * Format: `projects/{project}/locations/{location}/processors/{processor}`,
   * or
   * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * The input config for each single document in the batch process.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
   * 
   */
  @java.lang.Deprecated
  java.util.List
      getInputConfigsList();
  /**
   *
   *
   *    * The input config for each single document in the batch process.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
   * 
   */
  @java.lang.Deprecated
  com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig getInputConfigs(
      int index);
  /**
   *
   *
   *    * The input config for each single document in the batch process.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
   * 
   */
  @java.lang.Deprecated
  int getInputConfigsCount();
  /**
   *
   *
   *    * The input config for each single document in the batch process.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
   * 
   */
  @java.lang.Deprecated
  java.util.List<
          ? extends
              com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfigOrBuilder>
      getInputConfigsOrBuilderList();
  /**
   *
   *
   *    * The input config for each single document in the batch process.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
   * 
   */
  @java.lang.Deprecated
  com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfigOrBuilder
      getInputConfigsOrBuilder(int index);

  /**
   *
   *
   *    * The overall output config for batch process.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
   * 
   *
   * @deprecated google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated.
   *     See google/cloud/documentai/v1beta3/document_processor_service.proto;l=541
   * @return Whether the outputConfig field is set.
   */
  @java.lang.Deprecated
  boolean hasOutputConfig();
  /**
   *
   *
   *    * The overall output config for batch process.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
   * 
   *
   * @deprecated google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated.
   *     See google/cloud/documentai/v1beta3/document_processor_service.proto;l=541
   * @return The outputConfig.
   */
  @java.lang.Deprecated
  com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig getOutputConfig();
  /**
   *
   *
   *    * The overall output config for batch process.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
   * 
   */
  @java.lang.Deprecated
  com.google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfigOrBuilder
      getOutputConfigOrBuilder();

  /**
   *
   *
   *    * The input documents for the
   * [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
   * method.
   * 
   *
   * .google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
   *
   * @return Whether the inputDocuments field is set.
   */
  boolean hasInputDocuments();
  /**
   *
   *
   *    * The input documents for the
   * [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
   * method.
   * 
   *
   * .google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
   *
   * @return The inputDocuments.
   */
  com.google.cloud.documentai.v1beta3.BatchDocumentsInputConfig getInputDocuments();
  /**
   *
   *
   *    * The input documents for the
   * [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
   * method.
   * 
   *
   * .google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
   */
  com.google.cloud.documentai.v1beta3.BatchDocumentsInputConfigOrBuilder
      getInputDocumentsOrBuilder();

  /**
   *
   *
   *    * The output configuration for the
   * [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
   * method.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
   *
   * @return Whether the documentOutputConfig field is set.
   */
  boolean hasDocumentOutputConfig();
  /**
   *
   *
   *    * The output configuration for the
   * [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
   * method.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
   *
   * @return The documentOutputConfig.
   */
  com.google.cloud.documentai.v1beta3.DocumentOutputConfig getDocumentOutputConfig();
  /**
   *
   *
   *    * The output configuration for the
   * [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
   * method.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
   */
  com.google.cloud.documentai.v1beta3.DocumentOutputConfigOrBuilder
      getDocumentOutputConfigOrBuilder();

  /**
   *
   *
   *    * Whether human review should be skipped for this request. Default to
   * `false`.
   * 
   *
   * bool skip_human_review = 4;
   *
   * @return The skipHumanReview.
   */
  boolean getSkipHumanReview();

  /**
   *
   *
   *    * Inference-time options for the process API
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
   *
   * @return Whether the processOptions field is set.
   */
  boolean hasProcessOptions();
  /**
   *
   *
   *    * Inference-time options for the process API
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
   *
   * @return The processOptions.
   */
  com.google.cloud.documentai.v1beta3.ProcessOptions getProcessOptions();
  /**
   *
   *
   *    * Inference-time options for the process API
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
   */
  com.google.cloud.documentai.v1beta3.ProcessOptionsOrBuilder getProcessOptionsOrBuilder();

  /**
   *
   *
   *    * 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.
   * 
   *
   * map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
   */
  int getLabelsCount();
  /**
   *
   *
   *    * 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.
   * 
   *
   * map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
   */
  boolean containsLabels(java.lang.String key);
  /** Use {@link #getLabelsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getLabels();
  /**
   *
   *
   *    * 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.
   * 
   *
   * map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.Map getLabelsMap();
  /**
   *
   *
   *    * 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.
   * 
   *
   * map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
   */
  /* nullable */
  java.lang.String getLabelsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * 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.
   * 
   *
   * map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);
}