Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface ProcessRequestOrBuilder (2.33.0)

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=416

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 the 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
Type	Description
`FieldMask`	The fieldMask.

getFieldMaskOrBuilder()

public abstract FieldMaskOrBuilder getFieldMaskOrBuilder()

.google.protobuf.FieldMask field_mask = 6;

Returns
Type	Description
`FieldMaskOrBuilder`

getGcsDocument()

public abstract GcsDocument getGcsDocument()

A raw document on Google Cloud Storage.

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

Returns
Type	Description
`GcsDocument`	The gcsDocument.

getGcsDocumentOrBuilder()

public abstract GcsDocumentOrBuilder getGcsDocumentOrBuilder()

A raw document on Google Cloud Storage.

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

Returns
Type	Description
`GcsDocumentOrBuilder`

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()

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 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=416

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()

.google.protobuf.FieldMask field_mask = 6;

Returns
Type	Description
`boolean`	Whether the fieldMask field is set.

hasGcsDocument()

public abstract boolean hasGcsDocument()

A raw document on Google Cloud Storage.

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

Returns
Type	Description
`boolean`	Whether the gcsDocument 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.