Back to bricks list
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

Tag

Attributes
is_propagable: boolkey: strorigins: TagOriginsvalue: Union
Functions
__INIT__

Create a new tag

key : str
key of the tag
value : Union
value of the tag
is_propagable : bool - False
if True the tagwill be propagated in next resouces and views
origins : TagOrigins
origin of the tag
auto_parse : bool - False
if True the key and value will be parsed to validate tag format. if False and tag is invalid, an exception will be raised
GET_STR_VALUE
Return type : str
GET_VALUE_FORMAT
Return type : TagValueFormat
ORIGIN_IS_DEFINED
Return type : bool
PROPAGATE

Return a new instance of tag with the new origin. Only the origin_type and origin_id are propagated

origin_type : TagOriginType
origin_id : str
Return type : Tag
SET_EXTERNAL_LAB_ORIGIN

Set the external lab origin for all origin if not already defined

external_lab_origin_id : str
TO_DTO
Return type : TagDTO
CONVERT_STR_VALUE_TO_TYPE - @staticmethod
value : str
value_format : TagValueFormat
Return type : Union
CONVERT_VALUE_TO_STR - @staticmethod
value : Union
Return type : str
FROM_DTO - @staticmethod
dto : TagDTO
Return type : Tag
PARSE_TAG - @staticmethod

Parse a tag from a string

tag_str : str
Return type : str
VALIDATE_TAG - @staticmethod
tag_str : str