Console
    Contact Us Start free

    OperationMetadata

    Represents the metadata of a long-running operation.

    JSON representation 
     { 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "resource" 
 : 
 string 
 , 
 "method" 
 : 
 string 
 , 
 "kmsKeyName" 
 : 
 string 
 , 
 "kmsKeyVersionName" 
 : 
 string 
 , 
 "progressPercent" 
 : 
 integer 
 , 
 // Union field request 
can be only one of the following: 
 "batchRecognizeRequest" 
 : 
 { 
 object (  BatchRecognizeRequest 
 
) 
 } 
 , 
 "createRecognizerRequest" 
 : 
 { 
 object (  CreateRecognizerRequest 
 
) 
 } 
 , 
 "updateRecognizerRequest" 
 : 
 { 
 object (  UpdateRecognizerRequest 
 
) 
 } 
 , 
 "deleteRecognizerRequest" 
 : 
 { 
 object (  DeleteRecognizerRequest 
 
) 
 } 
 , 
 "undeleteRecognizerRequest" 
 : 
 { 
 object (  UndeleteRecognizerRequest 
 
) 
 } 
 , 
 "createCustomClassRequest" 
 : 
 { 
 object (  CreateCustomClassRequest 
 
) 
 } 
 , 
 "updateCustomClassRequest" 
 : 
 { 
 object (  UpdateCustomClassRequest 
 
) 
 } 
 , 
 "deleteCustomClassRequest" 
 : 
 { 
 object (  DeleteCustomClassRequest 
 
) 
 } 
 , 
 "undeleteCustomClassRequest" 
 : 
 { 
 object (  UndeleteCustomClassRequest 
 
) 
 } 
 , 
 "createPhraseSetRequest" 
 : 
 { 
 object (  CreatePhraseSetRequest 
 
) 
 } 
 , 
 "updatePhraseSetRequest" 
 : 
 { 
 object (  UpdatePhraseSetRequest 
 
) 
 } 
 , 
 "deletePhraseSetRequest" 
 : 
 { 
 object (  DeletePhraseSetRequest 
 
) 
 } 
 , 
 "undeletePhraseSetRequest" 
 : 
 { 
 object (  UndeletePhraseSetRequest 
 
) 
 } 
 , 
 "updateConfigRequest" 
 : 
 { 
 object (  UpdateConfigRequest 
 
) 
 } 
 // End of list of possible types for union field request 
. 
 // Union field metadata 
can be only one of the following: 
 "batchRecognizeMetadata" 
 : 
 { 
 object (  BatchRecognizeMetadata 
 
) 
 } 
 // End of list of possible types for union field metadata 
. 
 }
    Fields
    create Time

    string ( Timestamp format)

    The time the operation was created.

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .

    update Time

    string ( Timestamp format)

    The time the operation was last updated.

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .

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

    progress Percent

    integer

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

    Union field request . The request that spawned the Operation. request can be only one of the following:
    batch Recognize Request

    object ( BatchRecognizeRequest )

    The BatchRecognizeRequest that spawned the Operation.

    create Recognizer Request

    object ( CreateRecognizerRequest )

    The CreateRecognizerRequest that spawned the Operation.

    update Recognizer Request

    object ( UpdateRecognizerRequest )

    The UpdateRecognizerRequest that spawned the Operation.

    delete Recognizer Request

    object ( DeleteRecognizerRequest )

    The DeleteRecognizerRequest that spawned the Operation.

    undelete Recognizer Request

    object ( UndeleteRecognizerRequest )

    The UndeleteRecognizerRequest that spawned the Operation.

    create Custom Class Request

    object ( CreateCustomClassRequest )

    The CreateCustomClassRequest that spawned the Operation.

    update Custom Class Request

    object ( UpdateCustomClassRequest )

    The UpdateCustomClassRequest that spawned the Operation.

    delete Custom Class Request

    object ( DeleteCustomClassRequest )

    The DeleteCustomClassRequest that spawned the Operation.

    undelete Custom Class Request

    object ( UndeleteCustomClassRequest )

    The UndeleteCustomClassRequest that spawned the Operation.

    create Phrase Set Request

    object ( CreatePhraseSetRequest )

    The CreatePhraseSetRequest that spawned the Operation.

    update Phrase Set Request

    object ( UpdatePhraseSetRequest )

    The UpdatePhraseSetRequest that spawned the Operation.

    delete Phrase Set Request

    object ( DeletePhraseSetRequest )

    The DeletePhraseSetRequest that spawned the Operation.

    undelete Phrase Set Request

    object ( UndeletePhraseSetRequest )

    The UndeletePhraseSetRequest that spawned the Operation.

    updateConfigRequest
    (deprecated)

    object ( UpdateConfigRequest )

    The UpdateConfigRequest that spawned the Operation.

    Union field metadata . Specific metadata per RPC. metadata can be only one of the following:
    batch Recognize Metadata

    object ( BatchRecognizeMetadata )

    Metadata specific to the recognizers.batchRecognize method.

    UpdateConfigRequest

    Request message for the config.update method.

    JSON representation 
     { 
 "config" 
 : 
 { 
 object (  Config 
 
) 
 } 
 , 
 "updateMask" 
 : 
 string 
 }
    Fields
    config

    object ( Config )

    Required. The config to update.

    The config's name field is used to identify the config to be updated. The expected format is projects/{project}/locations/{location}/config .
    update Mask

    string ( FieldMask format)

    The list of fields to be updated.

    This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .

    CreateCustomClassRequest

    Request message for the CreateCustomClass method.

    JSON representation 
     { 
 "customClass" 
 : 
 { 
 object (  CustomClass 
 
) 
 } 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "customClassId" 
 : 
 string 
 , 
 "parent" 
 : 
 string 
 }
    Fields
    custom Class

    object ( CustomClass )

    Required. The CustomClass to create.
    validate Only

    boolean

    If set, validate the request and preview the CustomClass, but do not actually create it.
    custom Class Id

    string

    The ID to use for the CustomClass, which will become the final component of the CustomClass's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
    parent

    string

    Required. The project and location where this CustomClass will be created. The expected format is projects/{project}/locations/{location} .

    DeleteCustomClassRequest

    Request message for the DeleteCustomClass method.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "allowMissing" 
 : 
 boolean 
 , 
 "etag" 
 : 
 string 
 }
    Fields
    name

    string

    Required. The name of the CustomClass to delete. Format: projects/{project}/locations/{location}/customClasses/{customClass}

    validate Only

    boolean

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

    boolean

    If set to true, and the CustomClass 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.

    UndeleteCustomClassRequest

    Request message for the customClasses.undelete method.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "etag" 
 : 
 string 
 }
    Fields
    name

    string

    Required. The name of the CustomClass to undelete. Format: projects/{project}/locations/{location}/customClasses/{customClass}

    validate Only

    boolean

    If set, validate the request and preview the undeleted CustomClass, but do not actually undelete it.
    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.

    UpdateCustomClassRequest

    Request message for the UpdateCustomClass method.

    JSON representation 
     { 
 "customClass" 
 : 
 { 
 object (  CustomClass 
 
) 
 } 
 , 
 "updateMask" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 }
    Fields
    custom Class

    object ( CustomClass )

    Required. The CustomClass to update.

    The CustomClass's name field is used to identify the CustomClass to update. Format: projects/{project}/locations/{location}/customClasses/{customClass} .
    update Mask

    string ( FieldMask format)

    The list of fields to be updated. If empty, all fields are considered for update.

    This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
    validate Only

    boolean

    If set, validate the request and preview the updated CustomClass, but do not actually update it.

    CreatePhraseSetRequest

    Request message for the CreatePhraseSet method.

    JSON representation 
     { 
 "phraseSet" 
 : 
 { 
 object (  PhraseSet 
 
) 
 } 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "phraseSetId" 
 : 
 string 
 , 
 "parent" 
 : 
 string 
 }
    Fields
    phrase Set

    object ( PhraseSet )

    Required. The PhraseSet to create.
    validate Only

    boolean

    If set, validate the request and preview the PhraseSet, but do not actually create it.
    phrase Set Id

    string

    The ID to use for the PhraseSet, which will become the final component of the PhraseSet's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
    parent

    string

    Required. The project and location where this PhraseSet will be created. The expected format is projects/{project}/locations/{location} .

    DeletePhraseSetRequest

    Request message for the DeletePhraseSet method.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "allowMissing" 
 : 
 boolean 
 , 
 "etag" 
 : 
 string 
 }
    Fields
    name

    string

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

    validate Only

    boolean

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

    boolean

    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.

    UndeletePhraseSetRequest

    Request message for the phraseSets.undelete method.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "etag" 
 : 
 string 
 }
    Fields
    name

    string

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

    validate Only

    boolean

    If set, validate the request and preview the undeleted PhraseSet, but do not actually undelete it.
    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.

    UpdatePhraseSetRequest

    Request message for the UpdatePhraseSet method.

    JSON representation 
     { 
 "phraseSet" 
 : 
 { 
 object (  PhraseSet 
 
) 
 } 
 , 
 "updateMask" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 }
    Fields
    phrase Set

    object ( PhraseSet )

    Required. The PhraseSet to update.

    The PhraseSet's name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phraseSet} .
    update Mask

    string ( FieldMask format)

    The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.

    This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
    validate Only

    boolean

    If set, validate the request and preview the updated PhraseSet, but do not actually update it.

    BatchRecognizeRequest

    Request message for the recognizers.batchRecognize method.

    JSON representation 
     { 
 "recognizer" 
 : 
 string 
 , 
 "config" 
 : 
 { 
 object (  RecognitionConfig 
 
) 
 } 
 , 
 "configMask" 
 : 
 string 
 , 
 "files" 
 : 
 [ 
 { 
 object (  BatchRecognizeFileMetadata 
 
) 
 } 
 ] 
 , 
 "recognitionOutputConfig" 
 : 
 { 
 object (  RecognitionOutputConfig 
 
) 
 } 
 , 
 "processingStrategy" 
 : 
 enum (  ProcessingStrategy 
 
) 
 }
    Fields
    recognizer

    string

    Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer} . The {recognizer} segment may be set to _ to use an empty implicit Recognizer.
    config

    object ( RecognitionConfig )

    Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the configMask field can be used to override parts of the defaultRecognitionConfig of the Recognizer resource.
    config Mask

    string ( FieldMask format)

    The list of fields in config that override the values in the defaultRecognitionConfig of the recognizer during this recognition request. If no mask is provided, all given fields in config override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard ( * ) is provided, config completely overrides and replaces the config in the recognizer for this recognition request.

    This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
    files[]

    object ( BatchRecognizeFileMetadata )

    Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15.
    recognition Output Config

    object ( RecognitionOutputConfig )

    Configuration options for where to output the transcripts of each file.
    processing Strategy

    enum ( ProcessingStrategy )

    Processing strategy to use for this request.

    CreateRecognizerRequest

    Request message for the recognizers.create method.

    JSON representation 
     { 
 "recognizer" 
 : 
 { 
 object (  Recognizer 
 
) 
 } 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "recognizerId" 
 : 
 string 
 , 
 "parent" 
 : 
 string 
 }
    Fields
    recognizer

    object ( Recognizer )

    Required. The Recognizer to create.
    validate Only

    boolean

    If set, validate the request and preview the Recognizer, but do not actually create it.
    recognizer Id

    string

    The ID to use for the Recognizer, which will become the final component of the Recognizer's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
    parent

    string

    Required. The project and location where this Recognizer will be created. The expected format is projects/{project}/locations/{location} .

    DeleteRecognizerRequest

    Request message for the recognizers.delete method.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "allowMissing" 
 : 
 boolean 
 , 
 "etag" 
 : 
 string 
 }
    Fields
    name

    string

    Required. The name of the Recognizer to delete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}

    validate Only

    boolean

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

    boolean

    If set to true, and the Recognizer 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.

    UndeleteRecognizerRequest

    Request message for the recognizers.undelete method.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 , 
 "etag" 
 : 
 string 
 }
    Fields
    name

    string

    Required. The name of the Recognizer to undelete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}

    validate Only

    boolean

    If set, validate the request and preview the undeleted Recognizer, but do not actually undelete it.
    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.

    UpdateRecognizerRequest

    Request message for the recognizers.patch method.

    JSON representation 
     { 
 "recognizer" 
 : 
 { 
 object (  Recognizer 
 
) 
 } 
 , 
 "updateMask" 
 : 
 string 
 , 
 "validateOnly" 
 : 
 boolean 
 }
    Fields
    recognizer

    object ( Recognizer )

    Required. The Recognizer to update.

    The Recognizer's name field is used to identify the Recognizer to update. Format: projects/{project}/locations/{location}/recognizers/{recognizer} .
    update Mask

    string ( FieldMask format)

    The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire Recognizer resource.

    This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
    validate Only

    boolean

    If set, validate the request and preview the updated Recognizer, but do not actually update it.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: