kappa_sdk.Metadata#

class kappa_sdk.Metadata(user_measure_id, is_by_step, first_x, min_y, max_y, is_step_at_start, name, count, min_x=None, max_x=None, cumulative_vector_id=None)[source]#

Metadata object.

Presents a KAPPA Automate vector metadata object

Note

Should not be instantiated directly.

Attributes

`Metadata.count`	Gets number of points for this `Metadata`
`Metadata.cumulative_vector_id`	Gets cumulative vector id for this `Metadata`
`Metadata.first_x`	Gets the first X for this `Metadata`.
`Metadata.is_by_step`	Metadata is a step data or not.
`Metadata.is_step_at_start`	Metadata is a step at start data or not.
`Metadata.max_x`	Gets maximum X for this `Metadata`
`Metadata.max_y`	Gets the maximum Y for this `Metadata`.
`Metadata.min_x`	Gets minimum X for this `Metadata`
`Metadata.min_y`	Gets the minimum Y for this `Metadata`.
`Metadata.name`	Gets name for this `Metadata`
`Metadata.user_measure_id`	Gets the user measure id for this `Metadata`.

Methods

Parameters:

user_measure_id (str | None)
is_by_step (bool)
first_x (datetime | None)
min_y (float | None)
max_y (float | None)
is_step_at_start (bool)
name (str)
count (int)
min_x (datetime | None)
max_x (datetime | None)
cumulative_vector_id (str | None)

__init__(user_measure_id, is_by_step, first_x, min_y, max_y, is_step_at_start, name, count, min_x=None, max_x=None, cumulative_vector_id=None)[source]#

Parameters:

user_measure_id (str | None)
is_by_step (bool)
first_x (datetime | None)
min_y (float | None)
max_y (float | None)
is_step_at_start (bool)
name (str)
count (int)
min_x (datetime | None)
max_x (datetime | None)
cumulative_vector_id (str | None)

property user_measure_id: str | None#: Gets the user measure id for this Metadata.

property is_by_step: bool#

Metadata is a step data or not.

Type:: A value indicating whether this class

property first_x: datetime | None#: Gets the first X for this Metadata.

property min_y: float | None#: Gets the minimum Y for this Metadata.

property max_y: float | None#: Gets the maximum Y for this Metadata.

property is_step_at_start: bool#

Metadata is a step at start data or not.

Type:: A value indicating whether this class

property name: str#: Gets name for this Metadata

property count: int#: Gets number of points for this Metadata

property min_x: datetime | None#: Gets minimum X for this Metadata

property max_x: datetime | None#: Gets maximum X for this Metadata

property cumulative_vector_id: str | None#: Gets cumulative vector id for this Metadata