com.google.cloud.documentai.v1

Class ProcessRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1.ProcessRequest

All Implemented Interfaces:

ProcessRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ProcessRequest
extends com.google.protobuf.GeneratedMessageV3
implements ProcessRequestOrBuilder

 Request message for the process document method.
 

Protobuf type google.cloud.documentai.v1.ProcessRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessRequest.Builder Request message for the process document method.
static class	ProcessRequest.SourceCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_MASK_FIELD_NUMBER
static int	INLINE_DOCUMENT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	RAW_DOCUMENT_FIELD_NUMBER
static int	SKIP_HUMAN_REVIEW_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ProcessRequest	getDefaultInstance()
ProcessRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.FieldMask	getFieldMask() 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.
DocumentOrBuilder	getInlineDocumentOrBuilder() An inline document proto.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<ProcessRequest>	getParserForType()
RawDocument	getRawDocument() A raw document content (bytes).
RawDocumentOrBuilder	getRawDocumentOrBuilder() A raw document content (bytes).
int	getSerializedSize()
boolean	getSkipHumanReview() Whether Human Review feature should be skipped for this request.
ProcessRequest.SourceCase	getSourceCase()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasFieldMask() Specifies which fields to include in ProcessResponse's document.
int	hashCode()
boolean	hasInlineDocument() An inline document proto.
boolean	hasRawDocument() A raw document content (bytes).
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ProcessRequest.Builder	newBuilder()
static ProcessRequest.Builder	newBuilder(ProcessRequest prototype)
ProcessRequest.Builder	newBuilderForType()
protected ProcessRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ProcessRequest	parseDelimitedFrom(InputStream input)
static ProcessRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessRequest	parseFrom(byte[] data)
static ProcessRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessRequest	parseFrom(ByteBuffer data)
static ProcessRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessRequest	parseFrom(com.google.protobuf.ByteString data)
static ProcessRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ProcessRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProcessRequest	parseFrom(InputStream input)
static ProcessRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ProcessRequest>	parser()
ProcessRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INLINE_DOCUMENT_FIELD_NUMBER

public static final int INLINE_DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

RAW_DOCUMENT_FIELD_NUMBER

public static final int RAW_DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

SKIP_HUMAN_REVIEW_FIELD_NUMBER

public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER

See Also:

Constant Field Values

FIELD_MASK_FIELD_NUMBER

public static final int FIELD_MASK_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getSourceCase

public ProcessRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface ProcessRequestOrBuilder

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.

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.

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.

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.

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ProcessRequest parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProcessRequest parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProcessRequest parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProcessRequest parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProcessRequest parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProcessRequest parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProcessRequest parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ProcessRequest parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ProcessRequest parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ProcessRequest parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static ProcessRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ProcessRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public ProcessRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ProcessRequest.Builder newBuilder()

newBuilder

public static ProcessRequest.Builder newBuilder(ProcessRequest prototype)

toBuilder

public ProcessRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ProcessRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ProcessRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ProcessRequest> parser()

getParserForType

public com.google.protobuf.Parser<ProcessRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ProcessRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder