Class protos.google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus (8.12.0)

Represents an IndividualProcessStatus.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta3.BatchProcessMetadata.IIndividualProcessStatus);

Constructs a new IndividualProcessStatus.

Parameter
Name Description
properties IIndividualProcessStatus

Properties to set

Properties

humanReviewOperation

public humanReviewOperation: string;

IndividualProcessStatus humanReviewOperation.

humanReviewStatus

public humanReviewStatus?: (google.cloud.documentai.v1beta3.IHumanReviewStatus|null);

IndividualProcessStatus humanReviewStatus.

inputGcsSource

public inputGcsSource: string;

IndividualProcessStatus inputGcsSource.

outputGcsDestination

public outputGcsDestination: string;

IndividualProcessStatus outputGcsDestination.

status

public status?: (google.rpc.IStatus|null);

IndividualProcessStatus status.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.BatchProcessMetadata.IIndividualProcessStatus): google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus;

Creates a new IndividualProcessStatus instance using the specified properties.

Parameter
Name Description
properties IIndividualProcessStatus

Properties to set

Returns
Type Description
IndividualProcessStatus

IndividualProcessStatus instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus;

Decodes an IndividualProcessStatus message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
IndividualProcessStatus

IndividualProcessStatus

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus;

Decodes an IndividualProcessStatus message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
IndividualProcessStatus

IndividualProcessStatus

encode(message, writer)

public static encode(message: google.cloud.documentai.v1beta3.BatchProcessMetadata.IIndividualProcessStatus, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified IndividualProcessStatus message. Does not implicitly messages.

Parameters
Name Description
message IIndividualProcessStatus

IndividualProcessStatus message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.documentai.v1beta3.BatchProcessMetadata.IIndividualProcessStatus, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified IndividualProcessStatus message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IIndividualProcessStatus

IndividualProcessStatus message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus;

Creates an IndividualProcessStatus message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
IndividualProcessStatus

IndividualProcessStatus

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for IndividualProcessStatus

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this IndividualProcessStatus to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an IndividualProcessStatus message. Also converts values to other types if specified.

Parameters
Name Description
message IndividualProcessStatus

IndividualProcessStatus

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an IndividualProcessStatus message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not