EnvironmentOptions
class EnvironmentOptions(log_level='WARNING', callback=None, job_tags=None, private=False)
Bases: object
Options related to the execution environment.
Attributes
Parameters
- log_level (Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'])
- callback (Callable | None)
- job_tags (List | None)
- private (bool | None)
callback
Type: Callable | None
Default value: None
(DEPRECATED) Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters:
- Job ID
- Job result.
Default: None.
job_tags
Type: List | None
Default value: None
Tags to be assigned to the job. The tags can subsequently be used as a filter in the qiskit_ibm_runtime.qiskit_runtime_service.jobs() function call.
Default: None.
log_level
Type: Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']
Default value: 'WARNING'
logging level to set in the execution environment. The valid log levels are: DEBUG, INFO, WARNING, ERROR, and CRITICAL.
Default: WARNING.
private
Type: bool | None
Default value: False
Boolean that indicates whether the job is marked as private. When set to true, input parameters are not returned, and the results can only be read once. After the job is completed, input parameters are deleted from the service. After the results are read, these are also deleted from the service. When set to false, the input parameters and results follow the standard retention behavior of the API.
Default: False.