Interface ProcessRequestOrBuilder (2.18.0)

Version 2.18.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public interface ProcessRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocument() (deprecated)

public abstract Document getDocument()

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

The document payload, the [content] and [mime_type] fields must be set.

.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

Returns
Type	Description
Document	The document.

getDocumentOrBuilder()

public abstract DocumentOrBuilder getDocumentOrBuilder()

The document payload, the [content] and [mime_type] fields must be set.

.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

Returns
Type	Description
DocumentOrBuilder

getFieldMask()

public abstract 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
Type	Description
FieldMask	The fieldMask.

getFieldMaskOrBuilder()

public abstract 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;

Returns
Type	Description
FieldMaskOrBuilder

getInlineDocument()

public abstract Document getInlineDocument()

An inline document proto.

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

Returns
Type	Description
Document	The inlineDocument.

getInlineDocumentOrBuilder()

public abstract DocumentOrBuilder getInlineDocumentOrBuilder()

An inline document proto.

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

Returns
Type	Description
DocumentOrBuilder

getName()

public abstract String getName()

Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default 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
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default 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
Type	Description
ByteString	The bytes for name.

getProcessOptions()

public abstract ProcessOptions getProcessOptions()

Inference-time options for the process API

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

Returns
Type	Description
ProcessOptions	The processOptions.

getProcessOptionsOrBuilder()

public abstract ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

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

Returns
Type	Description
ProcessOptionsOrBuilder

getRawDocument()

public abstract RawDocument getRawDocument()

A raw document content (bytes).

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

Returns
Type	Description
RawDocument	The rawDocument.

getRawDocumentOrBuilder()

public abstract RawDocumentOrBuilder getRawDocumentOrBuilder()

A raw document content (bytes).

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

Returns
Type	Description
RawDocumentOrBuilder

getSkipHumanReview()

public abstract boolean getSkipHumanReview()

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

bool skip_human_review = 3;

Returns
Type	Description
boolean	The skipHumanReview.

getSourceCase()

public abstract ProcessRequest.SourceCase getSourceCase()

Returns
Type	Description
ProcessRequest.SourceCase

hasDocument() (deprecated)

public abstract boolean hasDocument()

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

The document payload, the [content] and [mime_type] fields must be set.

.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

Returns
Type	Description
boolean	Whether the document field is set.

hasFieldMask()

public abstract 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
Type	Description
boolean	Whether the fieldMask field is set.

hasInlineDocument()

public abstract boolean hasInlineDocument()

An inline document proto.

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

Returns
Type	Description
boolean	Whether the inlineDocument field is set.

hasProcessOptions()

public abstract boolean hasProcessOptions()

Inference-time options for the process API

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

Returns
Type	Description
boolean	Whether the processOptions field is set.

hasRawDocument()

public abstract boolean hasRawDocument()

A raw document content (bytes).

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

Returns
Type	Description
boolean	Whether the rawDocument field is set.