Class protos.google.cloud.speech.v2.Recognizer (5.1.0)

Represents a Recognizer.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.speech.v2.IRecognizer);

Constructs a new Recognizer.

Parameter

Name	Description
properties	`IRecognizer` Properties to set

Properties

annotations

public annotations: { [k: string]: string };

Recognizer annotations.

createTime

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

Recognizer createTime.

defaultRecognitionConfig

public defaultRecognitionConfig?: (google.cloud.speech.v2.IRecognitionConfig|null);

Recognizer defaultRecognitionConfig.

deleteTime

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

Recognizer deleteTime.

displayName

public displayName: string;

Recognizer displayName.

etag

public etag: string;

Recognizer etag.

expireTime

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

Recognizer expireTime.

kmsKeyName

public kmsKeyName: string;

Recognizer kmsKeyName.

kmsKeyVersionName

public kmsKeyVersionName: string;

Recognizer kmsKeyVersionName.

languageCodes

public languageCodes: string[];

Recognizer languageCodes.

model

public model: string;

Recognizer model.

name

public name: string;

Recognizer name.

reconciling

public reconciling: boolean;

Recognizer reconciling.

state

public state: (google.cloud.speech.v2.Recognizer.State|keyof typeof google.cloud.speech.v2.Recognizer.State);

Recognizer state.

uid

public uid: string;

Recognizer uid.

updateTime

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

Recognizer updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.speech.v2.IRecognizer): google.cloud.speech.v2.Recognizer;

Creates a new Recognizer instance using the specified properties.

Parameter

Name	Description
properties	`IRecognizer` Properties to set

Returns

Type	Description
google.cloud.speech.v2.Recognizer	Recognizer instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.speech.v2.Recognizer;

Decodes a Recognizer 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.speech.v2.Recognizer	Recognizer

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.speech.v2.Recognizer;

Decodes a Recognizer 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.speech.v2.Recognizer	Recognizer

encode(message, writer)

public static encode(message: google.cloud.speech.v2.IRecognizer, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Recognizer message. Does not implicitly messages.

Parameters

Name	Description
message	`IRecognizer` Recognizer 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.speech.v2.IRecognizer, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IRecognizer` Recognizer 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.speech.v2.Recognizer;

Creates a Recognizer 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.speech.v2.Recognizer	Recognizer

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Recognizer

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.speech.v2.Recognizer` Recognizer
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 Recognizer 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