52 lines
1.9 KiB
Plaintext
52 lines
1.9 KiB
Plaintext
---
|
|
title: EnvironmentOptions (latest version)
|
|
description: API reference for qiskit_ibm_runtime.options.EnvironmentOptions in the latest version of qiskit-ibm-runtime
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions
|
|
---
|
|
|
|
# EnvironmentOptions
|
|
|
|
<Class id="qiskit_ibm_runtime.options.EnvironmentOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.33/qiskit_ibm_runtime/options/environment_options.py#L28-L55" signature="EnvironmentOptions(*args, **kwargs)" modifiers="class">
|
|
Options related to the execution environment.
|
|
|
|
## Attributes
|
|
|
|
### callback
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EnvironmentOptions.callback" attributeTypeHint="Callable | None" attributeValue="None">
|
|
Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters:
|
|
|
|
> 1. Job ID
|
|
> 2. Job result.
|
|
|
|
Default: `None`.
|
|
</Attribute>
|
|
|
|
### job\_tags
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EnvironmentOptions.job_tags" attributeTypeHint="List | None" attributeValue="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`.
|
|
</Attribute>
|
|
|
|
### log\_level
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EnvironmentOptions.log_level" attributeTypeHint="Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']" attributeValue="'WARNING'">
|
|
logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`.
|
|
|
|
Default: `WARNING`.
|
|
</Attribute>
|
|
|
|
### private
|
|
|
|
<Attribute id="qiskit_ibm_runtime.options.EnvironmentOptions.private" attributeTypeHint="bool | None" attributeValue="False">
|
|
Boolean value for marking jobs as private.
|
|
</Attribute>
|
|
|
|
## Methods
|
|
</Class>
|
|
|