Class protos.google.cloud.documentai.v1.DocumentSchema (8.12.0)

Represents a DocumentSchema.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

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

Constructs a new DocumentSchema.

Parameter
Name Description
properties IDocumentSchema

Properties to set

Properties

description

public description: string;

DocumentSchema description.

displayName

public displayName: string;

DocumentSchema displayName.

entityTypes

public entityTypes: google.cloud.documentai.v1.DocumentSchema.IEntityType[];

DocumentSchema entityTypes.

metadata

public metadata?: (google.cloud.documentai.v1.DocumentSchema.IMetadata|null);

DocumentSchema metadata.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.IDocumentSchema): google.cloud.documentai.v1.DocumentSchema;

Creates a new DocumentSchema instance using the specified properties.

Parameter
Name Description
properties IDocumentSchema

Properties to set

Returns
Type Description
DocumentSchema

DocumentSchema instance

decode(reader, length)

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

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

DocumentSchema

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DocumentSchema

DocumentSchema

encode(message, writer)

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

Encodes the specified DocumentSchema message. Does not implicitly messages.

Parameters
Name Description
message IDocumentSchema

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

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

Parameters
Name Description
message IDocumentSchema

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

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

DocumentSchema

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DocumentSchema

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DocumentSchema

DocumentSchema

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