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

Represents a BatchDatasetDocuments.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

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

Constructs a new BatchDatasetDocuments.

Parameter
Name Description
properties IBatchDatasetDocuments

Properties to set

Properties

criteria

public criteria?: ("individualDocumentIds"|"filter");

BatchDatasetDocuments criteria.

filter

public filter?: (string|null);

BatchDatasetDocuments filter.

individualDocumentIds

public individualDocumentIds?: (google.cloud.documentai.v1beta3.BatchDatasetDocuments.IIndividualDocumentIds|null);

BatchDatasetDocuments individualDocumentIds.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.IBatchDatasetDocuments): google.cloud.documentai.v1beta3.BatchDatasetDocuments;

Creates a new BatchDatasetDocuments instance using the specified properties.

Parameter
Name Description
properties IBatchDatasetDocuments

Properties to set

Returns
Type Description
BatchDatasetDocuments

BatchDatasetDocuments instance

decode(reader, length)

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

Decodes a BatchDatasetDocuments 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
BatchDatasetDocuments

BatchDatasetDocuments

decodeDelimited(reader)

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

Decodes a BatchDatasetDocuments message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BatchDatasetDocuments

BatchDatasetDocuments

encode(message, writer)

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

Encodes the specified BatchDatasetDocuments message. Does not implicitly messages.

Parameters
Name Description
message IBatchDatasetDocuments

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

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

Parameters
Name Description
message IBatchDatasetDocuments

BatchDatasetDocuments 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.BatchDatasetDocuments;

Creates a BatchDatasetDocuments 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
BatchDatasetDocuments

BatchDatasetDocuments

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BatchDatasetDocuments

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BatchDatasetDocuments

BatchDatasetDocuments

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 a BatchDatasetDocuments 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