Represents a BatchProcessMetadata.
Package
@google-cloud/documentai!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1beta3.IBatchProcessMetadata);
Constructs a new BatchProcessMetadata.
Name | Description |
properties |
IBatchProcessMetadata
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);
BatchProcessMetadata createTime.
Type | Description |
(google.protobuf.ITimestamp|null) |
individualProcessStatuses
public individualProcessStatuses: google.cloud.documentai.v1beta3.BatchProcessMetadata.IIndividualProcessStatus[];
BatchProcessMetadata individualProcessStatuses.
Type | Description |
google.cloud.documentai.v1beta3.BatchProcessMetadata.IIndividualProcessStatus[] |
state
public state: (google.cloud.documentai.v1beta3.BatchProcessMetadata.State|keyof typeof google.cloud.documentai.v1beta3.BatchProcessMetadata.State);
BatchProcessMetadata state.
Type | Description |
(google.cloud.documentai.v1beta3.BatchProcessMetadata.State|keyof typeof google.cloud.documentai.v1beta3.BatchProcessMetadata.State) |
stateMessage
public stateMessage: string;
BatchProcessMetadata stateMessage.
Type | Description |
string |
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
BatchProcessMetadata updateTime.
Type | Description |
(google.protobuf.ITimestamp|null) |
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1beta3.IBatchProcessMetadata): google.cloud.documentai.v1beta3.BatchProcessMetadata;
Creates a new BatchProcessMetadata instance using the specified properties.
Name | Description |
properties |
IBatchProcessMetadata
Properties to set |
Type | Description |
google.cloud.documentai.v1beta3.BatchProcessMetadata | BatchProcessMetadata instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.BatchProcessMetadata;
Decodes a BatchProcessMetadata message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.documentai.v1beta3.BatchProcessMetadata | BatchProcessMetadata |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.BatchProcessMetadata;
Decodes a BatchProcessMetadata message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.documentai.v1beta3.BatchProcessMetadata | BatchProcessMetadata |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1beta3.IBatchProcessMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified BatchProcessMetadata message. Does not implicitly messages.
Name | Description |
message |
IBatchProcessMetadata
BatchProcessMetadata message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.documentai.v1beta3.IBatchProcessMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified BatchProcessMetadata message, length delimited. Does not implicitly messages.
Name | Description |
message |
IBatchProcessMetadata
BatchProcessMetadata message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1beta3.BatchProcessMetadata;
Creates a BatchProcessMetadata message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.documentai.v1beta3.BatchProcessMetadata | BatchProcessMetadata |
toJSON()
public toJSON(): { [k: string]: any };
Converts this BatchProcessMetadata to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.documentai.v1beta3.BatchProcessMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a BatchProcessMetadata message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.documentai.v1beta3.BatchProcessMetadata
BatchProcessMetadata |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a BatchProcessMetadata message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|