Represents a PhraseSet.
Package
@google-cloud/speechConstructors
(constructor)(properties)
constructor(properties?: google.cloud.speech.v2.IPhraseSet);
Constructs a new PhraseSet.
Name | Description |
properties |
IPhraseSet
Properties to set |
Properties
annotations
public annotations: { [k: string]: string };
PhraseSet annotations.
boost
public boost: number;
PhraseSet boost.
createTime
public createTime?: (google.protobuf.ITimestamp|null);
PhraseSet createTime.
deleteTime
public deleteTime?: (google.protobuf.ITimestamp|null);
PhraseSet deleteTime.
displayName
public displayName: string;
PhraseSet displayName.
etag
public etag: string;
PhraseSet etag.
expireTime
public expireTime?: (google.protobuf.ITimestamp|null);
PhraseSet expireTime.
kmsKeyName
public kmsKeyName: string;
PhraseSet kmsKeyName.
kmsKeyVersionName
public kmsKeyVersionName: string;
PhraseSet kmsKeyVersionName.
name
public name: string;
PhraseSet name.
phrases
public phrases: google.cloud.speech.v2.PhraseSet.IPhrase[];
PhraseSet phrases.
reconciling
public reconciling: boolean;
PhraseSet reconciling.
state
public state: (google.cloud.speech.v2.PhraseSet.State|keyof typeof google.cloud.speech.v2.PhraseSet.State);
PhraseSet state.
uid
public uid: string;
PhraseSet uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
PhraseSet updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.speech.v2.IPhraseSet): google.cloud.speech.v2.PhraseSet;
Creates a new PhraseSet instance using the specified properties.
Name | Description |
properties |
IPhraseSet
Properties to set |
Type | Description |
google.cloud.speech.v2.PhraseSet | PhraseSet instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.speech.v2.PhraseSet;
Decodes a PhraseSet message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.speech.v2.PhraseSet | PhraseSet |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.speech.v2.PhraseSet;
Decodes a PhraseSet message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.speech.v2.PhraseSet | PhraseSet |
encode(message, writer)
public static encode(message: google.cloud.speech.v2.IPhraseSet, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified PhraseSet message. Does not implicitly messages.
Name | Description |
message |
IPhraseSet
PhraseSet message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.speech.v2.IPhraseSet, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified PhraseSet message, length delimited. Does not implicitly messages.
Name | Description |
message |
IPhraseSet
PhraseSet message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.speech.v2.PhraseSet;
Creates a PhraseSet message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.speech.v2.PhraseSet | PhraseSet |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for PhraseSet
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this PhraseSet to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.speech.v2.PhraseSet, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a PhraseSet message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.speech.v2.PhraseSet
PhraseSet |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a PhraseSet message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|