Cloud Speech V2 Client - Class OperationMetadata (1.19.1)

Version latest

• 1.19.1 (latest)
• 1.19.0
• 1.18.3
• 1.16.0
• 1.15.0
• 1.14.3
• 1.13.1
• 1.12.0
• 1.11.2
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0

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

Represents the metadata of a long-running operation.

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

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ create_time	Google\Protobuf\Timestamp The time the operation was created.
↳ update_time	Google\Protobuf\Timestamp The time the operation was last updated.
↳ resource	string The resource path for the target of the operation.
↳ method	string The method that triggered the operation.
↳ kms_key_name	string The KMS key name with which the content of the Operation is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
↳ kms_key_version_name	string The KMS key version name with which content of the Operation is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
↳ batch_recognize_request	BatchRecognizeRequest The BatchRecognizeRequest that spawned the Operation.
↳ create_recognizer_request	CreateRecognizerRequest The CreateRecognizerRequest that spawned the Operation.
↳ update_recognizer_request	UpdateRecognizerRequest The UpdateRecognizerRequest that spawned the Operation.
↳ delete_recognizer_request	DeleteRecognizerRequest The DeleteRecognizerRequest that spawned the Operation.
↳ undelete_recognizer_request	UndeleteRecognizerRequest The UndeleteRecognizerRequest that spawned the Operation.
↳ create_custom_class_request	CreateCustomClassRequest The CreateCustomClassRequest that spawned the Operation.
↳ update_custom_class_request	UpdateCustomClassRequest The UpdateCustomClassRequest that spawned the Operation.
↳ delete_custom_class_request	DeleteCustomClassRequest The DeleteCustomClassRequest that spawned the Operation.
↳ undelete_custom_class_request	UndeleteCustomClassRequest The UndeleteCustomClassRequest that spawned the Operation.
↳ create_phrase_set_request	CreatePhraseSetRequest The CreatePhraseSetRequest that spawned the Operation.
↳ update_phrase_set_request	UpdatePhraseSetRequest The UpdatePhraseSetRequest that spawned the Operation.
↳ delete_phrase_set_request	DeletePhraseSetRequest The DeletePhraseSetRequest that spawned the Operation.
↳ undelete_phrase_set_request	UndeletePhraseSetRequest The UndeletePhraseSetRequest that spawned the Operation.
↳ update_config_request	UpdateConfigRequest The UpdateConfigRequest that spawned the Operation.
↳ progress_percent	int The percent progress of the Operation. Values can range from 0-100. If the value is 100, then the operation is finished.
↳ batch_recognize_metadata	BatchRecognizeMetadata Metadata specific to the BatchRecognize method.

getCreateTime

The time the operation was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the operation was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

The time the operation was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

The time the operation was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getResource

The resource path for the target of the operation.

Returns
Type	Description
string

setResource

The resource path for the target of the operation.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMethod

The method that triggered the operation.

Returns
Type	Description
string

setMethod

The method that triggered the operation.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getKmsKeyName

The KMS key name with which the content of the Operation is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Returns
Type	Description
string

setKmsKeyName

The KMS key name with which the content of the Operation is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getKmsKeyVersionName

The KMS key version name with which content of the Operation is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

Returns
Type	Description
string

setKmsKeyVersionName

The KMS key version name with which content of the Operation is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBatchRecognizeRequest

The BatchRecognizeRequest that spawned the Operation.

Returns
Type	Description
BatchRecognizeRequest|null

hasBatchRecognizeRequest

setBatchRecognizeRequest

The BatchRecognizeRequest that spawned the Operation.

Parameter
Name	Description
var	BatchRecognizeRequest

Returns
Type	Description
$this

getCreateRecognizerRequest

The CreateRecognizerRequest that spawned the Operation.

Returns
Type	Description
CreateRecognizerRequest|null

hasCreateRecognizerRequest

setCreateRecognizerRequest

The CreateRecognizerRequest that spawned the Operation.

Parameter
Name	Description
var	CreateRecognizerRequest

Returns
Type	Description
$this

getUpdateRecognizerRequest

The UpdateRecognizerRequest that spawned the Operation.

Returns
Type	Description
UpdateRecognizerRequest|null

hasUpdateRecognizerRequest

setUpdateRecognizerRequest

The UpdateRecognizerRequest that spawned the Operation.

Parameter
Name	Description
var	UpdateRecognizerRequest

Returns
Type	Description
$this

getDeleteRecognizerRequest

The DeleteRecognizerRequest that spawned the Operation.

Returns
Type	Description
DeleteRecognizerRequest|null

hasDeleteRecognizerRequest

setDeleteRecognizerRequest

The DeleteRecognizerRequest that spawned the Operation.

Parameter
Name	Description
var	DeleteRecognizerRequest

Returns
Type	Description
$this

getUndeleteRecognizerRequest

The UndeleteRecognizerRequest that spawned the Operation.

Returns
Type	Description
UndeleteRecognizerRequest|null

hasUndeleteRecognizerRequest

setUndeleteRecognizerRequest

The UndeleteRecognizerRequest that spawned the Operation.

Parameter
Name	Description
var	UndeleteRecognizerRequest

Returns
Type	Description
$this

getCreateCustomClassRequest

The CreateCustomClassRequest that spawned the Operation.

Returns
Type	Description
CreateCustomClassRequest|null

hasCreateCustomClassRequest

setCreateCustomClassRequest

The CreateCustomClassRequest that spawned the Operation.

Parameter
Name	Description
var	CreateCustomClassRequest

Returns
Type	Description
$this

getUpdateCustomClassRequest

The UpdateCustomClassRequest that spawned the Operation.

Returns
Type	Description
UpdateCustomClassRequest|null

hasUpdateCustomClassRequest

setUpdateCustomClassRequest

The UpdateCustomClassRequest that spawned the Operation.

Parameter
Name	Description
var	UpdateCustomClassRequest

Returns
Type	Description
$this

getDeleteCustomClassRequest

The DeleteCustomClassRequest that spawned the Operation.

Returns
Type	Description
DeleteCustomClassRequest|null

hasDeleteCustomClassRequest

setDeleteCustomClassRequest

The DeleteCustomClassRequest that spawned the Operation.

Parameter
Name	Description
var	DeleteCustomClassRequest

Returns
Type	Description
$this

getUndeleteCustomClassRequest

The UndeleteCustomClassRequest that spawned the Operation.

Returns
Type	Description
UndeleteCustomClassRequest|null

hasUndeleteCustomClassRequest

setUndeleteCustomClassRequest

The UndeleteCustomClassRequest that spawned the Operation.

Parameter
Name	Description
var	UndeleteCustomClassRequest

Returns
Type	Description
$this

getCreatePhraseSetRequest

The CreatePhraseSetRequest that spawned the Operation.

Returns
Type	Description
CreatePhraseSetRequest|null

hasCreatePhraseSetRequest

setCreatePhraseSetRequest

The CreatePhraseSetRequest that spawned the Operation.

Parameter
Name	Description
var	CreatePhraseSetRequest

Returns
Type	Description
$this

getUpdatePhraseSetRequest

The UpdatePhraseSetRequest that spawned the Operation.

Returns
Type	Description
UpdatePhraseSetRequest|null

hasUpdatePhraseSetRequest

setUpdatePhraseSetRequest

The UpdatePhraseSetRequest that spawned the Operation.

Parameter
Name	Description
var	UpdatePhraseSetRequest

Returns
Type	Description
$this

getDeletePhraseSetRequest

The DeletePhraseSetRequest that spawned the Operation.

Returns
Type	Description
DeletePhraseSetRequest|null

hasDeletePhraseSetRequest

setDeletePhraseSetRequest

The DeletePhraseSetRequest that spawned the Operation.

Parameter
Name	Description
var	DeletePhraseSetRequest

Returns
Type	Description
$this

getUndeletePhraseSetRequest

The UndeletePhraseSetRequest that spawned the Operation.

Returns
Type	Description
UndeletePhraseSetRequest|null

hasUndeletePhraseSetRequest

setUndeletePhraseSetRequest

The UndeletePhraseSetRequest that spawned the Operation.

Parameter
Name	Description
var	UndeletePhraseSetRequest

Returns
Type	Description
$this

getUpdateConfigRequest

The UpdateConfigRequest that spawned the Operation.

Returns
Type	Description
UpdateConfigRequest|null

hasUpdateConfigRequest

setUpdateConfigRequest

The UpdateConfigRequest that spawned the Operation.

Parameter
Name	Description
var	UpdateConfigRequest

Returns
Type	Description
$this

getProgressPercent

The percent progress of the Operation. Values can range from 0-100. If the value is 100, then the operation is finished.

Returns
Type	Description
int

setProgressPercent

The percent progress of the Operation. Values can range from 0-100. If the value is 100, then the operation is finished.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getBatchRecognizeMetadata

Metadata specific to the BatchRecognize method.

Returns
Type	Description
BatchRecognizeMetadata|null

hasBatchRecognizeMetadata

setBatchRecognizeMetadata

Metadata specific to the BatchRecognize method.

Parameter
Name	Description
var	BatchRecognizeMetadata

Returns
Type	Description
$this

getRequest

Returns
Type	Description
string

getMetadata

Returns
Type	Description
string