/*
* Copyright 2020 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/v1beta2/document_understanding.proto
package com.google.cloud.documentai.v1beta2;
public interface ProcessDocumentRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta2.ProcessDocumentRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Target project and location to make a call.
* Format: `projects/{project-id}/locations/{location-id}`.
* If no location is specified, a region will be chosen automatically.
* This field is only populated when used in ProcessDocument method.
*
*
* string parent = 9;
*
* @return The parent.
*/
java.lang.String getParent();
/**
*
*
*
* Target project and location to make a call.
* Format: `projects/{project-id}/locations/{location-id}`.
* If no location is specified, a region will be chosen automatically.
* This field is only populated when used in ProcessDocument method.
*
*
* string parent = 9;
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* Required. Information about the input file.
*
*
*
* .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the inputConfig field is set.
*/
boolean hasInputConfig();
/**
*
*
*
* Required. Information about the input file.
*
*
*
* .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The inputConfig.
*/
com.google.cloud.documentai.v1beta2.InputConfig getInputConfig();
/**
*
*
*
* Required. Information about the input file.
*
*
*
* .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.documentai.v1beta2.InputConfigOrBuilder getInputConfigOrBuilder();
/**
*
*
*
* Optional. The desired output location. This field is only needed in
* BatchProcessDocumentsRequest.
*
*
*
* .google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the outputConfig field is set.
*/
boolean hasOutputConfig();
/**
*
*
*
* Optional. The desired output location. This field is only needed in
* BatchProcessDocumentsRequest.
*
*
*
* .google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The outputConfig.
*/
com.google.cloud.documentai.v1beta2.OutputConfig getOutputConfig();
/**
*
*
*
* Optional. The desired output location. This field is only needed in
* BatchProcessDocumentsRequest.
*
*
*
* .google.cloud.documentai.v1beta2.OutputConfig output_config = 2 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.documentai.v1beta2.OutputConfigOrBuilder getOutputConfigOrBuilder();
/**
*
*
*
* Specifies a known document type for deeper structure detection. Valid
* values are currently "general" and "invoice". If not provided, "general"\
* is used as default. If any other value is given, the request is rejected.
*
*
* string document_type = 3;
*
* @return The documentType.
*/
java.lang.String getDocumentType();
/**
*
*
*
* Specifies a known document type for deeper structure detection. Valid
* values are currently "general" and "invoice". If not provided, "general"\
* is used as default. If any other value is given, the request is rejected.
*
*
* string document_type = 3;
*
* @return The bytes for documentType.
*/
com.google.protobuf.ByteString getDocumentTypeBytes();
/**
*
*
*
* Controls table extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
*
*
* @return Whether the tableExtractionParams field is set.
*/
boolean hasTableExtractionParams();
/**
*
*
*
* Controls table extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
*
*
* @return The tableExtractionParams.
*/
com.google.cloud.documentai.v1beta2.TableExtractionParams getTableExtractionParams();
/**
*
*
*
* Controls table extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
*
*/
com.google.cloud.documentai.v1beta2.TableExtractionParamsOrBuilder
getTableExtractionParamsOrBuilder();
/**
*
*
*
* Controls form extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
*
* @return Whether the formExtractionParams field is set.
*/
boolean hasFormExtractionParams();
/**
*
*
*
* Controls form extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
*
* @return The formExtractionParams.
*/
com.google.cloud.documentai.v1beta2.FormExtractionParams getFormExtractionParams();
/**
*
*
*
* Controls form extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
*/
com.google.cloud.documentai.v1beta2.FormExtractionParamsOrBuilder
getFormExtractionParamsOrBuilder();
/**
*
*
*
* Controls entity extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
*
*
* @return Whether the entityExtractionParams field is set.
*/
boolean hasEntityExtractionParams();
/**
*
*
*
* Controls entity extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
*
*
* @return The entityExtractionParams.
*/
com.google.cloud.documentai.v1beta2.EntityExtractionParams getEntityExtractionParams();
/**
*
*
*
* Controls entity extraction behavior. If not specified, the system will
* decide reasonable defaults.
*
*
* .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
*
*/
com.google.cloud.documentai.v1beta2.EntityExtractionParamsOrBuilder
getEntityExtractionParamsOrBuilder();
/**
*
*
*
* Controls OCR behavior. If not specified, the system will decide reasonable
* defaults.
*
*
* .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
*
* @return Whether the ocrParams field is set.
*/
boolean hasOcrParams();
/**
*
*
*
* Controls OCR behavior. If not specified, the system will decide reasonable
* defaults.
*
*
* .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
*
* @return The ocrParams.
*/
com.google.cloud.documentai.v1beta2.OcrParams getOcrParams();
/**
*
*
*
* Controls OCR behavior. If not specified, the system will decide reasonable
* defaults.
*
*
* .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
*/
com.google.cloud.documentai.v1beta2.OcrParamsOrBuilder getOcrParamsOrBuilder();
/**
*
*
*
* Controls AutoML model prediction behavior. AutoMlParams cannot be used
* together with other Params.
*
*
* .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
*
* @return Whether the automlParams field is set.
*/
boolean hasAutomlParams();
/**
*
*
*
* Controls AutoML model prediction behavior. AutoMlParams cannot be used
* together with other Params.
*
*
* .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
*
* @return The automlParams.
*/
com.google.cloud.documentai.v1beta2.AutoMlParams getAutomlParams();
/**
*
*
*
* Controls AutoML model prediction behavior. AutoMlParams cannot be used
* together with other Params.
*
*
* .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
*/
com.google.cloud.documentai.v1beta2.AutoMlParamsOrBuilder getAutomlParamsOrBuilder();
}