Interface ProcessRequestOrBuilder (2.57.0)

Version latest

• 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

containsLabels(String key)

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

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

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
FieldMaskOrBuilder

getGcsDocument()

public abstract GcsDocument getGcsDocument()

A raw document on Google Cloud Storage.

.google.cloud.documentai.v1.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.v1.GcsDocument gcs_document = 8;

Returns
Type	Description
GcsDocumentOrBuilder

getImagelessMode()

public abstract boolean getImagelessMode()

Optional. Option to remove images from the document.

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

Returns
Type	Description
boolean	The imagelessMode.

getInlineDocument()

public abstract Document getInlineDocument()

An inline document proto.

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

Returns
Type	Description
Document	The inlineDocument.

getInlineDocumentOrBuilder()

public abstract DocumentOrBuilder getInlineDocumentOrBuilder()

An inline document proto.

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

Returns
Type	Description
DocumentOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

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

Returns
Type	Description
int

getLabelsMap()

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

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

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

Parameter
Name	Description
key	String

Returns
Type	Description
String

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.v1.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.v1.ProcessOptions process_options = 7;

Returns
Type	Description
ProcessOptionsOrBuilder

getRawDocument()

public abstract RawDocument getRawDocument()

A raw document content (bytes).

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

Returns
Type	Description
RawDocument	The rawDocument.

getRawDocumentOrBuilder()

public abstract RawDocumentOrBuilder getRawDocumentOrBuilder()

A raw document content (bytes).

.google.cloud.documentai.v1.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

hasFieldMask()

public abstract boolean hasFieldMask()

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

hasGcsDocument()

public abstract boolean hasGcsDocument()

A raw document on Google Cloud Storage.

.google.cloud.documentai.v1.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.v1.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.v1.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.v1.RawDocument raw_document = 5;

Returns
Type	Description
boolean	Whether the rawDocument field is set.