Class ProcessRequest.Builder (2.7.2)

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

Request message for the process document method.

Protobuf type google.cloud.documentai.v1beta3.ProcessRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProcessRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ProcessRequest.Builder
Overrides

build()

public ProcessRequest build()
Returns
TypeDescription
ProcessRequest

buildPartial()

public ProcessRequest buildPartial()
Returns
TypeDescription
ProcessRequest

clear()

public ProcessRequest.Builder clear()
Returns
TypeDescription
ProcessRequest.Builder
Overrides

clearDocument()

public ProcessRequest.Builder clearDocument()

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

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

Returns
TypeDescription
ProcessRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ProcessRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ProcessRequest.Builder
Overrides

clearFieldMask()

public ProcessRequest.Builder clearFieldMask()

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Returns
TypeDescription
ProcessRequest.Builder

clearInlineDocument()

public ProcessRequest.Builder clearInlineDocument()

An inline document proto.

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

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ProcessRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ProcessRequest.Builder
Overrides

clearRawDocument()

public ProcessRequest.Builder clearRawDocument()

A raw document content (bytes).

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

Returns
TypeDescription
ProcessRequest.Builder

clearSkipHumanReview()

public ProcessRequest.Builder clearSkipHumanReview()

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

bool skip_human_review = 3;

Returns
TypeDescription
ProcessRequest.Builder

This builder for chaining.

clearSource()

public ProcessRequest.Builder clearSource()
Returns
TypeDescription
ProcessRequest.Builder

clone()

public ProcessRequest.Builder clone()
Returns
TypeDescription
ProcessRequest.Builder
Overrides

getDefaultInstanceForType()

public ProcessRequest getDefaultInstanceForType()
Returns
TypeDescription
ProcessRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocument() (deprecated)

public Document getDocument()

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

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

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

Returns
TypeDescription
Document

The document.

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

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

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

Returns
TypeDescription
Document.Builder

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

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

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

Returns
TypeDescription
DocumentOrBuilder

getFieldMask()

public FieldMask getFieldMask()

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Returns
TypeDescription
FieldMask

The fieldMask.

getFieldMaskBuilder()

public FieldMask.Builder getFieldMaskBuilder()

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Returns
TypeDescription
Builder

getFieldMaskOrBuilder()

public FieldMaskOrBuilder getFieldMaskOrBuilder()

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Returns
TypeDescription
FieldMaskOrBuilder

getInlineDocument()

public Document getInlineDocument()

An inline document proto.

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

Returns
TypeDescription
Document

The inlineDocument.

getInlineDocumentBuilder()

public Document.Builder getInlineDocumentBuilder()

An inline document proto.

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

Returns
TypeDescription
Document.Builder

getInlineDocumentOrBuilder()

public DocumentOrBuilder getInlineDocumentOrBuilder()

An inline document proto.

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

Returns
TypeDescription
DocumentOrBuilder

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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getRawDocument()

public RawDocument getRawDocument()

A raw document content (bytes).

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

Returns
TypeDescription
RawDocument

The rawDocument.

getRawDocumentBuilder()

public RawDocument.Builder getRawDocumentBuilder()

A raw document content (bytes).

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

Returns
TypeDescription
RawDocument.Builder

getRawDocumentOrBuilder()

public RawDocumentOrBuilder getRawDocumentOrBuilder()

A raw document content (bytes).

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

Returns
TypeDescription
RawDocumentOrBuilder

getSkipHumanReview()

public boolean getSkipHumanReview()

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

bool skip_human_review = 3;

Returns
TypeDescription
boolean

The skipHumanReview.

getSourceCase()

public ProcessRequest.SourceCase getSourceCase()
Returns
TypeDescription
ProcessRequest.SourceCase

hasDocument() (deprecated)

public boolean hasDocument()

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

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

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

Returns
TypeDescription
boolean

Whether the document field is set.

hasFieldMask()

public boolean hasFieldMask()

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Returns
TypeDescription
boolean

Whether the fieldMask field is set.

hasInlineDocument()

public boolean hasInlineDocument()

An inline document proto.

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

Returns
TypeDescription
boolean

Whether the inlineDocument field is set.

hasRawDocument()

public boolean hasRawDocument()

A raw document content (bytes).

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

Returns
TypeDescription
boolean

Whether the rawDocument field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDocument(Document value)

public ProcessRequest.Builder mergeDocument(Document value)

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

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
ProcessRequest.Builder

mergeFieldMask(FieldMask value)

public ProcessRequest.Builder mergeFieldMask(FieldMask value)

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ProcessRequest.Builder

mergeFrom(ProcessRequest other)

public ProcessRequest.Builder mergeFrom(ProcessRequest other)
Parameter
NameDescription
otherProcessRequest
Returns
TypeDescription
ProcessRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProcessRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ProcessRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ProcessRequest.Builder
Overrides

mergeInlineDocument(Document value)

public ProcessRequest.Builder mergeInlineDocument(Document value)

An inline document proto.

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
ProcessRequest.Builder

mergeRawDocument(RawDocument value)

public ProcessRequest.Builder mergeRawDocument(RawDocument value)

A raw document content (bytes).

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

Parameter
NameDescription
valueRawDocument
Returns
TypeDescription
ProcessRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProcessRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ProcessRequest.Builder
Overrides

setDocument(Document value)

public ProcessRequest.Builder setDocument(Document value)

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

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
ProcessRequest.Builder

setDocument(Document.Builder builderForValue)

public ProcessRequest.Builder setDocument(Document.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
ProcessRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ProcessRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ProcessRequest.Builder
Overrides

setFieldMask(FieldMask value)

public ProcessRequest.Builder setFieldMask(FieldMask value)

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ProcessRequest.Builder

setFieldMask(FieldMask.Builder builderForValue)

public ProcessRequest.Builder setFieldMask(FieldMask.Builder builderForValue)

Specifies which fields to include in ProcessResponse's document.

.google.protobuf.FieldMask field_mask = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ProcessRequest.Builder

setInlineDocument(Document value)

public ProcessRequest.Builder setInlineDocument(Document value)

An inline document proto.

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
ProcessRequest.Builder

setInlineDocument(Document.Builder builderForValue)

public ProcessRequest.Builder setInlineDocument(Document.Builder builderForValue)

An inline document proto.

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

Parameter
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ProcessRequest.Builder

This builder for chaining.

setRawDocument(RawDocument value)

public ProcessRequest.Builder setRawDocument(RawDocument value)

A raw document content (bytes).

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

Parameter
NameDescription
valueRawDocument
Returns
TypeDescription
ProcessRequest.Builder

setRawDocument(RawDocument.Builder builderForValue)

public ProcessRequest.Builder setRawDocument(RawDocument.Builder builderForValue)

A raw document content (bytes).

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

Parameter
NameDescription
builderForValueRawDocument.Builder
Returns
TypeDescription
ProcessRequest.Builder

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

public ProcessRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ProcessRequest.Builder
Overrides

setSkipHumanReview(boolean value)

public ProcessRequest.Builder setSkipHumanReview(boolean value)

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

bool skip_human_review = 3;

Parameter
NameDescription
valueboolean

The skipHumanReview to set.

Returns
TypeDescription
ProcessRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ProcessRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ProcessRequest.Builder
Overrides