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

Represents an ImportDocumentsMetadata.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

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

Constructs a new ImportDocumentsMetadata.

Parameter
Name Description
properties IImportDocumentsMetadata

Properties to set

Properties

commonMetadata

public commonMetadata?: (google.cloud.documentai.v1beta3.ICommonOperationMetadata|null);

ImportDocumentsMetadata commonMetadata.

importConfigValidationResults

public importConfigValidationResults: google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IImportConfigValidationResult[];

ImportDocumentsMetadata importConfigValidationResults.

individualImportStatuses

public individualImportStatuses: google.cloud.documentai.v1beta3.ImportDocumentsMetadata.IIndividualImportStatus[];

ImportDocumentsMetadata individualImportStatuses.

totalDocumentCount

public totalDocumentCount: number;

ImportDocumentsMetadata totalDocumentCount.

Methods

create(properties)

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

Creates a new ImportDocumentsMetadata instance using the specified properties.

Parameter
Name Description
properties IImportDocumentsMetadata

Properties to set

Returns
Type Description
ImportDocumentsMetadata

ImportDocumentsMetadata instance

decode(reader, length)

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

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

ImportDocumentsMetadata

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ImportDocumentsMetadata

ImportDocumentsMetadata

encode(message, writer)

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

Encodes the specified ImportDocumentsMetadata message. Does not implicitly messages.

Parameters
Name Description
message IImportDocumentsMetadata

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

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

Parameters
Name Description
message IImportDocumentsMetadata

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

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

ImportDocumentsMetadata

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ImportDocumentsMetadata

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ImportDocumentsMetadata

ImportDocumentsMetadata

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