qiskit_ibm_runtime.options_models.EnvironmentOptions
pydantic model EnvironmentOptions
Bases: BaseOptionsModel
Options related to the execution environment.
Config
- validate_assignment: bool = True
- extra: str = forbid
image
field
Type: Annotated[str, Field(pattern``=``'[a-zA-Z0-9]+([/.\\-_][a-zA-Z0-9]+)*:[a-zA-Z0-9]+([.\\-_][a-zA-Z0-9]+)*$')] | None
Default value: None
IBM Quantum Compute (formerly Qiskit Runtime) image used for this job.
job_tags
field
Type: list[str]
Default value: []
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.
log_level
field
Type: LogLevelType
Default value: 'WARNING'
Logging level to set in the execution environment.
max_execution_time
field
Type: Annotated[int | None, AfterValidator(warn_max_execution_time)]
Default value: None
Maximum execution time in seconds.
This value bounds system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled.
Constraints
- func = <function warn_max_execution_time at 0x7f500e70b5b0>
private
field
Type: bool
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.