com.google.cloud.documentai.v1beta3.ProcessRequestOrBuilder 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
Show all versions of proto-google-cloud-document-ai-v1beta3 Show documentation
PROTO library for proto-google-cloud-document-ai-v1beta3
/*
* 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 ProcessRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.ProcessRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* An inline document proto.
*
*
* .google.cloud.documentai.v1beta3.Document inline_document = 4;
*
* @return Whether the inlineDocument field is set.
*/
boolean hasInlineDocument();
/**
*
*
*
* An inline document proto.
*
*
* .google.cloud.documentai.v1beta3.Document inline_document = 4;
*
* @return The inlineDocument.
*/
com.google.cloud.documentai.v1beta3.Document getInlineDocument();
/**
*
*
*
* An inline document proto.
*
*
* .google.cloud.documentai.v1beta3.Document inline_document = 4;
*/
com.google.cloud.documentai.v1beta3.DocumentOrBuilder getInlineDocumentOrBuilder();
/**
*
*
*
* A raw document content (bytes).
*
*
* .google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
*
* @return Whether the rawDocument field is set.
*/
boolean hasRawDocument();
/**
*
*
*
* A raw document content (bytes).
*
*
* .google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
*
* @return The rawDocument.
*/
com.google.cloud.documentai.v1beta3.RawDocument getRawDocument();
/**
*
*
*
* A raw document content (bytes).
*
*
* .google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
*/
com.google.cloud.documentai.v1beta3.RawDocumentOrBuilder getRawDocumentOrBuilder();
/**
*
*
*
* A raw document on Google Cloud Storage.
*
*
* .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;
*
* @return Whether the gcsDocument field is set.
*/
boolean hasGcsDocument();
/**
*
*
*
* A raw document on Google Cloud Storage.
*
*
* .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;
*
* @return The gcsDocument.
*/
com.google.cloud.documentai.v1beta3.GcsDocument getGcsDocument();
/**
*
*
*
* A raw document on Google Cloud Storage.
*
*
* .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;
*/
com.google.cloud.documentai.v1beta3.GcsDocumentOrBuilder getGcsDocumentOrBuilder();
/**
*
*
*
* Required. The resource name of the
* [Processor][google.cloud.documentai.v1beta3.Processor] or
* [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
* to use for processing. If a
* [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
* server will use its [default
* version][google.cloud.documentai.v1beta3.Processor.default_processor_version].
* 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 the
* [Processor][google.cloud.documentai.v1beta3.Processor] or
* [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
* to use for processing. If a
* [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
* server will use its [default
* version][google.cloud.documentai.v1beta3.Processor.default_processor_version].
* 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 document payload, the
* [content][google.cloud.documentai.v1beta3.Document.content] and
* [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
* be set.
*
*
* .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
*
* @deprecated google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
* google/cloud/documentai/v1beta3/document_processor_service.proto;l=415
* @return Whether the document field is set.
*/
@java.lang.Deprecated
boolean hasDocument();
/**
*
*
*
* The document payload, the
* [content][google.cloud.documentai.v1beta3.Document.content] and
* [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
* be set.
*
*
* .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
*
* @deprecated google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
* google/cloud/documentai/v1beta3/document_processor_service.proto;l=415
* @return The document.
*/
@java.lang.Deprecated
com.google.cloud.documentai.v1beta3.Document getDocument();
/**
*
*
*
* The document payload, the
* [content][google.cloud.documentai.v1beta3.Document.content] and
* [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
* be set.
*
*
* .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
*/
@java.lang.Deprecated
com.google.cloud.documentai.v1beta3.DocumentOrBuilder getDocumentOrBuilder();
/**
*
*
*
* Whether human review should be skipped for this request. Default to
* `false`.
*
*
* bool skip_human_review = 3;
*
* @return The skipHumanReview.
*/
boolean getSkipHumanReview();
/**
*
*
*
* Specifies which fields to include in the
* [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document]
* output. Only supports top-level document and pages field, so it must be in
* the form of `{document_field_name}` or `pages.{page_field_name}`.
*
*
* .google.protobuf.FieldMask field_mask = 6;
*
* @return Whether the fieldMask field is set.
*/
boolean hasFieldMask();
/**
*
*
*
* Specifies which fields to include in the
* [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document]
* output. Only supports top-level document and pages field, so it must be in
* the form of `{document_field_name}` or `pages.{page_field_name}`.
*
*
* .google.protobuf.FieldMask field_mask = 6;
*
* @return The fieldMask.
*/
com.google.protobuf.FieldMask getFieldMask();
/**
*
*
*
* Specifies which fields to include in the
* [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document]
* output. Only supports top-level document and pages field, so it must be in
* the form of `{document_field_name}` or `pages.{page_field_name}`.
*
*
* .google.protobuf.FieldMask field_mask = 6;
*/
com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder();
/**
*
*
*
* 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 = 10 [(.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 = 10 [(.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 = 10 [(.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 = 10 [(.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 = 10 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
com.google.cloud.documentai.v1beta3.ProcessRequest.SourceCase getSourceCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy