Class protos.google.cloud.documentai.v1beta3.Processor (3.3.0)

Represents a Processor.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

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

Constructs a new Processor.

Parameter
Name Description
properties IProcessor

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Processor createTime.

defaultProcessorVersion

public defaultProcessorVersion: string;

Processor defaultProcessorVersion.

displayName

public displayName: string;

Processor displayName.

kmsKeyName

public kmsKeyName: string;

Processor kmsKeyName.

name

public name: string;

Processor name.

processEndpoint

public processEndpoint: string;

Processor processEndpoint.

state

public state: (google.cloud.documentai.v1beta3.Processor.State|keyof typeof google.cloud.documentai.v1beta3.Processor.State);

Processor state.

type

public type: string;

Processor type.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.IProcessor): google.cloud.documentai.v1beta3.Processor;

Creates a new Processor instance using the specified properties.

Parameter
Name Description
properties IProcessor

Properties to set
Returns
Type Description
google.cloud.documentai.v1beta3.Processor

Processor instance

decode(reader, length)

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

Decodes a Processor 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.v1beta3.Processor

Processor

decodeDelimited(reader)

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

Decodes a Processor 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.v1beta3.Processor

Processor

encode(message, writer)

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

Encodes the specified Processor message. Does not implicitly messages.

Parameters
Name Description
message IProcessor

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

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

Parameters
Name Description
message IProcessor

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

Creates a Processor 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.v1beta3.Processor

Processor

toJSON()

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

Converts this Processor to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.documentai.v1beta3.Processor

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