IBMQJob.update_tags

IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)[source]

Update the tags associated with this job.

When multiple parameters are specified, the parameters are processed in the following order:

  1. replacement_tags

  2. additional_tags

  3. removal_tags

For example, if ‘new_tag’ is specified for both additional_tags and removal_tags, then it is added and subsequently removed from the tags list, making it a “do nothing” operation.

Note

  • Some tags, such as those starting with ibmq_jobset, are used internally by ibmq-provider and therefore cannot be modified.

  • When removing tags, if the job does not have a specified tag, it will be ignored.

Parameters

  • replacement_tags (Optional[List[str]]) – The tags that should replace the current tags associated with this job.

  • additional_tags (Optional[List[str]]) – The new tags that should be added to the current tags associated with this job.

  • removal_tags (Optional[List[str]]) – The tags that should be removed from the current tags associated with this job.

Return type

List[str]

Returns

The new tags associated with this job.

Raises

  • IBMQJobApiError – If an unexpected error occurred when communicating with the server or updating the job tags.

  • IBMQJobInvalidStateError – If none of the input parameters are specified or if any of the input parameters are invalid.