com.google.cloud.documentai.v1

Interface ProcessRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ProcessRequest, ProcessRequest.Builder

public interface ProcessRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.FieldMask	getFieldMask() Specifies which fields to include in ProcessResponse's document.
com.google.protobuf.FieldMaskOrBuilder	getFieldMaskOrBuilder() Specifies which fields to include in ProcessResponse's document.
Document	getInlineDocument() An inline document proto.
DocumentOrBuilder	getInlineDocumentOrBuilder() An inline document proto.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
RawDocument	getRawDocument() A raw document content (bytes).
RawDocumentOrBuilder	getRawDocumentOrBuilder() A raw document content (bytes).
boolean	getSkipHumanReview() Whether Human Review feature should be skipped for this request.
ProcessRequest.SourceCase	getSourceCase()
boolean	hasFieldMask() Specifies which fields to include in ProcessResponse's document.
boolean	hasInlineDocument() An inline document proto.
boolean	hasRawDocument() A raw document content (bytes).

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasInlineDocument

boolean hasInlineDocument()

 An inline document proto.
 

.google.cloud.documentai.v1.Document inline_document = 4;

Returns:

Whether the inlineDocument field is set.

getInlineDocument

Document getInlineDocument()

 An inline document proto.
 

.google.cloud.documentai.v1.Document inline_document = 4;

Returns:

The inlineDocument.

getInlineDocumentOrBuilder

DocumentOrBuilder getInlineDocumentOrBuilder()

 An inline document proto.
 

.google.cloud.documentai.v1.Document inline_document = 4;

hasRawDocument

boolean hasRawDocument()

 A raw document content (bytes).
 

.google.cloud.documentai.v1.RawDocument raw_document = 5;

Returns:

Whether the rawDocument field is set.

getRawDocument

RawDocument getRawDocument()

 A raw document content (bytes).
 

.google.cloud.documentai.v1.RawDocument raw_document = 5;

Returns:

The rawDocument.

getRawDocumentOrBuilder

RawDocumentOrBuilder getRawDocumentOrBuilder()

 A raw document content (bytes).
 

.google.cloud.documentai.v1.RawDocument raw_document = 5;

getName

String getName()

 Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use
 its [default version][google.cloud.documentai.v1.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) = { ... }

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use
 its [default version][google.cloud.documentai.v1.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) = { ... }

Returns:

The bytes for name.

getSkipHumanReview

boolean getSkipHumanReview()

 Whether Human Review feature should be skipped for this request. Default to
 false.
 

bool skip_human_review = 3;

Returns:

The skipHumanReview.

hasFieldMask

boolean hasFieldMask()

 Specifies which fields to include in ProcessResponse's document.
 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;

Returns:

Whether the fieldMask field is set.

getFieldMask

com.google.protobuf.FieldMask getFieldMask()

 Specifies which fields to include in ProcessResponse's document.
 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;

Returns:

The fieldMask.

getFieldMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()

 Specifies which fields to include in ProcessResponse's document.
 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;

getSourceCase

ProcessRequest.SourceCase getSourceCase()