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 \ V2Methods
__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 |
↳ kms_key_version_name |
string
The KMS key version name with which content of the Operation is encrypted. The expected format is |
↳ 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.
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 |
Google\Cloud\Speech\V2\BatchRecognizeRequest|null |
hasBatchRecognizeRequest
setBatchRecognizeRequest
The BatchRecognizeRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\BatchRecognizeRequest
|
Returns | |
---|---|
Type | Description |
$this |
getCreateRecognizerRequest
The CreateRecognizerRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\CreateRecognizerRequest|null |
hasCreateRecognizerRequest
setCreateRecognizerRequest
The CreateRecognizerRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\CreateRecognizerRequest
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateRecognizerRequest
The UpdateRecognizerRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\UpdateRecognizerRequest|null |
hasUpdateRecognizerRequest
setUpdateRecognizerRequest
The UpdateRecognizerRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\UpdateRecognizerRequest
|
Returns | |
---|---|
Type | Description |
$this |
getDeleteRecognizerRequest
The DeleteRecognizerRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\DeleteRecognizerRequest|null |
hasDeleteRecognizerRequest
setDeleteRecognizerRequest
The DeleteRecognizerRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\DeleteRecognizerRequest
|
Returns | |
---|---|
Type | Description |
$this |
getUndeleteRecognizerRequest
The UndeleteRecognizerRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\UndeleteRecognizerRequest|null |
hasUndeleteRecognizerRequest
setUndeleteRecognizerRequest
The UndeleteRecognizerRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\UndeleteRecognizerRequest
|
Returns | |
---|---|
Type | Description |
$this |
getCreateCustomClassRequest
The CreateCustomClassRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\CreateCustomClassRequest|null |
hasCreateCustomClassRequest
setCreateCustomClassRequest
The CreateCustomClassRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\CreateCustomClassRequest
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateCustomClassRequest
The UpdateCustomClassRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\UpdateCustomClassRequest|null |
hasUpdateCustomClassRequest
setUpdateCustomClassRequest
The UpdateCustomClassRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\UpdateCustomClassRequest
|
Returns | |
---|---|
Type | Description |
$this |
getDeleteCustomClassRequest
The DeleteCustomClassRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\DeleteCustomClassRequest|null |
hasDeleteCustomClassRequest
setDeleteCustomClassRequest
The DeleteCustomClassRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\DeleteCustomClassRequest
|
Returns | |
---|---|
Type | Description |
$this |
getUndeleteCustomClassRequest
The UndeleteCustomClassRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\UndeleteCustomClassRequest|null |
hasUndeleteCustomClassRequest
setUndeleteCustomClassRequest
The UndeleteCustomClassRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\UndeleteCustomClassRequest
|
Returns | |
---|---|
Type | Description |
$this |
getCreatePhraseSetRequest
The CreatePhraseSetRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\CreatePhraseSetRequest|null |
hasCreatePhraseSetRequest
setCreatePhraseSetRequest
The CreatePhraseSetRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\CreatePhraseSetRequest
|
Returns | |
---|---|
Type | Description |
$this |
getUpdatePhraseSetRequest
The UpdatePhraseSetRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\UpdatePhraseSetRequest|null |
hasUpdatePhraseSetRequest
setUpdatePhraseSetRequest
The UpdatePhraseSetRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\UpdatePhraseSetRequest
|
Returns | |
---|---|
Type | Description |
$this |
getDeletePhraseSetRequest
The DeletePhraseSetRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\DeletePhraseSetRequest|null |
hasDeletePhraseSetRequest
setDeletePhraseSetRequest
The DeletePhraseSetRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\DeletePhraseSetRequest
|
Returns | |
---|---|
Type | Description |
$this |
getUndeletePhraseSetRequest
The UndeletePhraseSetRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\UndeletePhraseSetRequest|null |
hasUndeletePhraseSetRequest
setUndeletePhraseSetRequest
The UndeletePhraseSetRequest that spawned the Operation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\UndeletePhraseSetRequest
|
Returns | |
---|---|
Type | Description |
$this |
getUpdateConfigRequest
The UpdateConfigRequest that spawned the Operation.
Returns | |
---|---|
Type | Description |
Google\Cloud\Speech\V2\UpdateConfigRequest|null |
hasUpdateConfigRequest
setUpdateConfigRequest
The UpdateConfigRequest that spawned the Operation.
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.
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 |
Google\Cloud\Speech\V2\BatchRecognizeMetadata|null |
hasBatchRecognizeMetadata
setBatchRecognizeMetadata
Metadata specific to the BatchRecognize method.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Speech\V2\BatchRecognizeMetadata
|
Returns | |
---|---|
Type | Description |
$this |
getRequest
Returns | |
---|---|
Type | Description |
string |
getMetadata
Returns | |
---|---|
Type | Description |
string |