- 2.52.0 (latest)
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
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.v1.ProcessRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProcessRequest.BuilderImplements
ProcessRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ProcessRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
build()
public ProcessRequest build()
Returns | |
---|---|
Type | Description |
ProcessRequest |
buildPartial()
public ProcessRequest buildPartial()
Returns | |
---|---|
Type | Description |
ProcessRequest |
clear()
public ProcessRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ProcessRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
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;
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
clearInlineDocument()
public ProcessRequest.Builder clearInlineDocument()
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ProcessRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ProcessRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
clearRawDocument()
public ProcessRequest.Builder clearRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ProcessRequest.Builder | This builder for chaining. |
clearSource()
public ProcessRequest.Builder clearSource()
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
clone()
public ProcessRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
getDefaultInstanceForType()
public ProcessRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ProcessRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFieldMask()
public 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;
Returns | |
---|---|
Type | Description |
FieldMask | The fieldMask. |
getFieldMaskBuilder()
public 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;
Returns | |
---|---|
Type | Description |
Builder |
getFieldMaskOrBuilder()
public 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;
Returns | |
---|---|
Type | Description |
FieldMaskOrBuilder |
getInlineDocument()
public Document getInlineDocument()
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Returns | |
---|---|
Type | Description |
Document | The inlineDocument. |
getInlineDocumentBuilder()
public Document.Builder getInlineDocumentBuilder()
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Returns | |
---|---|
Type | Description |
Document.Builder |
getInlineDocumentOrBuilder()
public DocumentOrBuilder getInlineDocumentOrBuilder()
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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. |
getRawDocument()
public RawDocument getRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Returns | |
---|---|
Type | Description |
RawDocument | The rawDocument. |
getRawDocumentBuilder()
public RawDocument.Builder getRawDocumentBuilder()
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Returns | |
---|---|
Type | Description |
RawDocument.Builder |
getRawDocumentOrBuilder()
public RawDocumentOrBuilder getRawDocumentOrBuilder()
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Returns | |
---|---|
Type | Description |
RawDocumentOrBuilder |
getSkipHumanReview()
public boolean getSkipHumanReview()
Whether Human Review feature 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()
Returns | |
---|---|
Type | Description |
ProcessRequest.SourceCase |
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;
Returns | |
---|---|
Type | Description |
boolean | Whether the fieldMask field is set. |
hasInlineDocument()
public boolean hasInlineDocument()
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Returns | |
---|---|
Type | Description |
boolean | Whether the inlineDocument field is set. |
hasRawDocument()
public boolean hasRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Returns | |
---|---|
Type | Description |
boolean | Whether the rawDocument field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFieldMask(FieldMask value)
public ProcessRequest.Builder mergeFieldMask(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;
Parameter | |
---|---|
Name | Description |
value | FieldMask |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
mergeFrom(ProcessRequest other)
public ProcessRequest.Builder mergeFrom(ProcessRequest other)
Parameter | |
---|---|
Name | Description |
other | ProcessRequest |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ProcessRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ProcessRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
mergeInlineDocument(Document value)
public ProcessRequest.Builder mergeInlineDocument(Document value)
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Parameter | |
---|---|
Name | Description |
value | Document |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
mergeRawDocument(RawDocument value)
public ProcessRequest.Builder mergeRawDocument(RawDocument value)
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Parameter | |
---|---|
Name | Description |
value | RawDocument |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ProcessRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ProcessRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
setFieldMask(FieldMask value)
public ProcessRequest.Builder setFieldMask(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;
Parameter | |
---|---|
Name | Description |
value | FieldMask |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
setFieldMask(FieldMask.Builder builderForValue)
public ProcessRequest.Builder setFieldMask(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;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
setInlineDocument(Document value)
public ProcessRequest.Builder setInlineDocument(Document value)
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Parameter | |
---|---|
Name | Description |
value | Document |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
setInlineDocument(Document.Builder builderForValue)
public ProcessRequest.Builder setInlineDocument(Document.Builder builderForValue)
An inline document proto.
.google.cloud.documentai.v1.Document inline_document = 4;
Parameter | |
---|---|
Name | Description |
builderForValue | Document.Builder |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder | This builder for chaining. |
setRawDocument(RawDocument value)
public ProcessRequest.Builder setRawDocument(RawDocument value)
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Parameter | |
---|---|
Name | Description |
value | RawDocument |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
setRawDocument(RawDocument.Builder builderForValue)
public ProcessRequest.Builder setRawDocument(RawDocument.Builder builderForValue)
A raw document content (bytes).
.google.cloud.documentai.v1.RawDocument raw_document = 5;
Parameter | |
---|---|
Name | Description |
builderForValue | RawDocument.Builder |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ProcessRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |
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 | |
---|---|
Name | Description |
value | boolean The skipHumanReview to set. |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ProcessRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ProcessRequest.Builder |