Module `macrobond_data_api.common.types.metadata_attribute_information`

Classes

class MetadataAttributeInformation

The result of a call to Api.metadata_get_attribute_information().
Contains information about the requested metadata attributes.

var can_have_multiple_values : bool: If True then this type of metadata can have multiple values in a metadata collection
var can_list_values : bool: If True then the values of this type of metadata can be listed by calling Api.metadata_list_values()
var comment : Optional[str]: The comment of the metadata attribute
var description : str: The description of the metadata attribute
var is_database_entity : bool: If True then this type of metadata is an entity that can be retrieved from the database
var name : str: The name of the metadata attribute
var uses_value_list : bool: If True, the metadata attribute uses a list of values
var value_type : MetadataAttributeType: The value type of the metadata attribute

def to_dict(self) ‑> TypedDictMetadataAttributeInformation: 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 TypedDictMetadataAttributeInformation

The result of a call to Api.metadata_get_attribute_information().
Contains information about the requested metadata attributes.

var can_have_multiple_values : bool: If True then this type of metadata can have multiple values in a metadata collection
var can_list_values : bool: If True then the values of this type of metadata can be listed using the Api.metadata_list_values() function
var comment : Optional[str]: The comment of the metadata attribute
var description : str: The description of the metadata attribute
var is_database_entity : bool: If True then this type of metadata is an entity that can be retrieved from the database using the Api.get_one_entity() function
var name : str: The name of the metadata attribute
var uses_value_list : bool: If True, the metadata attribute uses a list of values
var value_type : MetadataAttributeType: The value type of the metadata attribute