com.google.cloud.documentai.v1

Class ProcessRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

com.google.cloud.documentai.v1.ProcessRequest.Builder

All Implemented Interfaces:

ProcessRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ProcessRequest

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

 Request message for the process document method.
 

Protobuf type google.cloud.documentai.v1.ProcessRequest

Method Summary

Modifier and Type	Method and Description
ProcessRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ProcessRequest	build()
ProcessRequest	buildPartial()
ProcessRequest.Builder	clear()
ProcessRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ProcessRequest.Builder	clearFieldMask() Specifies which fields to include in ProcessResponse's document.
ProcessRequest.Builder	clearInlineDocument() An inline document proto.
ProcessRequest.Builder	clearName() Required.
ProcessRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ProcessRequest.Builder	clearRawDocument() A raw document content (bytes).
ProcessRequest.Builder	clearSkipHumanReview() Whether Human Review feature should be skipped for this request.
ProcessRequest.Builder	clearSource()
ProcessRequest.Builder	clone()
ProcessRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.FieldMask	getFieldMask() Specifies which fields to include in ProcessResponse's document.
com.google.protobuf.FieldMask.Builder	getFieldMaskBuilder() Specifies which fields to include in ProcessResponse's document.
com.google.protobuf.FieldMaskOrBuilder	getFieldMaskOrBuilder() Specifies which fields to include in ProcessResponse's document.
Document	getInlineDocument() An inline document proto.
Document.Builder	getInlineDocumentBuilder() An inline document proto.
DocumentOrBuilder	getInlineDocumentOrBuilder() An inline document proto.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
RawDocument	getRawDocument() A raw document content (bytes).
RawDocument.Builder	getRawDocumentBuilder() A raw document content (bytes).
RawDocumentOrBuilder	getRawDocumentOrBuilder() A raw document content (bytes).
boolean	getSkipHumanReview() Whether Human Review feature should be skipped for this request.
ProcessRequest.SourceCase	getSourceCase()
boolean	hasFieldMask() Specifies which fields to include in ProcessResponse's document.
boolean	hasInlineDocument() An inline document proto.
boolean	hasRawDocument() A raw document content (bytes).
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ProcessRequest.Builder	mergeFieldMask(com.google.protobuf.FieldMask value) Specifies which fields to include in ProcessResponse's document.
ProcessRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ProcessRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ProcessRequest.Builder	mergeFrom(ProcessRequest other)
ProcessRequest.Builder	mergeInlineDocument(Document value) An inline document proto.
ProcessRequest.Builder	mergeRawDocument(RawDocument value) A raw document content (bytes).
ProcessRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ProcessRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ProcessRequest.Builder	setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue) Specifies which fields to include in ProcessResponse's document.
ProcessRequest.Builder	setFieldMask(com.google.protobuf.FieldMask value) Specifies which fields to include in ProcessResponse's document.
ProcessRequest.Builder	setInlineDocument(Document.Builder builderForValue) An inline document proto.
ProcessRequest.Builder	setInlineDocument(Document value) An inline document proto.
ProcessRequest.Builder	setName(String value) Required.
ProcessRequest.Builder	setNameBytes(com.google.protobuf.ByteString value) Required.
ProcessRequest.Builder	setRawDocument(RawDocument.Builder builderForValue) A raw document content (bytes).
ProcessRequest.Builder	setRawDocument(RawDocument value) A raw document content (bytes).
ProcessRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ProcessRequest.Builder	setSkipHumanReview(boolean value) Whether Human Review feature should be skipped for this request.
ProcessRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

clear

public ProcessRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

getDefaultInstanceForType

public ProcessRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ProcessRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ProcessRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ProcessRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

setField

public ProcessRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

clearField

public ProcessRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

clearOneof

public ProcessRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

setRepeatedField

public ProcessRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

addRepeatedField

public ProcessRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

mergeFrom

public ProcessRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessRequest.Builder>

mergeFrom

public ProcessRequest.Builder mergeFrom(ProcessRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

mergeFrom

public ProcessRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessRequest.Builder>

Throws:

IOException

getSourceCase

public ProcessRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface ProcessRequestOrBuilder

clearSource

public ProcessRequest.Builder clearSource()

hasInlineDocument

public boolean hasInlineDocument()

 An inline document proto.
 

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

Specified by:

hasInlineDocument in interface ProcessRequestOrBuilder

Returns:

Whether the inlineDocument field is set.

getInlineDocument

public Document getInlineDocument()

 An inline document proto.
 

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

Specified by:

getInlineDocument in interface ProcessRequestOrBuilder

Returns:

The inlineDocument.

setInlineDocument

public ProcessRequest.Builder setInlineDocument(Document value)

 An inline document proto.
 

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

setInlineDocument

public ProcessRequest.Builder setInlineDocument(Document.Builder builderForValue)

 An inline document proto.
 

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

mergeInlineDocument

public ProcessRequest.Builder mergeInlineDocument(Document value)

 An inline document proto.
 

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

clearInlineDocument

public ProcessRequest.Builder clearInlineDocument()

 An inline document proto.
 

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

getInlineDocumentBuilder

public Document.Builder getInlineDocumentBuilder()

 An inline document proto.
 

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

getInlineDocumentOrBuilder

public DocumentOrBuilder getInlineDocumentOrBuilder()

 An inline document proto.
 

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

Specified by:

getInlineDocumentOrBuilder in interface ProcessRequestOrBuilder

hasRawDocument

public boolean hasRawDocument()

 A raw document content (bytes).
 

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

Specified by:

hasRawDocument in interface ProcessRequestOrBuilder

Returns:

Whether the rawDocument field is set.

getRawDocument

public RawDocument getRawDocument()

 A raw document content (bytes).
 

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

Specified by:

getRawDocument in interface ProcessRequestOrBuilder

Returns:

The rawDocument.

setRawDocument

public ProcessRequest.Builder setRawDocument(RawDocument value)

 A raw document content (bytes).
 

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

setRawDocument

public ProcessRequest.Builder setRawDocument(RawDocument.Builder builderForValue)

 A raw document content (bytes).
 

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

mergeRawDocument

public ProcessRequest.Builder mergeRawDocument(RawDocument value)

 A raw document content (bytes).
 

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

clearRawDocument

public ProcessRequest.Builder clearRawDocument()

 A raw document content (bytes).
 

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

getRawDocumentBuilder

public RawDocument.Builder getRawDocumentBuilder()

 A raw document content (bytes).
 

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

getRawDocumentOrBuilder

public RawDocumentOrBuilder getRawDocumentOrBuilder()

 A raw document content (bytes).
 

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

Specified by:

getRawDocumentOrBuilder in interface ProcessRequestOrBuilder

getName

public String getName()

 Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use
 its [default version][google.cloud.documentai.v1.Processor.default_processor_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) = { ... }

Specified by:

getName in interface ProcessRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use
 its [default version][google.cloud.documentai.v1.Processor.default_processor_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) = { ... }

Specified by:

getNameBytes in interface ProcessRequestOrBuilder

Returns:

The bytes for name.

setName

public ProcessRequest.Builder setName(String value)

 Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use
 its [default version][google.cloud.documentai.v1.Processor.default_processor_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) = { ... }

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public ProcessRequest.Builder clearName()

 Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use
 its [default version][google.cloud.documentai.v1.Processor.default_processor_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:

This builder for chaining.

setNameBytes

public ProcessRequest.Builder setNameBytes(com.google.protobuf.ByteString value)

 Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use
 its [default version][google.cloud.documentai.v1.Processor.default_processor_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) = { ... }

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getSkipHumanReview

public boolean getSkipHumanReview()

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

bool skip_human_review = 3;

Specified by:

getSkipHumanReview in interface ProcessRequestOrBuilder

Returns:

The skipHumanReview.

setSkipHumanReview

public ProcessRequest.Builder setSkipHumanReview(boolean value)

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

bool skip_human_review = 3;

Parameters:

value - The skipHumanReview to set.

Returns:

This builder for chaining.

clearSkipHumanReview

public ProcessRequest.Builder clearSkipHumanReview()

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

bool skip_human_review = 3;

Returns:

This builder for chaining.

hasFieldMask

public boolean hasFieldMask()

 Specifies which fields to include in ProcessResponse's document.
 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;

Specified by:

hasFieldMask in interface ProcessRequestOrBuilder

Returns:

Whether the fieldMask field is set.

getFieldMask

public com.google.protobuf.FieldMask getFieldMask()

 Specifies which fields to include in ProcessResponse's document.
 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;

Specified by:

getFieldMask in interface ProcessRequestOrBuilder

Returns:

The fieldMask.

setFieldMask

public ProcessRequest.Builder setFieldMask(com.google.protobuf.FieldMask value)

 Specifies which fields to include in ProcessResponse's document.
 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;

setFieldMask

public ProcessRequest.Builder setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue)

 Specifies which fields to include in ProcessResponse's document.
 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;

mergeFieldMask

public ProcessRequest.Builder mergeFieldMask(com.google.protobuf.FieldMask value)

 Specifies which fields to include in ProcessResponse's document.
 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;

clearFieldMask

public ProcessRequest.Builder clearFieldMask()

 Specifies which fields to include in ProcessResponse's document.
 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;

getFieldMaskBuilder

public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()

 Specifies which fields to include in ProcessResponse's document.
 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;

getFieldMaskOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()

 Specifies which fields to include in ProcessResponse's document.
 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;

Specified by:

getFieldMaskOrBuilder in interface ProcessRequestOrBuilder

setUnknownFields

public final ProcessRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

mergeUnknownFields

public final ProcessRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>