Module macrobond_data_api.common.types.metadata_value_information

Classes

class MetadataValueInformation

The result of a call to Api.metadata_get_value_information(). Contains information about the requested metadata attribute values.

Browse git

Ancestors

• collections.abc.Sequence
• collections.abc.Reversible
• collections.abc.Collection
• collections.abc.Sized
• collections.abc.Iterable
• collections.abc.Container
• typing.Generic

Instance variables

var attribute_name : str

The name of the metadata attribute

var entities : Sequence[MetadataValueInformationItem]

entities

Methods

def to_dict(self) ‑> List[TypedDictMetadataValueInformationItem]

The information represented as a dictionary

Browse git

def to_pd_data_frame(self) ‑> DataFrame

The information represented as a Pandas DataFrame

Browse git

class MetadataValueInformationItem

Contains information about one metadata attribute value.

Browse git

Instance variables

var attribute_name : str

The name of the metadata attribute

var comment : Optional[str]

The comment of the metadata value

var description : str

The description of the metadata value

var value : Any

The value

Methods

def to_dict(self) ‑> TypedDictMetadataValueInformationItem

The information represented as a dictionary

Browse git

def to_pd_data_frame(self) ‑> DataFrame

The information represented as a Pandas DataFrame

Browse git

class TypedDictMetadataValueInformationItem

Contains information about one metadata attribute value.

Browse git

Ancestors

• builtins.dict

Class variables

var attribute_name : str

The name of the metadata attribute

var comment : Optional[str]

The comment of the metadata value

var description : str

The description of the metadata value

var value : Any

The value