PhraseSet

google.cloud.speech.v2. PhraseSet

Represents a PhraseSet.

Constructor

new PhraseSet(propertiesopt)

Constructs a new PhraseSet.

Parameters:
Name Type Attributes Description
properties google.cloud.speech.v2.IPhraseSet <optional>

Properties to set

Implements:
  • IPhraseSet

Classes

Phrase

Members

annotations

PhraseSet annotations.

boost

PhraseSet boost.

createTime

PhraseSet createTime.

deleteTime

PhraseSet deleteTime.

displayName

PhraseSet displayName.

etag

PhraseSet etag.

expireTime

PhraseSet expireTime.

kmsKeyName

PhraseSet kmsKeyName.

kmsKeyVersionName

PhraseSet kmsKeyVersionName.

name

PhraseSet name.

phrases

PhraseSet phrases.

reconciling

PhraseSet reconciling.

state

PhraseSet state.

uid

PhraseSet uid.

updateTime

PhraseSet updateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ACTIVE number

ACTIVE value

DELETED number

DELETED value

Methods

toJSON() → {Object.<string, *>}

Converts this PhraseSet to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.speech.v2.PhraseSet}

Creates a new PhraseSet instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.speech.v2.IPhraseSet <optional>

Properties to set

Returns:
Type Description
google.cloud.speech.v2.PhraseSet

PhraseSet instance

(static) decode(reader, lengthopt) → {google.cloud.speech.v2.PhraseSet}

Decodes a PhraseSet message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.speech.v2.PhraseSet

PhraseSet

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.speech.v2.PhraseSet}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.speech.v2.PhraseSet

PhraseSet

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified PhraseSet message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.speech.v2.IPhraseSet

PhraseSet message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.speech.v2.IPhraseSet

PhraseSet message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.speech.v2.PhraseSet}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.speech.v2.PhraseSet

PhraseSet

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for PhraseSet

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.speech.v2.PhraseSet

PhraseSet

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a PhraseSet message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not