EntityId Class

EntityId.

It identifies an entity by its name and its key.

Instantiate an EntityId object.

Identifies an entity by its name and its key.

Constructor

EntityId(name: str, key: str)

Parameters

Name	Description
name Required	str The entity name
key Required	str The entity key

Methods

get_entity_id	Return an EntityId from a SchedulerId string.
get_entity_id_url_path	Print the the entity url path.
get_scheduler_id	Produce a SchedulerId from an EntityId.

get_entity_id

Return an EntityId from a SchedulerId string.

static get_entity_id(scheduler_id: str) -> EntityId

Parameters

Name	Description
scheduler_id Required	str The SchedulerId in which to base the returned EntityId

Returns

Type	Description
EntityId	An EntityId object based on the SchedulerId string

Exceptions

Type	Description
ValueError:	When the SchedulerId string does not have the expected format

get_entity_id_url_path

Print the the entity url path.

static get_entity_id_url_path(entity_id: EntityId) -> str

Parameters

Name	Description
entity_id Required

Returns

Type	Description
str	A url path of the EntityId

get_scheduler_id

Produce a SchedulerId from an EntityId.

static get_scheduler_id(entity_id: EntityId) -> str

Parameters

Name	Description
entity_id Required	EntityId An EntityId object

Returns

Type	Description
str	A SchedulerId representation of the input EntityId