KRN (Kelvin Resource Names)¶

The KRN module provides classes for working with Kelvin Resource Names, which uniquely identify resources within the Kelvin platform.

KRNs follow a hierarchical naming convention that allows for precise identification of resources such as applications, assets, workloads, datastreams, and more.

KRN Module¶

The main module providing all KRN classes and utilities.

Kelvin Resource Names.

class kelvin.krn.KRN(ns_id, ns_string)[source]¶

Bases: object

Kelvin Resource Name representation

Parameters:

ns_id (str)
ns_string (str)

ns_id: str¶

ns_string: str¶

classmethod validate(v)[source]¶

Return type:: KRN
Parameters:: v (Any)

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

classmethod from_string(v)[source]¶

Return type:: Self
Parameters:: v (str)

encode()[source]¶

Return type:: str

class kelvin.krn.KRNApp(app)[source]¶

Bases: KRN

Parameters:: app (str)

app: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNAppVersion(app, version)[source]¶

Bases: KRN

Parameters:

app (str)
version (str)

app: str¶

version: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNAsset(asset)[source]¶

Bases: KRN

Parameters:: asset (str)

asset: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNAssetDataStream(asset, data_stream)[source]¶

Bases: KRN

Parameters:

asset (str)
data_stream (str)

asset: str¶

data_stream: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

property data: str¶

class kelvin.krn.KRNAssetMetric(asset, metric)[source]¶

Bases: KRN

Parameters:

asset (str)
metric (str)

asset: str¶

metric: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNAssetParameter(asset, parameter)[source]¶

Bases: KRN

Parameters:

asset (str)
parameter (str)

asset: str¶

parameter: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNDatastream(datastream)[source]¶

Bases: KRN

Parameters:: datastream (str)

datastream: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNJob(job, job_run_id)[source]¶

Bases: KRN

Parameters:

job (str)
job_run_id (str)

job: str¶

job_run_id: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNParameter(parameter)[source]¶

Bases: KRN

Parameters:: parameter (str)

parameter: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNRecommendation(recommendation_id)[source]¶

Bases: KRN

Parameters:: recommendation_id (str)

recommendation_id: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNSchedule(schedule)[source]¶

Bases: KRN

Parameters:: schedule (str)

schedule: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNServiceAccount(service_account)[source]¶

Bases: KRN

Parameters:: service_account (str)

service_account: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNUser(user)[source]¶

Bases: KRN

Parameters:: user (str)

user: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNWorkload(node, workload)[source]¶

Bases: KRN

Parameters:

node (str)
workload (str)

node: str¶

workload: str¶

property node_name: str¶: Backwards compatibility

property workload_name: str¶: Backwards compatibility

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNWorkloadAppVersion(node, workload, app, version)[source]¶

Bases: KRN

Parameters:

node (str)
workload (str)
app (str)
version (str)

node: str¶

workload: str¶

app: str¶

version: str¶

property node_name: str¶: Backwards compatibility

property workload_name: str¶: Backwards compatibility

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNAssetDataQuality(asset, data_quality)[source]¶

Bases: KRN

Parameters:

asset (str)
data_quality (str)

asset: str¶

data_quality: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.KRNAssetDataStreamDataQuality(asset, data_stream, data_quality)[source]¶

Bases: KRN

Parameters:

asset (str)
data_stream (str)
data_quality (str)

asset: str¶

data_stream: str¶

data_quality: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

KRN Classes¶

Detailed documentation of individual KRN classes for different resource types.

class kelvin.krn.krn.KRN(ns_id, ns_string)[source]¶

Bases: object

Kelvin Resource Name representation

Parameters:

ns_id (str)
ns_string (str)

ns_id: str¶

ns_string: str¶

classmethod validate(v)[source]¶

Return type:: KRN
Parameters:: v (Any)

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

classmethod from_string(v)[source]¶

Return type:: Self
Parameters:: v (str)

encode()[source]¶

Return type:: str

class kelvin.krn.krn.KRNAsset(asset)[source]¶

Bases: KRN

Parameters:: asset (str)

asset: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNAssetMetric(asset, metric)[source]¶

Bases: KRN

Parameters:

asset (str)
metric (str)

asset: str¶

metric: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNAssetDataStream(asset, data_stream)[source]¶

Bases: KRN

Parameters:

asset (str)
data_stream (str)

asset: str¶

data_stream: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

property data: str¶

class kelvin.krn.krn.KRNAssetParameter(asset, parameter)[source]¶

Bases: KRN

Parameters:

asset (str)
parameter (str)

asset: str¶

parameter: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNParameter(parameter)[source]¶

Bases: KRN

Parameters:: parameter (str)

parameter: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNWorkload(node, workload)[source]¶

Bases: KRN

Parameters:

node (str)
workload (str)

node: str¶

workload: str¶

property node_name: str¶: Backwards compatibility

property workload_name: str¶: Backwards compatibility

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNWorkloadAppVersion(node, workload, app, version)[source]¶

Bases: KRN

Parameters:

node (str)
workload (str)
app (str)
version (str)

node: str¶

workload: str¶

app: str¶

version: str¶

property node_name: str¶: Backwards compatibility

property workload_name: str¶: Backwards compatibility

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNRecommendation(recommendation_id)[source]¶

Bases: KRN

Parameters:: recommendation_id (str)

recommendation_id: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNAppVersion(app, version)[source]¶

Bases: KRN

Parameters:

app (str)
version (str)

app: str¶

version: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNApp(app)[source]¶

Bases: KRN

Parameters:: app (str)

app: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNDatastream(datastream)[source]¶

Bases: KRN

Parameters:: datastream (str)

datastream: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNUser(user)[source]¶

Bases: KRN

Parameters:: user (str)

user: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNServiceAccount(service_account)[source]¶

Bases: KRN

Parameters:: service_account (str)

service_account: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNJob(job, job_run_id)[source]¶

Bases: KRN

Parameters:

job (str)
job_run_id (str)

job: str¶

job_run_id: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNSchedule(schedule)[source]¶

Bases: KRN

Parameters:: schedule (str)

schedule: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNAssetDataQuality(asset, data_quality)[source]¶

Bases: KRN

Parameters:

asset (str)
data_quality (str)

asset: str¶

data_quality: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

class kelvin.krn.krn.KRNAssetDataStreamDataQuality(asset, data_stream, data_quality)[source]¶

Bases: KRN

Parameters:

asset (str)
data_stream (str)
data_quality (str)

asset: str¶

data_stream: str¶

data_quality: str¶

classmethod from_krn(ns_id, ns_string)[source]¶

Return type:

Self

Parameters:

ns_id (str)
ns_string (str)

Available KRN Types¶

The following KRN types are available for identifying different resources:

KRN - Base class for all Kelvin Resource Names
KRNApp - Application identifier
KRNAppVersion - Application version identifier
KRNAsset - Asset identifier
KRNAssetDataQuality - Asset data quality identifier
KRNAssetDataStream - Asset data stream identifier
KRNAssetDataStreamDataQuality - Asset data stream data quality identifier
KRNAssetMetric - Asset metric identifier
KRNAssetParameter - Asset parameter identifier
KRNDatastream - Datastream identifier
KRNJob - Job identifier
KRNParameter - Parameter identifier
KRNRecommendation - Recommendation identifier
KRNSchedule - Schedule identifier
KRNServiceAccount - Service account identifier
KRNUser - User identifier
KRNWorkload - Workload identifier
KRNWorkloadAppVersion - Workload application version identifier