public final class ProcessRequest extends com.google.protobuf.GeneratedMessageV3 implements ProcessRequestOrBuilder
Request message for the [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] method.Protobuf type
google.cloud.documentai.v1beta3.ProcessRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ProcessRequest.Builder
Request message for the
[ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument]
method.
|
static class |
ProcessRequest.SourceCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DOCUMENT_FIELD_NUMBER |
static int |
FIELD_MASK_FIELD_NUMBER |
static int |
GCS_DOCUMENT_FIELD_NUMBER |
static int |
IMAGELESS_MODE_FIELD_NUMBER |
static int |
INLINE_DOCUMENT_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PROCESS_OPTIONS_FIELD_NUMBER |
static int |
RAW_DOCUMENT_FIELD_NUMBER |
static int |
SKIP_HUMAN_REVIEW_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Optional.
|
boolean |
equals(Object obj) |
static ProcessRequest |
getDefaultInstance() |
ProcessRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Document |
getDocument()
Deprecated.
google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
|
DocumentOrBuilder |
getDocumentOrBuilder()
Deprecated.
|
com.google.protobuf.FieldMask |
getFieldMask()
Specifies which fields to include in the
[ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document]
output.
|
com.google.protobuf.FieldMaskOrBuilder |
getFieldMaskOrBuilder()
Specifies which fields to include in the
[ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document]
output.
|
GcsDocument |
getGcsDocument()
A raw document on Google Cloud Storage.
|
GcsDocumentOrBuilder |
getGcsDocumentOrBuilder()
A raw document on Google Cloud Storage.
|
boolean |
getImagelessMode()
Optional.
|
Document |
getInlineDocument()
An inline document proto.
|
DocumentOrBuilder |
getInlineDocumentOrBuilder()
An inline document proto.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Optional.
|
Map<String,String> |
getLabelsMap()
Optional.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getLabelsOrThrow(String key)
Optional.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
com.google.protobuf.Parser<ProcessRequest> |
getParserForType() |
ProcessOptions |
getProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7; |
ProcessOptionsOrBuilder |
getProcessOptionsOrBuilder()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7; |
RawDocument |
getRawDocument()
A raw document content (bytes).
|
RawDocumentOrBuilder |
getRawDocumentOrBuilder()
A raw document content (bytes).
|
int |
getSerializedSize() |
boolean |
getSkipHumanReview()
Whether human review should be skipped for this request.
|
ProcessRequest.SourceCase |
getSourceCase() |
boolean |
hasDocument()
Deprecated.
google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
|
boolean |
hasFieldMask()
Specifies which fields to include in the
[ProcessResponse.document][google.cloud.documentai.v1beta3.ProcessResponse.document]
output.
|
boolean |
hasGcsDocument()
A raw document on Google Cloud Storage.
|
int |
hashCode() |
boolean |
hasInlineDocument()
An inline document proto.
|
boolean |
hasProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7; |
boolean |
hasRawDocument()
A raw document content (bytes).
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
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) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int INLINE_DOCUMENT_FIELD_NUMBER
public static final int RAW_DOCUMENT_FIELD_NUMBER
public static final int GCS_DOCUMENT_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
public static final int FIELD_MASK_FIELD_NUMBER
public static final int PROCESS_OPTIONS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int IMAGELESS_MODE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public ProcessRequest.SourceCase getSourceCase()
getSourceCase in interface ProcessRequestOrBuilderpublic boolean hasInlineDocument()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;hasInlineDocument in interface ProcessRequestOrBuilderpublic Document getInlineDocument()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;getInlineDocument in interface ProcessRequestOrBuilderpublic DocumentOrBuilder getInlineDocumentOrBuilder()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;getInlineDocumentOrBuilder in interface ProcessRequestOrBuilderpublic boolean hasRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;hasRawDocument in interface ProcessRequestOrBuilderpublic RawDocument getRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;getRawDocument in interface ProcessRequestOrBuilderpublic RawDocumentOrBuilder getRawDocumentOrBuilder()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;getRawDocumentOrBuilder in interface ProcessRequestOrBuilderpublic boolean hasGcsDocument()
A raw document on Google Cloud Storage.
.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;hasGcsDocument in interface ProcessRequestOrBuilderpublic GcsDocument getGcsDocument()
A raw document on Google Cloud Storage.
.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;getGcsDocument in interface ProcessRequestOrBuilderpublic GcsDocumentOrBuilder getGcsDocumentOrBuilder()
A raw document on Google Cloud Storage.
.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;getGcsDocumentOrBuilder in interface ProcessRequestOrBuilderpublic String getName()
Required. The resource name of the
[Processor][google.cloud.documentai.v1beta3.Processor] or
[ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
to use for processing. If a
[Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
server will use its [default
version][google.cloud.documentai.v1beta3.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) = { ... }
getName in interface ProcessRequestOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Required. The resource name of the
[Processor][google.cloud.documentai.v1beta3.Processor] or
[ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
to use for processing. If a
[Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
server will use its [default
version][google.cloud.documentai.v1beta3.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) = { ... }
getNameBytes in interface ProcessRequestOrBuilder@Deprecated public boolean hasDocument()
The document payload, the [content][google.cloud.documentai.v1beta3.Document.content] and [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];hasDocument in interface ProcessRequestOrBuilder@Deprecated public Document getDocument()
The document payload, the [content][google.cloud.documentai.v1beta3.Document.content] and [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];getDocument in interface ProcessRequestOrBuilder@Deprecated public DocumentOrBuilder getDocumentOrBuilder()
The document payload, the [content][google.cloud.documentai.v1beta3.Document.content] and [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];getDocumentOrBuilder in interface ProcessRequestOrBuilderpublic boolean getSkipHumanReview()
Whether human review should be skipped for this request. Default to `false`.
bool skip_human_review = 3;getSkipHumanReview in interface ProcessRequestOrBuilderpublic boolean hasFieldMask()
Specifies which fields to include in the
[ProcessResponse.document][google.cloud.documentai.v1beta3.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;hasFieldMask in interface ProcessRequestOrBuilderpublic com.google.protobuf.FieldMask getFieldMask()
Specifies which fields to include in the
[ProcessResponse.document][google.cloud.documentai.v1beta3.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;getFieldMask in interface ProcessRequestOrBuilderpublic com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
Specifies which fields to include in the
[ProcessResponse.document][google.cloud.documentai.v1beta3.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;getFieldMaskOrBuilder in interface ProcessRequestOrBuilderpublic boolean hasProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;hasProcessOptions in interface ProcessRequestOrBuilderpublic ProcessOptions getProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;getProcessOptions in interface ProcessRequestOrBuilderpublic ProcessOptionsOrBuilder getProcessOptionsOrBuilder()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;getProcessOptionsOrBuilder in interface ProcessRequestOrBuilderpublic int getLabelsCount()
ProcessRequestOrBuilderOptional. 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];getLabelsCount in interface ProcessRequestOrBuilderpublic 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];containsLabels in interface ProcessRequestOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface ProcessRequestOrBuilderpublic 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];getLabelsMap in interface ProcessRequestOrBuilderpublic 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];getLabelsOrDefault in interface ProcessRequestOrBuilderpublic 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];getLabelsOrThrow in interface ProcessRequestOrBuilderpublic boolean getImagelessMode()
Optional. Option to remove images from the document.
bool imageless_mode = 11 [(.google.api.field_behavior) = OPTIONAL];getImagelessMode in interface ProcessRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ProcessRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ProcessRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ProcessRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ProcessRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ProcessRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ProcessRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ProcessRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ProcessRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ProcessRequest.Builder newBuilder()
public static ProcessRequest.Builder newBuilder(ProcessRequest prototype)
public ProcessRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ProcessRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ProcessRequest getDefaultInstance()
public static com.google.protobuf.Parser<ProcessRequest> parser()
public com.google.protobuf.Parser<ProcessRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ProcessRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.