Cloud Speech V2 Client - Class OperationMetadata (1.8.0)

Version 1.8.0

• 1.19.2 (latest)
• 1.19.1
• 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

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	Google\Cloud\Speech\V2\BatchRecognizeRequest The BatchRecognizeRequest that spawned the Operation.
↳ create_recognizer_request	Google\Cloud\Speech\V2\CreateRecognizerRequest The CreateRecognizerRequest that spawned the Operation.
↳ update_recognizer_request	Google\Cloud\Speech\V2\UpdateRecognizerRequest The UpdateRecognizerRequest that spawned the Operation.
↳ delete_recognizer_request	Google\Cloud\Speech\V2\DeleteRecognizerRequest The DeleteRecognizerRequest that spawned the Operation.
↳ undelete_recognizer_request	Google\Cloud\Speech\V2\UndeleteRecognizerRequest The UndeleteRecognizerRequest that spawned the Operation.
↳ create_custom_class_request	Google\Cloud\Speech\V2\CreateCustomClassRequest The CreateCustomClassRequest that spawned the Operation.
↳ update_custom_class_request	Google\Cloud\Speech\V2\UpdateCustomClassRequest The UpdateCustomClassRequest that spawned the Operation.
↳ delete_custom_class_request	Google\Cloud\Speech\V2\DeleteCustomClassRequest The DeleteCustomClassRequest that spawned the Operation.
↳ undelete_custom_class_request	Google\Cloud\Speech\V2\UndeleteCustomClassRequest The UndeleteCustomClassRequest that spawned the Operation.
↳ create_phrase_set_request	Google\Cloud\Speech\V2\CreatePhraseSetRequest The CreatePhraseSetRequest that spawned the Operation.
↳ update_phrase_set_request	Google\Cloud\Speech\V2\UpdatePhraseSetRequest The UpdatePhraseSetRequest that spawned the Operation.
↳ delete_phrase_set_request	Google\Cloud\Speech\V2\DeletePhraseSetRequest The DeletePhraseSetRequest that spawned the Operation.
↳ undelete_phrase_set_request	Google\Cloud\Speech\V2\UndeletePhraseSetRequest The UndeletePhraseSetRequest that spawned the Operation.
↳ update_config_request	Google\Cloud\Speech\V2\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	Google\Cloud\Speech\V2\BatchRecognizeMetadata Metadata specific to the BatchRecognize method.

getCreateTime

The time the operation was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 1;

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the operation was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 1;

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

The time the operation was last updated.

Generated from protobuf field .google.protobuf.Timestamp update_time = 2;

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

The time the operation was last updated.

Generated from protobuf field .google.protobuf.Timestamp update_time = 2;

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getResource

The resource path for the target of the operation.

Generated from protobuf field string resource = 3;

Returns
Type	Description
string

setResource

The resource path for the target of the operation.

Generated from protobuf field string resource = 3;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMethod

The method that triggered the operation.

Generated from protobuf field string method = 4;

Returns
Type	Description
string

setMethod

The method that triggered the operation.

Generated from protobuf field string method = 4;

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}.

Generated from protobuf field string kms_key_name = 6 [(.google.api.resource_reference) = {

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}.

Generated from protobuf field string kms_key_name = 6 [(.google.api.resource_reference) = {

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}.

Generated from protobuf field string kms_key_version_name = 7 [(.google.api.resource_reference) = {

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}.

Generated from protobuf field string kms_key_version_name = 7 [(.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBatchRecognizeRequest

The BatchRecognizeRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.BatchRecognizeRequest batch_recognize_request = 8;

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

hasBatchRecognizeRequest

setBatchRecognizeRequest

The BatchRecognizeRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.BatchRecognizeRequest batch_recognize_request = 8;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\BatchRecognizeRequest

Returns
Type	Description
$this

getCreateRecognizerRequest

The CreateRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.CreateRecognizerRequest create_recognizer_request = 9;

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

hasCreateRecognizerRequest

setCreateRecognizerRequest

The CreateRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.CreateRecognizerRequest create_recognizer_request = 9;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\CreateRecognizerRequest

Returns
Type	Description
$this

getUpdateRecognizerRequest

The UpdateRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdateRecognizerRequest update_recognizer_request = 10;

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

hasUpdateRecognizerRequest

setUpdateRecognizerRequest

The UpdateRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdateRecognizerRequest update_recognizer_request = 10;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\UpdateRecognizerRequest

Returns
Type	Description
$this

getDeleteRecognizerRequest

The DeleteRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.DeleteRecognizerRequest delete_recognizer_request = 11;

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

hasDeleteRecognizerRequest

setDeleteRecognizerRequest

The DeleteRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.DeleteRecognizerRequest delete_recognizer_request = 11;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\DeleteRecognizerRequest

Returns
Type	Description
$this

getUndeleteRecognizerRequest

The UndeleteRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UndeleteRecognizerRequest undelete_recognizer_request = 12;

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

hasUndeleteRecognizerRequest

setUndeleteRecognizerRequest

The UndeleteRecognizerRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UndeleteRecognizerRequest undelete_recognizer_request = 12;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\UndeleteRecognizerRequest

Returns
Type	Description
$this

getCreateCustomClassRequest

The CreateCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.CreateCustomClassRequest create_custom_class_request = 13;

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

hasCreateCustomClassRequest

setCreateCustomClassRequest

The CreateCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.CreateCustomClassRequest create_custom_class_request = 13;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\CreateCustomClassRequest

Returns
Type	Description
$this

getUpdateCustomClassRequest

The UpdateCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdateCustomClassRequest update_custom_class_request = 14;

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

hasUpdateCustomClassRequest

setUpdateCustomClassRequest

The UpdateCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdateCustomClassRequest update_custom_class_request = 14;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\UpdateCustomClassRequest

Returns
Type	Description
$this

getDeleteCustomClassRequest

The DeleteCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.DeleteCustomClassRequest delete_custom_class_request = 15;

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

hasDeleteCustomClassRequest

setDeleteCustomClassRequest

The DeleteCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.DeleteCustomClassRequest delete_custom_class_request = 15;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\DeleteCustomClassRequest

Returns
Type	Description
$this

getUndeleteCustomClassRequest

The UndeleteCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UndeleteCustomClassRequest undelete_custom_class_request = 16;

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

hasUndeleteCustomClassRequest

setUndeleteCustomClassRequest

The UndeleteCustomClassRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UndeleteCustomClassRequest undelete_custom_class_request = 16;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\UndeleteCustomClassRequest

Returns
Type	Description
$this

getCreatePhraseSetRequest

The CreatePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.CreatePhraseSetRequest create_phrase_set_request = 17;

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

hasCreatePhraseSetRequest

setCreatePhraseSetRequest

The CreatePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.CreatePhraseSetRequest create_phrase_set_request = 17;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\CreatePhraseSetRequest

Returns
Type	Description
$this

getUpdatePhraseSetRequest

The UpdatePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdatePhraseSetRequest update_phrase_set_request = 18;

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

hasUpdatePhraseSetRequest

setUpdatePhraseSetRequest

The UpdatePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdatePhraseSetRequest update_phrase_set_request = 18;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\UpdatePhraseSetRequest

Returns
Type	Description
$this

getDeletePhraseSetRequest

The DeletePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.DeletePhraseSetRequest delete_phrase_set_request = 19;

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

hasDeletePhraseSetRequest

setDeletePhraseSetRequest

The DeletePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.DeletePhraseSetRequest delete_phrase_set_request = 19;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\DeletePhraseSetRequest

Returns
Type	Description
$this

getUndeletePhraseSetRequest

The UndeletePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UndeletePhraseSetRequest undelete_phrase_set_request = 20;

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

hasUndeletePhraseSetRequest

setUndeletePhraseSetRequest

The UndeletePhraseSetRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UndeletePhraseSetRequest undelete_phrase_set_request = 20;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\UndeletePhraseSetRequest

Returns
Type	Description
$this

getUpdateConfigRequest

The UpdateConfigRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdateConfigRequest update_config_request = 21;

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

hasUpdateConfigRequest

setUpdateConfigRequest

The UpdateConfigRequest that spawned the Operation.

Generated from protobuf field .google.cloud.speech.v2.UpdateConfigRequest update_config_request = 21;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\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.

Generated from protobuf field int32 progress_percent = 22;

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.

Generated from protobuf field int32 progress_percent = 22;

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getBatchRecognizeMetadata

Metadata specific to the BatchRecognize method.

Generated from protobuf field .google.cloud.speech.v2.BatchRecognizeMetadata batch_recognize_metadata = 23;

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

hasBatchRecognizeMetadata

setBatchRecognizeMetadata

Metadata specific to the BatchRecognize method.

Generated from protobuf field .google.cloud.speech.v2.BatchRecognizeMetadata batch_recognize_metadata = 23;

Parameter
Name	Description
var	Google\Cloud\Speech\V2\BatchRecognizeMetadata

Returns
Type	Description
$this

getRequest

Returns
Type	Description
string

getMetadata

Returns
Type	Description
string