Class protos.google.api.ResourceDescriptor (3.3.0)

Represents a ResourceDescriptor.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.api.IResourceDescriptor);

Constructs a new ResourceDescriptor.

Parameter
NameDescription
properties IResourceDescriptor

Properties to set

Properties

history

public history: (google.api.ResourceDescriptor.History|keyof typeof google.api.ResourceDescriptor.History);

ResourceDescriptor history.

nameField

public nameField: string;

ResourceDescriptor nameField.

pattern

public pattern: string[];

ResourceDescriptor pattern.

plural

public plural: string;

ResourceDescriptor plural.

singular

public singular: string;

ResourceDescriptor singular.

style

public style: google.api.ResourceDescriptor.Style[];

ResourceDescriptor style.

type

public type: string;

ResourceDescriptor type.

Methods

create(properties)

public static create(properties?: google.api.IResourceDescriptor): google.api.ResourceDescriptor;

Creates a new ResourceDescriptor instance using the specified properties.

Parameter
NameDescription
properties IResourceDescriptor

Properties to set

Returns
TypeDescription
google.api.ResourceDescriptor

ResourceDescriptor instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.ResourceDescriptor;

Decodes a ResourceDescriptor message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.api.ResourceDescriptor

ResourceDescriptor

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.ResourceDescriptor;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.api.ResourceDescriptor

ResourceDescriptor

encode(message, writer)

public static encode(message: google.api.IResourceDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ResourceDescriptor message. Does not implicitly messages.

Parameters
NameDescription
message IResourceDescriptor

ResourceDescriptor message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.api.IResourceDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IResourceDescriptor

ResourceDescriptor message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.api.ResourceDescriptor;

Creates a ResourceDescriptor message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.api.ResourceDescriptor

ResourceDescriptor

toJSON()

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

Converts this ResourceDescriptor to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.api.ResourceDescriptor, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.api.ResourceDescriptor

ResourceDescriptor

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ResourceDescriptor message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not