Constructor
new ProcessRequest(propertiesopt)
Constructs a new ProcessRequest.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.documentai.v1beta3.IProcessRequest |
<optional> |
Properties to set |
- Implements:
-
- IProcessRequest
Members
document
ProcessRequest document.
fieldMask
ProcessRequest fieldMask.
gcsDocument
ProcessRequest gcsDocument.
imagelessMode
ProcessRequest imagelessMode.
inlineDocument
ProcessRequest inlineDocument.
labels
ProcessRequest labels.
name
ProcessRequest name.
processOptions
ProcessRequest processOptions.
rawDocument
ProcessRequest rawDocument.
skipHumanReview
ProcessRequest skipHumanReview.
source
ProcessRequest source.
Methods
toJSON() → {Object.<string, *>}
Converts this ProcessRequest to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.documentai.v1beta3.ProcessRequest}
Creates a new ProcessRequest instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.documentai.v1beta3.IProcessRequest |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.documentai.v1beta3.ProcessRequest |
ProcessRequest instance |
(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta3.ProcessRequest}
Decodes a ProcessRequest message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.documentai.v1beta3.ProcessRequest |
ProcessRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.documentai.v1beta3.ProcessRequest}
Decodes a ProcessRequest message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.documentai.v1beta3.ProcessRequest |
ProcessRequest |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified ProcessRequest message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.documentai.v1beta3.IProcessRequest |
ProcessRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified ProcessRequest message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.documentai.v1beta3.IProcessRequest |
ProcessRequest message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.documentai.v1beta3.ProcessRequest}
Creates a ProcessRequest message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.documentai.v1beta3.ProcessRequest |
ProcessRequest |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ProcessRequest
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a ProcessRequest message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.documentai.v1beta3.ProcessRequest |
ProcessRequest |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a ProcessRequest message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|