Class protos.google.cloud.documentai.v1.Document.Provenance (3.0.2)

Represents a Provenance.

Package

@google-cloud/documentai!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.Document.IProvenance);

Constructs a new Provenance.

Parameter

Name	Description
properties	`IProvenance` Properties to set

Properties

id

public id: number;

Provenance id.

Property Value

Type	Description
number

parents

public parents: google.cloud.documentai.v1.Document.Provenance.IParent[];

Provenance parents.

Property Value

Type	Description
google.cloud.documentai.v1.Document.Provenance.IParent[]

revision

public revision: number;

Provenance revision.

Property Value

Type	Description
number

type

public type: (google.cloud.documentai.v1.Document.Provenance.OperationType|keyof typeof google.cloud.documentai.v1.Document.Provenance.OperationType);

Provenance type.

Property Value

Type	Description
(google.cloud.documentai.v1.Document.Provenance.OperationType\|keyof typeof google.cloud.documentai.v1.Document.Provenance.OperationType)

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.Document.IProvenance): google.cloud.documentai.v1.Document.Provenance;

Creates a new Provenance instance using the specified properties.

Parameter

Name	Description
properties	`IProvenance` Properties to set

Returns

Type	Description
google.cloud.documentai.v1.Document.Provenance	Provenance instance

decode(reader, length)

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

Decodes a Provenance message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.documentai.v1.Document.Provenance	Provenance

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.Document.Provenance;

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.documentai.v1.Document.Provenance	Provenance

encode(message, writer)

public static encode(message: google.cloud.documentai.v1.Document.IProvenance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Provenance message. Does not implicitly messages.

Parameters

Name	Description
message	`IProvenance` Provenance 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.v1.Document.IProvenance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IProvenance` Provenance 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.v1.Document.Provenance;

Creates a Provenance 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
google.cloud.documentai.v1.Document.Provenance	Provenance

toJSON()

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

Converts this Provenance to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.documentai.v1.Document.Provenance` Provenance
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 Provenance 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