Class protos.google.cloud.documentai.v1.ProcessorVersion (6.0.0)

Stay organized with collections Save and categorize content based on your preferences.

Represents a ProcessorVersion.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

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

Constructs a new ProcessorVersion.

Parameter
NameDescription
properties IProcessorVersion

Properties to set

Properties

createTime

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

ProcessorVersion createTime.

deprecationInfo

public deprecationInfo?: (google.cloud.documentai.v1.ProcessorVersion.IDeprecationInfo|null);

ProcessorVersion deprecationInfo.

displayName

public displayName: string;

ProcessorVersion displayName.

googleManaged

public googleManaged: boolean;

ProcessorVersion googleManaged.

kmsKeyName

public kmsKeyName: string;

ProcessorVersion kmsKeyName.

kmsKeyVersionName

public kmsKeyVersionName: string;

ProcessorVersion kmsKeyVersionName.

name

public name: string;

ProcessorVersion name.

state

public state: (google.cloud.documentai.v1.ProcessorVersion.State|keyof typeof google.cloud.documentai.v1.ProcessorVersion.State);

ProcessorVersion state.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.IProcessorVersion): google.cloud.documentai.v1.ProcessorVersion;

Creates a new ProcessorVersion instance using the specified properties.

Parameter
NameDescription
properties IProcessorVersion

Properties to set

Returns
TypeDescription
google.cloud.documentai.v1.ProcessorVersion

ProcessorVersion instance

decode(reader, length)

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

Decodes a ProcessorVersion 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.cloud.documentai.v1.ProcessorVersion

ProcessorVersion

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.documentai.v1.ProcessorVersion

ProcessorVersion

encode(message, writer)

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

Encodes the specified ProcessorVersion message. Does not implicitly messages.

Parameters
NameDescription
message IProcessorVersion

ProcessorVersion 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.cloud.documentai.v1.IProcessorVersion, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IProcessorVersion

ProcessorVersion 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.cloud.documentai.v1.ProcessorVersion;

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

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

Plain object

Returns
TypeDescription
google.cloud.documentai.v1.ProcessorVersion

ProcessorVersion

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ProcessorVersion

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this ProcessorVersion to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.documentai.v1.ProcessorVersion

ProcessorVersion

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