Skip to content

PlaylistItem🔗

Definition🔗

class PlaylistItem:
    # Type of the item.
    type_val: typing.Literal["dashboard_by_uid", "dashboard_by_id", "dashboard_by_tag"]
    # Value depends on type and describes the playlist item.
    # 
    #  - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This
    #  is not portable as the numerical identifier is non-deterministic between different instances.
    #  Will be replaced by dashboard_by_uid in the future. (deprecated)
    #  - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All
    #  dashboards behind the tag will be added to the playlist.
    #  - dashboard_by_uid: The value is the dashboard UID
    value: str
    # Title is an unused property -- it will be removed in the future
    title: typing.Optional[str]

Methods🔗

to_json🔗

Converts this object into a representation that can easily be encoded to JSON.

def to_json() -> dict[str, object]

from_json🔗

Builds this object from a JSON-decoded dict.

@classmethod
def from_json(data: dict[str, typing.Any]) -> typing.Self

See also🔗

PlaylistItem