Class ProcessRequest.Builder (2.48.0)

Version 2.48.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 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProcessRequest.Builder

Implements

ProcessRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ProcessRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ProcessRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

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

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ProcessRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ProcessRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)