Class: MetadataRequest
Contains the metadata request info of a consumer.
Instances of MethodMetadataRequest are used in this class for each available method under metadatarequest.{method}.
Consumer-only classes such as simple estimators return a serialized version of this class as the output of get_metadata_routing().
Constructors
new MetadataRequest()
new MetadataRequest(
opts?):MetadataRequest
Parameters
| Parameter | Type | Description |
|---|---|---|
opts? | object | - |
opts.owner? | string | The name of the object to which these requests belong. |
Returns MetadataRequest
Defined in generated/utils/metadata_routing/MetadataRequest.ts:25
Properties
| Property | Type | Default value | Defined in |
|---|---|---|---|
_isDisposed | boolean | false | generated/utils/metadata_routing/MetadataRequest.ts:23 |
_isInitialized | boolean | false | generated/utils/metadata_routing/MetadataRequest.ts:22 |
_py | PythonBridge | undefined | generated/utils/metadata_routing/MetadataRequest.ts:21 |
id | string | undefined | generated/utils/metadata_routing/MetadataRequest.ts:18 |
opts | any | undefined | generated/utils/metadata_routing/MetadataRequest.ts:19 |
Accessors
py
Get Signature
get py():
PythonBridge
Returns PythonBridge
Set Signature
set py(
pythonBridge):void
Parameters
| Parameter | Type |
|---|---|
pythonBridge | PythonBridge |
Returns void
Defined in generated/utils/metadata_routing/MetadataRequest.ts:35
Methods
consumes()
consumes(
opts):Promise<any>
Check whether the given parameters are consumed by the given method.
Parameters
| Parameter | Type | Description |
|---|---|---|
opts | object | - |
opts.method? | string | The name of the method to check. |
opts.params? | any | An iterable of parameters to check. |
Returns Promise<any>
Defined in generated/utils/metadata_routing/MetadataRequest.ts:104
dispose()
dispose():
Promise<void>
Disposes of the underlying Python resources.
Once dispose() is called, the instance is no longer usable.
Returns Promise<void>
Defined in generated/utils/metadata_routing/MetadataRequest.ts:87
init()
init(
py):Promise<void>
Initializes the underlying Python resources.
This instance is not usable until the Promise returned by init() resolves.
Parameters
| Parameter | Type |
|---|---|
py | PythonBridge |
Returns Promise<void>
Defined in generated/utils/metadata_routing/MetadataRequest.ts:48