57 lines
1.5 KiB
Plaintext
57 lines
1.5 KiB
Plaintext
---
|
||
title: ParameterNamespace
|
||
description: API reference for qiskit.providers.ibmq.runtime.ParameterNamespace
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace
|
||
---
|
||
|
||
# ParameterNamespace
|
||
|
||
<Class id="qiskit.providers.ibmq.runtime.ParameterNamespace" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py" signature="ParameterNamespace(parameters)" modifiers="class">
|
||
Bases: `types.SimpleNamespace`
|
||
|
||
A namespace for program parameters with validation.
|
||
|
||
This class provides a namespace for program parameters with auto-completion and validation support.
|
||
|
||
ParameterNamespace constructor.
|
||
|
||
**Parameters**
|
||
|
||
**parameters** (`Dict`) – The program’s input parameters.
|
||
|
||
## Methods
|
||
|
||
### validate
|
||
|
||
<Function id="qiskit.providers.ibmq.runtime.ParameterNamespace.validate" signature="ParameterNamespace.validate()">
|
||
Validate program input values.
|
||
|
||
<Admonition title="Note" type="note">
|
||
This method only verifies that required parameters have values. It does not fail the validation if the namespace has extraneous parameters.
|
||
</Admonition>
|
||
|
||
**Raises**
|
||
|
||
**IBMQInputValueError** – if validation fails
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### metadata
|
||
|
||
<Attribute id="qiskit.providers.ibmq.runtime.ParameterNamespace.metadata">
|
||
Returns the parameter metadata
|
||
|
||
**Return type**
|
||
|
||
`Dict`
|
||
</Attribute>
|
||
</Class>
|
||
|