Cloud Speech V2 Client - Class DeletePhraseSetRequest (1.15.0)

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

Request message for the DeletePhraseSet method.

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

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the PhraseSet to delete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

↳ validate_only bool

If set, validate the request and preview the deleted PhraseSet, but do not actually delete it.

↳ allow_missing bool

If set to true, and the PhraseSet is not found, the request will succeed and be a no-op (no Operation is recorded in this case).

↳ etag string

This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

getName

Required. The name of the PhraseSet to delete.

Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

Returns
TypeDescription
string

setName

Required. The name of the PhraseSet to delete.

Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

If set, validate the request and preview the deleted PhraseSet, but do not actually delete it.

Returns
TypeDescription
bool

setValidateOnly

If set, validate the request and preview the deleted PhraseSet, but do not actually delete it.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAllowMissing

If set to true, and the PhraseSet is not found, the request will succeed and be a no-op (no Operation is recorded in this case).

Returns
TypeDescription
bool

setAllowMissing

If set to true, and the PhraseSet is not found, the request will succeed and be a no-op (no Operation is recorded in this case).

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEtag

This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
TypeDescription
string

setEtag

This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The name of the PhraseSet to delete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set} Please see Google\Cloud\Speech\V2\SpeechClient::phraseSetName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Speech\V2\DeletePhraseSetRequest