Class ProcessRequest.Builder (2.48.0)

public static final class ProcessRequest.Builder extends GeneratedMessageV3.Builder<ProcessRequest.Builder> implements ProcessRequestOrBuilder

Request message for the ProcessDocument method.

Protobuf type google.cloud.documentai.v1.ProcessRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProcessRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessRequest.Builder
Overrides

build()

public ProcessRequest build()
Returns
Type Description
ProcessRequest

buildPartial()

public ProcessRequest buildPartial()
Returns
Type Description
ProcessRequest

clear()

public ProcessRequest.Builder clear()
Returns
Type Description
ProcessRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ProcessRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ProcessRequest.Builder
Overrides

clearFieldMask()

public ProcessRequest.Builder clearFieldMask()

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
ProcessRequest.Builder

clearGcsDocument()

public ProcessRequest.Builder clearGcsDocument()

A raw document on Google Cloud Storage.

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

Returns
Type Description
ProcessRequest.Builder

clearInlineDocument()

public ProcessRequest.Builder clearInlineDocument()

An inline document proto.

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

Returns
Type Description
ProcessRequest.Builder

clearLabels()

public ProcessRequest.Builder clearLabels()
Returns
Type Description
ProcessRequest.Builder

clearName()

public ProcessRequest.Builder clearName()

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
ProcessRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ProcessRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ProcessRequest.Builder
Overrides

clearProcessOptions()

public ProcessRequest.Builder clearProcessOptions()

Inference-time options for the process API

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

Returns
Type Description
ProcessRequest.Builder

clearRawDocument()

public ProcessRequest.Builder clearRawDocument()

A raw document content (bytes).

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

Returns
Type Description
ProcessRequest.Builder

clearSkipHumanReview()

public ProcessRequest.Builder clearSkipHumanReview()

Whether human review should be skipped for this request. Default to false.

bool skip_human_review = 3;

Returns
Type Description
ProcessRequest.Builder

This builder for chaining.

clearSource()

public ProcessRequest.Builder clearSource()
Returns
Type Description
ProcessRequest.Builder

clone()

public ProcessRequest.Builder clone()
Returns
Type Description
ProcessRequest.Builder
Overrides

containsLabels(String key)

public 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

getDefaultInstanceForType()

public ProcessRequest getDefaultInstanceForType()
Returns
Type Description
ProcessRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFieldMask()

public 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.

getFieldMaskBuilder()

public FieldMask.Builder getFieldMaskBuilder()

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
Builder

getFieldMaskOrBuilder()

public 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 GcsDocument getGcsDocument()

A raw document on Google Cloud Storage.

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

Returns
Type Description
GcsDocument

The gcsDocument.

getGcsDocumentBuilder()

public GcsDocument.Builder getGcsDocumentBuilder()

A raw document on Google Cloud Storage.

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

Returns
Type Description
GcsDocument.Builder

getGcsDocumentOrBuilder()

public GcsDocumentOrBuilder getGcsDocumentOrBuilder()

A raw document on Google Cloud Storage.

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

Returns
Type Description
GcsDocumentOrBuilder

getInlineDocument()

public Document getInlineDocument()

An inline document proto.

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

Returns
Type Description
Document

The inlineDocument.

getInlineDocumentBuilder()

public Document.Builder getInlineDocumentBuilder()

An inline document proto.

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

Returns
Type Description
Document.Builder

getInlineDocumentOrBuilder()

public DocumentOrBuilder getInlineDocumentOrBuilder()

An inline document proto.

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

Returns
Type Description
DocumentOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public 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 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 ProcessOptions getProcessOptions()

Inference-time options for the process API

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

Returns
Type Description
ProcessOptions

The processOptions.

getProcessOptionsBuilder()

public ProcessOptions.Builder getProcessOptionsBuilder()

Inference-time options for the process API

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

Returns
Type Description
ProcessOptions.Builder

getProcessOptionsOrBuilder()

public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

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

Returns
Type Description
ProcessOptionsOrBuilder

getRawDocument()

public RawDocument getRawDocument()

A raw document content (bytes).

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

Returns
Type Description
RawDocument

The rawDocument.

getRawDocumentBuilder()

public RawDocument.Builder getRawDocumentBuilder()

A raw document content (bytes).

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

Returns
Type Description
RawDocument.Builder

getRawDocumentOrBuilder()

public RawDocumentOrBuilder getRawDocumentOrBuilder()

A raw document content (bytes).

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

Returns
Type Description
RawDocumentOrBuilder

getSkipHumanReview()

public 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 ProcessRequest.SourceCase getSourceCase()
Returns
Type Description
ProcessRequest.SourceCase

hasFieldMask()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFieldMask(FieldMask value)

public ProcessRequest.Builder mergeFieldMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ProcessRequest.Builder

mergeFrom(ProcessRequest other)

public ProcessRequest.Builder mergeFrom(ProcessRequest other)
Parameter
Name Description
other ProcessRequest
Returns
Type Description
ProcessRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProcessRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ProcessRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ProcessRequest.Builder
Overrides

mergeGcsDocument(GcsDocument value)

public ProcessRequest.Builder mergeGcsDocument(GcsDocument value)

A raw document on Google Cloud Storage.

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

Parameter
Name Description
value GcsDocument
Returns
Type Description
ProcessRequest.Builder

mergeInlineDocument(Document value)

public ProcessRequest.Builder mergeInlineDocument(Document value)

An inline document proto.

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

Parameter
Name Description
value Document
Returns
Type Description
ProcessRequest.Builder

mergeProcessOptions(ProcessOptions value)

public ProcessRequest.Builder mergeProcessOptions(ProcessOptions value)

Inference-time options for the process API

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

Parameter
Name Description
value ProcessOptions
Returns
Type Description
ProcessRequest.Builder

mergeRawDocument(RawDocument value)

public ProcessRequest.Builder mergeRawDocument(RawDocument value)

A raw document content (bytes).

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

Parameter
Name Description
value RawDocument
Returns
Type Description
ProcessRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProcessRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProcessRequest.Builder
Overrides

putAllLabels(Map<String,String> values)

public ProcessRequest.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
ProcessRequest.Builder

putLabels(String key, String value)

public ProcessRequest.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
ProcessRequest.Builder

removeLabels(String key)

public ProcessRequest.Builder removeLabels(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
ProcessRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ProcessRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessRequest.Builder
Overrides

setFieldMask(FieldMask value)

public ProcessRequest.Builder setFieldMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ProcessRequest.Builder

setFieldMask(FieldMask.Builder builderForValue)

public ProcessRequest.Builder setFieldMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ProcessRequest.Builder

setGcsDocument(GcsDocument value)

public ProcessRequest.Builder setGcsDocument(GcsDocument value)

A raw document on Google Cloud Storage.

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

Parameter
Name Description
value GcsDocument
Returns
Type Description
ProcessRequest.Builder

setGcsDocument(GcsDocument.Builder builderForValue)

public ProcessRequest.Builder setGcsDocument(GcsDocument.Builder builderForValue)

A raw document on Google Cloud Storage.

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

Parameter
Name Description
builderForValue GcsDocument.Builder
Returns
Type Description
ProcessRequest.Builder

setInlineDocument(Document value)

public ProcessRequest.Builder setInlineDocument(Document value)

An inline document proto.

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

Parameter
Name Description
value Document
Returns
Type Description
ProcessRequest.Builder

setInlineDocument(Document.Builder builderForValue)

public ProcessRequest.Builder setInlineDocument(Document.Builder builderForValue)

An inline document proto.

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

Parameter
Name Description
builderForValue Document.Builder
Returns
Type Description
ProcessRequest.Builder

setName(String value)

public ProcessRequest.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ProcessRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ProcessRequest.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ProcessRequest.Builder

This builder for chaining.

setProcessOptions(ProcessOptions value)

public ProcessRequest.Builder setProcessOptions(ProcessOptions value)

Inference-time options for the process API

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

Parameter
Name Description
value ProcessOptions
Returns
Type Description
ProcessRequest.Builder

setProcessOptions(ProcessOptions.Builder builderForValue)

public ProcessRequest.Builder setProcessOptions(ProcessOptions.Builder builderForValue)

Inference-time options for the process API

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

Parameter
Name Description
builderForValue ProcessOptions.Builder
Returns
Type Description
ProcessRequest.Builder

setRawDocument(RawDocument value)

public ProcessRequest.Builder setRawDocument(RawDocument value)

A raw document content (bytes).

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

Parameter
Name Description
value RawDocument
Returns
Type Description
ProcessRequest.Builder

setRawDocument(RawDocument.Builder builderForValue)

public ProcessRequest.Builder setRawDocument(RawDocument.Builder builderForValue)

A raw document content (bytes).

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

Parameter
Name Description
builderForValue RawDocument.Builder
Returns
Type Description
ProcessRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ProcessRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ProcessRequest.Builder
Overrides

setSkipHumanReview(boolean value)

public ProcessRequest.Builder setSkipHumanReview(boolean value)

Whether human review should be skipped for this request. Default to false.

bool skip_human_review = 3;

Parameter
Name Description
value boolean

The skipHumanReview to set.

Returns
Type Description
ProcessRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ProcessRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProcessRequest.Builder
Overrides