Class protos.google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatus (8.12.0)

Represents an IndividualImportStatus.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IIndividualImportStatus);

Constructs a new IndividualImportStatus.

Parameter
Name Description
properties IIndividualImportStatus

Properties to set

Properties

inputGcsSource

public inputGcsSource: string;

IndividualImportStatus inputGcsSource.

outputDocumentId

public outputDocumentId?: (google.cloud.documentai.v1beta3.IDocumentId|null);

IndividualImportStatus outputDocumentId.

status

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

IndividualImportStatus status.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IIndividualImportStatus): google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IndividualImportStatus;

Creates a new IndividualImportStatus instance using the specified properties.

Parameter
Name Description
properties IIndividualImportStatus

Properties to set

Returns
Type Description
IndividualImportStatus

IndividualImportStatus instance

decode(reader, length)

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

Decodes an IndividualImportStatus 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
IndividualImportStatus

IndividualImportStatus

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
IndividualImportStatus

IndividualImportStatus

encode(message, writer)

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

Encodes the specified IndividualImportStatus message. Does not implicitly messages.

Parameters
Name Description
message IIndividualImportStatus

IndividualImportStatus 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.ImportDocumentsMetadata.IIndividualImportStatus, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IIndividualImportStatus

IndividualImportStatus 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.ImportDocumentsMetadata.IndividualImportStatus;

Creates an IndividualImportStatus 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
IndividualImportStatus

IndividualImportStatus

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for IndividualImportStatus

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 IndividualImportStatus to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message IndividualImportStatus

IndividualImportStatus

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 IndividualImportStatus 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