public final class ProcessRequest extends GeneratedMessageV3 implements ProcessRequestOrBuilder
Request message for the
ProcessDocument
method.
Protobuf type google.cloud.documentai.v1beta3.ProcessRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FIELD_MASK_FIELD_NUMBER
public static final int FIELD_MASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GCS_DOCUMENT_FIELD_NUMBER
public static final int GCS_DOCUMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IMAGELESS_MODE_FIELD_NUMBER
public static final int IMAGELESS_MODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INLINE_DOCUMENT_FIELD_NUMBER
public static final int INLINE_DOCUMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROCESS_OPTIONS_FIELD_NUMBER
public static final int PROCESS_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RAW_DOCUMENT_FIELD_NUMBER
public static final int RAW_DOCUMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SKIP_HUMAN_REVIEW_FIELD_NUMBER
public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ProcessRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ProcessRequest.Builder newBuilder()
newBuilder(ProcessRequest prototype)
public static ProcessRequest.Builder newBuilder(ProcessRequest prototype)
public static ProcessRequest parseDelimitedFrom(InputStream input)
public static ProcessRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ProcessRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ProcessRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(CodedInputStream input)
public static ProcessRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(InputStream input)
public static ProcessRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ProcessRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ProcessRequest> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ProcessRequest getDefaultInstanceForType()
getDocument() (deprecated)
public Document getDocument()
Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
The document payload, the
content and
mime_type fields must
be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
| Returns |
| Type |
Description |
Document |
The document.
|
getDocumentOrBuilder() (deprecated)
public DocumentOrBuilder getDocumentOrBuilder()
The document payload, the
content and
mime_type fields must
be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
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.
|
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;
getGcsDocument()
public GcsDocument getGcsDocument()
A raw document on Google Cloud Storage.
.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;
getGcsDocumentOrBuilder()
public GcsDocumentOrBuilder getGcsDocumentOrBuilder()
A raw document on Google Cloud Storage.
.google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;
getImagelessMode()
public boolean getImagelessMode()
Optional. Option to remove images from the document.
bool imageless_mode = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The imagelessMode.
|
getInlineDocument()
public Document getInlineDocument()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;
| Returns |
| Type |
Description |
Document |
The inlineDocument.
|
getInlineDocumentOrBuilder()
public DocumentOrBuilder getInlineDocumentOrBuilder()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;
getLabels() (deprecated)
public Map<String,String> getLabels()
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];
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];
| 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 |
|
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.
|
getParserForType()
public Parser<ProcessRequest> getParserForType()
Overrides
getProcessOptions()
public ProcessOptions getProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
getProcessOptionsOrBuilder()
public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
getRawDocument()
public RawDocument getRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
getRawDocumentOrBuilder()
public RawDocumentOrBuilder getRawDocumentOrBuilder()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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()
hasDocument() (deprecated)
public boolean hasDocument()
Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
The document payload, the
content and
mime_type fields must
be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
| Returns |
| Type |
Description |
boolean |
Whether the document field is set.
|
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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.RawDocument raw_document = 5;
| Returns |
| Type |
Description |
boolean |
Whether the rawDocument field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ProcessRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProcessRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ProcessRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
