Cloud Speech V2 Client - Class UpdatePhraseSetRequest (1.19.0)

Reference documentation and code samples for the Cloud Speech V2 Client class UpdatePhraseSetRequest.

Request message for the UpdatePhraseSet method.

Generated from protobuf message google.cloud.speech.v2.UpdatePhraseSetRequest

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ phrase_set Google\Cloud\Speech\V2\PhraseSet

Required. The PhraseSet to update. The PhraseSet's name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

↳ update_mask Google\Protobuf\FieldMask

The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.

↳ validate_only bool

If set, validate the request and preview the updated PhraseSet, but do not actually update it.

getPhraseSet

Required. The PhraseSet to update.

The PhraseSet's name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

Returns
Type Description
Google\Cloud\Speech\V2\PhraseSet|null

hasPhraseSet

clearPhraseSet

setPhraseSet

Required. The PhraseSet to update.

The PhraseSet's name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

Parameter
Name Description
var Google\Cloud\Speech\V2\PhraseSet
Returns
Type Description
$this

getUpdateMask

The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getValidateOnly

If set, validate the request and preview the updated PhraseSet, but do not actually update it.

Returns
Type Description
bool

setValidateOnly

If set, validate the request and preview the updated PhraseSet, but do not actually update it.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
phraseSet Google\Cloud\Speech\V2\PhraseSet

Required. The PhraseSet to update.

The PhraseSet's name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

updateMask Google\Protobuf\FieldMask

The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.

Returns
Type Description
Google\Cloud\Speech\V2\UpdatePhraseSetRequest