Cloud Speech V2 Client - Class OperationMetadata (1.8.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
NameDescription
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
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the operation was created.

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

The time the operation was last updated.

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

Returns
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getResource

The resource path for the target of the operation.

Generated from protobuf field string resource = 3;

Returns
TypeDescription
string

setResource

The resource path for the target of the operation.

Generated from protobuf field string resource = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMethod

The method that triggered the operation.

Generated from protobuf field string method = 4;

Returns
TypeDescription
string

setMethod

The method that triggered the operation.

Generated from protobuf field string method = 4;

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getBatchRecognizeRequest

The BatchRecognizeRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\BatchRecognizeRequest
Returns
TypeDescription
$this

getCreateRecognizerRequest

The CreateRecognizerRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\CreateRecognizerRequest
Returns
TypeDescription
$this

getUpdateRecognizerRequest

The UpdateRecognizerRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\UpdateRecognizerRequest
Returns
TypeDescription
$this

getDeleteRecognizerRequest

The DeleteRecognizerRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\DeleteRecognizerRequest
Returns
TypeDescription
$this

getUndeleteRecognizerRequest

The UndeleteRecognizerRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\UndeleteRecognizerRequest
Returns
TypeDescription
$this

getCreateCustomClassRequest

The CreateCustomClassRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\CreateCustomClassRequest
Returns
TypeDescription
$this

getUpdateCustomClassRequest

The UpdateCustomClassRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\UpdateCustomClassRequest
Returns
TypeDescription
$this

getDeleteCustomClassRequest

The DeleteCustomClassRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\DeleteCustomClassRequest
Returns
TypeDescription
$this

getUndeleteCustomClassRequest

The UndeleteCustomClassRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\UndeleteCustomClassRequest
Returns
TypeDescription
$this

getCreatePhraseSetRequest

The CreatePhraseSetRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\CreatePhraseSetRequest
Returns
TypeDescription
$this

getUpdatePhraseSetRequest

The UpdatePhraseSetRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\UpdatePhraseSetRequest
Returns
TypeDescription
$this

getDeletePhraseSetRequest

The DeletePhraseSetRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\DeletePhraseSetRequest
Returns
TypeDescription
$this

getUndeletePhraseSetRequest

The UndeletePhraseSetRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\UndeletePhraseSetRequest
Returns
TypeDescription
$this

getUpdateConfigRequest

The UpdateConfigRequest that spawned the Operation.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\UpdateConfigRequest
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getBatchRecognizeMetadata

Metadata specific to the BatchRecognize method.

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Speech\V2\BatchRecognizeMetadata
Returns
TypeDescription
$this

getRequest

Returns
TypeDescription
string

getMetadata

Returns
TypeDescription
string