com.google.cloud.documentai.v1beta3

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
boolean	containsLabels(String key) Optional.
Document	getDocument() Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
DocumentOrBuilder	getDocumentOrBuilder() Deprecated.
com.google.protobuf.FieldMask	getFieldMask() Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document] output.
com.google.protobuf.FieldMaskOrBuilder	getFieldMaskOrBuilder() Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document] output.
GcsDocument	getGcsDocument() A raw document on Google Cloud Storage.
GcsDocumentOrBuilder	getGcsDocumentOrBuilder() A raw document on Google Cloud Storage.
boolean	getImagelessMode() Optional.
Document	getInlineDocument() An inline document proto.
DocumentOrBuilder	getInlineDocumentOrBuilder() An inline document proto.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
ProcessOptions	getProcessOptions() Inference-time options for the process API .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
ProcessOptionsOrBuilder	getProcessOptionsOrBuilder() Inference-time options for the process API .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
RawDocument	getRawDocument() A raw document content (bytes).
RawDocumentOrBuilder	getRawDocumentOrBuilder() A raw document content (bytes).
boolean	getSkipHumanReview() Whether human review should be skipped for this request.
ProcessRequest.SourceCase	getSourceCase()
boolean	hasDocument() Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
boolean	hasFieldMask() Specifies which fields to include in the [ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document] output.
boolean	hasGcsDocument() A raw document on Google Cloud Storage.
boolean	hasInlineDocument() An inline document proto.
boolean	hasProcessOptions() Inference-time options for the process API .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
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.v1beta3.Document inline_document = 4;

Returns:

Whether the inlineDocument field is set.

getInlineDocument

Document getInlineDocument()

 An inline document proto.
 

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

Returns:

The inlineDocument.

getInlineDocumentOrBuilder

DocumentOrBuilder getInlineDocumentOrBuilder()

 An inline document proto.
 

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

hasRawDocument

boolean hasRawDocument()

 A raw document content (bytes).
 

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

Returns:

Whether the rawDocument field is set.

getRawDocument

RawDocument getRawDocument()

 A raw document content (bytes).
 

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

Returns:

The rawDocument.

getRawDocumentOrBuilder

RawDocumentOrBuilder getRawDocumentOrBuilder()

 A raw document content (bytes).
 

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

hasGcsDocument

boolean hasGcsDocument()

 A raw document on Google Cloud Storage.
 

.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

Returns:

Whether the gcsDocument field is set.

getGcsDocument

GcsDocument getGcsDocument()

 A raw document on Google Cloud Storage.
 

.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

Returns:

The gcsDocument.

getGcsDocumentOrBuilder

GcsDocumentOrBuilder getGcsDocumentOrBuilder()

 A raw document on Google Cloud Storage.
 

.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

getName

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) = { ... }

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 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) = { ... }

Returns:

The bytes for name.

hasDocument

@Deprecated
boolean hasDocument()

Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=451

 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];

Returns:

Whether the document field is set.

getDocument

@Deprecated
Document getDocument()

Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=451

 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];

Returns:

The document.

getDocumentOrBuilder

@Deprecated
DocumentOrBuilder getDocumentOrBuilder()

Deprecated.

 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];

getSkipHumanReview

boolean getSkipHumanReview()

 Whether human review 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 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;

Returns:

Whether the fieldMask field is set.

getFieldMask

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;

Returns:

The fieldMask.

getFieldMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()

 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;

hasProcessOptions

boolean hasProcessOptions()

 Inference-time options for the process API
 

.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

Returns:

Whether the processOptions field is set.

getProcessOptions

ProcessOptions getProcessOptions()

 Inference-time options for the process API
 

.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

Returns:

The processOptions.

getProcessOptionsOrBuilder

ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

 Inference-time options for the process API
 

.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

getLabelsCount

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];

containsLabels

boolean containsLabels(String key)

 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];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> 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];

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          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];

getLabelsOrThrow

String getLabelsOrThrow(String key)

 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];

getImagelessMode

boolean getImagelessMode()

 Optional. Option to remove images from the document.
 

bool imageless_mode = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The imagelessMode.

getSourceCase

ProcessRequest.SourceCase getSourceCase()