API Response Models

Responses

class kelvin.sdk.client.model.responses.ACP(client: Optional[Client] = None, *, cluster_name: str = None, created: datetime.datetime = None, kelvin_info: Dict[str, Any] = None, location: kelvin.sdk.client.model.responses.ACPLocationItem = None, manifests_scrape_enabled: bool = None, manifests_scrape_interval: int = None, metadata: Dict[str, Any] = None, metrics_enabled: bool = None, metrics_scrape_interval: int = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, network_info: List[Dict[str, Any]] = None, node_name: str = None, status_scrape_enabled: bool = None, status_scrape_interval: int = None, system_info: Dict[str, Any] = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACP object.

Parameters

  • cluster_name (Optional[str]) –

  • created (Optional[datetime]) –

  • kelvin_info (Optional[Dict[str, Any]]) –

  • location (Optional[ACPLocationItem]) –

  • manifests_scrape_enabled (Optional[bool]) –

  • manifests_scrape_interval (Optional[int]) –

  • metadata (Optional[Dict[str, Any]]) –

  • metrics_enabled (Optional[bool]) –

  • metrics_scrape_interval (Optional[int]) –

  • name (Optional[str]) –

  • network_info (Optional[List[Dict[str, Any]]]) –

  • node_name (Optional[str]) –

  • status_scrape_enabled (Optional[bool]) –

  • status_scrape_interval (Optional[int]) –

  • system_info (Optional[Dict[str, Any]]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

cluster_name: Optional[str]
classmethod create_acp_metadata(acp_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPMetadata

Create ACP Metadata

Permission Required: kelvin.permission.acp.create.

createACPMetadata: POST /api/v4/acps/{acp_name}/metadata/create

Parameters

  • acp_name (str, optional) – ACP name

  • data (requests.ACPMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ACPMetadataCreate

classmethod create_acp_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create ACP Metadata Bulk

Permission Required: kelvin.permission.acp.create.

createACPMetadataBulk: POST /api/v4/acps/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_acp(acp_name: str, dry_run: bool = False, client: Any = None) → None

Delete ACP

Permission Required: kelvin.permission.acp.delete.

deleteACP: POST /api/v4/acps/{acp_name}/delete

Parameters

acp_name (str, optional) – ACP name

classmethod delete_acp_metadata(acp_name: str, acp_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete ACP Metadata

Permission Required: kelvin.permission.acp.delete.

deleteACPMetadata: POST /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/delete

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

classmethod delete_acp_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete ACP Metadata Bulk

Permission Required: kelvin.permission.acp.delete.

deleteACPMetadataBulk: POST /api/v4/acps/metadata/delete

Parameters
fields: Any = None
classmethod force_update_acp_edge_app_version(acp_name: str, dry_run: bool = False, client: Any = None) → None

Force Update ACP Edge App Version

Permission Required: kelvin.permission.acp.read.

forceUpdateACPEdgeAppVersion: POST /api/v4/acps/{acp_name}/edge-apps/version/force-update

Parameters

acp_name (str, optional) – ACP name

classmethod get_acp(acp_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ACP

Get ACP

Permission Required: kelvin.permission.acp.read.

getACP: GET /api/v4/acps/{acp_name}/get

Parameters

  • acp_name (str, optional) – ACP name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_acp_edge_app_version(acp_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ACPEdgeAppVersion

Get ACP Edge App Version

Permission Required: kelvin.permission.acp.read.

getACPEdgeAppVersion: GET /api/v4/acps/{acp_name}/edge-apps/version/get

Parameters

acp_name (str, optional) – ACP name

classmethod get_acp_metadata(acp_name: str, acp_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ACPMetadata

Get ACP Metadata

Permission Required: kelvin.permission.acp.read.

getACPMetadata: GET /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/get

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

classmethod get_acp_metrics(acp_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ACPMetrics

Get ACP Metrics

Permission Required: kelvin.permission.acp.read.

getACPMetrics: GET /api/v4/acps/{acp_name}/metrics/get

Parameters

acp_name (str, optional) – ACP name

classmethod get_acp_status(acp_name: str, source: Optional[str] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ACPStatus

Get ACP Status

Permission Required: kelvin.permission.acp.read.

getACPStatus: GET /api/v4/acps/{acp_name}/status/get

Parameters

  • acp_name (str, optional) – ACP name

  • source (str) – Source should be cache or live. Default: cache

classmethod get_acp_status_count(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ACPStatusCount

Get ACP Status Count

Permission Required: kelvin.permission.acp.read.

getACPStatusCount: GET /api/v4/acps/status/count/get

kelvin_info: Optional[Dict[str, Any]]
classmethod list_acp(names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, connected: Optional[bool] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ACP], kelvin.sdk.client.model.responses.ACPListPaginated]

List ACP

Pagination Sortable Columns: acp.name, acp.title, acp.created, acp.updated, status_state, status_last_seen

Permission Required: kelvin.permission.acp.read.

listACP: GET /api/v4/acps/list

Parameters

  • names (Sequence[str]) – Filter ACPs by name

  • search (Sequence[str]) – Search ACP by name or title

  • connected (bool) – Filter by connected ACPs. Possible Values: true/false. Default: none

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_acp_metadata(acp_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ACPMetaDataItem], kelvin.sdk.client.model.responses.ACPMetadataListPaginated]

List ACP Metadata

Pagination Sortable Columns: acp_metadata.name, acp_metadata.acp_name

Permission Required: kelvin.permission.acp.read.

listACPMetadata: GET /api/v4/acps/{acp_name}/metadata/list

Parameters

  • acp_name (str, optional) – ACP name

  • search (Sequence[str]) – Search ACP Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_acp_status(acp_names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, source: Optional[str] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.ACPStatus], kelvin.sdk.client.model.responses.ACPStatusListPaginated]

List ACP Status

Pagination Sortable Columns: acp.status

Permission Required: kelvin.permission.acp.read.

listACPStatus: GET /api/v4/acps/status/list

Parameters

  • acp_names (Sequence[str]) – Filter by ACP names

  • search (Sequence[str]) – Search ACPs by title and name

  • source (str) – Source should be cache or live. Default: cache

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

location: Optional[kelvin.sdk.client.model.responses.ACPLocationItem]
manifests_scrape_enabled: Optional[bool]
manifests_scrape_interval: Optional[int]
metadata: Optional[Dict[str, Any]]
metrics_enabled: Optional[bool]
metrics_scrape_interval: Optional[int]
name: Optional[str]
network_info: Optional[List[Dict[str, Any]]]
node_name: Optional[str]
schema: Any = None
status_scrape_enabled: Optional[bool]
status_scrape_interval: Optional[int]
system_info: Optional[Dict[str, Any]]
title: Optional[str]
classmethod update_acp(acp_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACP

Update ACP

Permission Required: kelvin.permission.acp.update.

updateACP: POST /api/v4/acps/{acp_name}/update

Parameters

  • acp_name (str, optional) – ACP name

  • data (requests.ACPUpdate, optional) –

  • **kwargs – Extra parameters for requests.ACPUpdate

classmethod update_acp_metadata(acp_name: str, acp_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPMetadata

Update ACP Metadata

Permission Required: kelvin.permission.acp.update.

updateACPMetadata: POST /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/update

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

  • data (requests.ACPMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ACPMetadataUpdate

classmethod update_acp_status(acp_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPStatusUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPStatus

Update ACP Status

Permission Required: kelvin.permission.acp.update.

updateACPStatus: POST /api/v4/acps/{acp_name}/status/update

Parameters

  • acp_name (str, optional) – ACP name

  • data (requests.ACPStatusUpdate, optional) –

  • **kwargs – Extra parameters for requests.ACPStatusUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.ACPAllocation(client: Optional[Client] = None, *, cpu_capacity: float = None, cpu_requests: float = None, memory_capacity: float = None, memory_requests: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPAllocation object.

Parameters

  • cpu_capacity (Optional[float]) –

  • cpu_requests (Optional[float]) –

  • memory_capacity (Optional[float]) –

  • memory_requests (Optional[float]) –

cpu_capacity: Optional[float]
cpu_requests: Optional[float]
fields: Any = None
memory_capacity: Optional[float]
memory_requests: Optional[float]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPCPUUtilization(client: Optional[Client] = None, *, timestamp: int = None, value: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPCPUUtilization object.

Parameters

  • timestamp (Optional[int]) –

  • value (Optional[float]) –

fields: Any = None
schema: Any = None
timestamp: Optional[int]
value: Optional[float]
class kelvin.sdk.client.model.responses.ACPDisk(client: Optional[Client] = None, *, total_bytes: float = None, used_bytes: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPDisk object.

Parameters

  • total_bytes (Optional[float]) –

  • used_bytes (Optional[float]) –

fields: Any = None
schema: Any = None
total_bytes: Optional[float]
used_bytes: Optional[float]
class kelvin.sdk.client.model.responses.ACPEdgeAppVersion(client: Optional[Client] = None, *, edge_app_version: str = None, has_updates: bool = None, platform_version: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPEdgeAppVersion object.

Parameters

  • edge_app_version (Optional[str]) –

  • has_updates (Optional[bool]) –

  • platform_version (Optional[str]) –

edge_app_version: Optional[str]
fields: Any = None
classmethod force_update_acp_edge_app_version(acp_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Force Update ACP Edge App Version

Permission Required: kelvin.permission.acp.read.

forceUpdateACPEdgeAppVersion: POST /api/v4/acps/{acp_name}/edge-apps/version/force-update

Parameters

acp_name (str, optional) – ACP name

classmethod get_acp_edge_app_version(acp_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ACPEdgeAppVersion

Get ACP Edge App Version

Permission Required: kelvin.permission.acp.read.

getACPEdgeAppVersion: GET /api/v4/acps/{acp_name}/edge-apps/version/get

Parameters

acp_name (str, optional) – ACP name

has_updates: Optional[bool]
platform_version: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPListPaginated(*, data: List[kelvin.sdk.client.model.responses.ACP] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ACPListPaginated object.

Parameters

  • data (Optional[List[ACP]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ACP]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPLocationItem(client: Optional[Client] = None, *, lat: float = None, lon: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPLocationItem object.

Parameters

  • lat (Optional[float]) –

  • lon (Optional[float]) –

fields: Any = None
lat: Optional[float]
lon: Optional[float]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPMemoryUsage(client: Optional[Client] = None, *, timestamp: int = None, value: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPMemoryUsage object.

Parameters

  • timestamp (Optional[int]) –

  • value (Optional[float]) –

fields: Any = None
schema: Any = None
timestamp: Optional[int]
value: Optional[float]
class kelvin.sdk.client.model.responses.ACPMetaDataItem(client: Optional[Client] = None, *, acp_name: str = None, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPMetaDataItem object.

Parameters

  • acp_name (Optional[str]) –

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

acp_name: Optional[str]
classmethod create_acp_metadata(acp_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPMetadata

Create ACP Metadata

Permission Required: kelvin.permission.acp.create.

createACPMetadata: POST /api/v4/acps/{acp_name}/metadata/create

Parameters

  • acp_name (str, optional) – ACP name

  • data (requests.ACPMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ACPMetadataCreate

created: Optional[datetime.datetime]
classmethod delete_acp_metadata(acp_name: str, acp_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete ACP Metadata

Permission Required: kelvin.permission.acp.delete.

deleteACPMetadata: POST /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/delete

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

fields: Any = None
classmethod get_acp_metadata(acp_name: str, acp_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ACPMetadata

Get ACP Metadata

Permission Required: kelvin.permission.acp.read.

getACPMetadata: GET /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/get

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

classmethod list_acp_metadata(acp_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ACPMetaDataItem], kelvin.sdk.client.model.responses.ACPMetadataListPaginated]

List ACP Metadata

Pagination Sortable Columns: acp_metadata.name, acp_metadata.acp_name

Permission Required: kelvin.permission.acp.read.

listACPMetadata: GET /api/v4/acps/{acp_name}/metadata/list

Parameters

  • acp_name (str, optional) – ACP name

  • search (Sequence[str]) – Search ACP Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_acp_metadata(acp_name: str, acp_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPMetadata

Update ACP Metadata

Permission Required: kelvin.permission.acp.update.

updateACPMetadata: POST /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/update

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

  • data (requests.ACPMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ACPMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.ACPMetadata(client: Optional[Client] = None, *, acp_name: str = None, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPMetadata object.

Parameters

  • acp_name (Optional[str]) –

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

acp_name: Optional[str]
classmethod create_acp_metadata(acp_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPMetadata

Create ACP Metadata

Permission Required: kelvin.permission.acp.create.

createACPMetadata: POST /api/v4/acps/{acp_name}/metadata/create

Parameters

  • acp_name (str, optional) – ACP name

  • data (requests.ACPMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ACPMetadataCreate

created: Optional[datetime.datetime]
classmethod delete_acp_metadata(acp_name: str, acp_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete ACP Metadata

Permission Required: kelvin.permission.acp.delete.

deleteACPMetadata: POST /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/delete

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

fields: Any = None
classmethod get_acp_metadata(acp_name: str, acp_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ACPMetadata

Get ACP Metadata

Permission Required: kelvin.permission.acp.read.

getACPMetadata: GET /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/get

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

classmethod list_acp_metadata(acp_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ACPMetaDataItem], kelvin.sdk.client.model.responses.ACPMetadataListPaginated]

List ACP Metadata

Pagination Sortable Columns: acp_metadata.name, acp_metadata.acp_name

Permission Required: kelvin.permission.acp.read.

listACPMetadata: GET /api/v4/acps/{acp_name}/metadata/list

Parameters

  • acp_name (str, optional) – ACP name

  • search (Sequence[str]) – Search ACP Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_acp_metadata(acp_name: str, acp_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPMetadata

Update ACP Metadata

Permission Required: kelvin.permission.acp.update.

updateACPMetadata: POST /api/v4/acps/{acp_name}/metadata/{acp_metadata_name}/update

Parameters

  • acp_name (str, optional) – ACP name

  • acp_metadata_name (str, optional) – ACP Metadata name

  • data (requests.ACPMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ACPMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.ACPMetadataListPaginated(*, data: List[kelvin.sdk.client.model.responses.ACPMetaDataItem] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ACPMetadataListPaginated object.

Parameters

  • data (Optional[List[ACPMetaDataItem]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ACPMetaDataItem]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPMetrics(client: Optional[Client] = None, *, allocation: kelvin.sdk.client.model.responses.ACPAllocation = None, cpu_utilization: List[kelvin.sdk.client.model.responses.ACPCPUUtilization] = None, disk: kelvin.sdk.client.model.responses.ACPDisk = None, memory_usage: List[kelvin.sdk.client.model.responses.ACPMemoryUsage] = None, network: kelvin.sdk.client.model.responses.ACPNetwork = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPMetrics object.

Parameters
allocation: Optional[kelvin.sdk.client.model.responses.ACPAllocation]
cpu_utilization: Optional[List[kelvin.sdk.client.model.responses.ACPCPUUtilization]]
disk: Optional[kelvin.sdk.client.model.responses.ACPDisk]
fields: Any = None
classmethod get_acp_metrics(acp_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ACPMetrics

Get ACP Metrics

Permission Required: kelvin.permission.acp.read.

getACPMetrics: GET /api/v4/acps/{acp_name}/metrics/get

Parameters

acp_name (str, optional) – ACP name

memory_usage: Optional[List[kelvin.sdk.client.model.responses.ACPMemoryUsage]]
network: Optional[kelvin.sdk.client.model.responses.ACPNetwork]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPNetwork(client: Optional[Client] = None, *, total_rx: float = None, total_tx: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPNetwork object.

Parameters

  • total_rx (Optional[float]) –

  • total_tx (Optional[float]) –

fields: Any = None
schema: Any = None
total_rx: Optional[float]
total_tx: Optional[float]
class kelvin.sdk.client.model.responses.ACPSettings(client: Optional[Client] = None, *, auto_update: kelvin.sdk.client.model.responses.ACPSettingsAutoUpdate = None, metrics: kelvin.sdk.client.model.responses.ACPSettingsMetrics = None, status: kelvin.sdk.client.model.responses.ACPSettingsStatus = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPSettings object.

Parameters
auto_update: Optional[kelvin.sdk.client.model.responses.ACPSettingsAutoUpdate]
fields: Any = None
metrics: Optional[kelvin.sdk.client.model.responses.ACPSettingsMetrics]
schema: Any = None
status: Optional[kelvin.sdk.client.model.responses.ACPSettingsStatus]
class kelvin.sdk.client.model.responses.ACPSettingsAutoUpdate(client: Optional[Client] = None, *, enabled: bool = None, interval: int = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPSettingsAutoUpdate object.

Parameters

  • enabled (Optional[bool]) –

  • interval (Optional[int]) –

enabled: Optional[bool]
fields: Any = None
interval: Optional[int]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPSettingsMetrics(client: Optional[Client] = None, *, enabled: bool = None, interval: int = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPSettingsMetrics object.

Parameters

  • enabled (Optional[bool]) –

  • interval (Optional[int]) –

enabled: Optional[bool]
fields: Any = None
interval: Optional[int]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPSettingsStatus(client: Optional[Client] = None, *, enabled: bool = None, interval: int = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPSettingsStatus object.

Parameters

  • enabled (Optional[bool]) –

  • interval (Optional[int]) –

enabled: Optional[bool]
fields: Any = None
interval: Optional[int]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPStatus(client: Optional[Client] = None, *, name: str = None, status: kelvin.sdk.client.model.responses.ACPStatusValues = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPStatus object.

Parameters
fields: Any = None
classmethod get_acp_status(acp_name: str, source: Optional[str] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ACPStatus

Get ACP Status

Permission Required: kelvin.permission.acp.read.

getACPStatus: GET /api/v4/acps/{acp_name}/status/get

Parameters

  • acp_name (str, optional) – ACP name

  • source (str) – Source should be cache or live. Default: cache

classmethod get_acp_status_count(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ACPStatusCount

Get ACP Status Count

Permission Required: kelvin.permission.acp.read.

getACPStatusCount: GET /api/v4/acps/status/count/get

classmethod list_acp_status(acp_names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, source: Optional[str] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.ACPStatus], kelvin.sdk.client.model.responses.ACPStatusListPaginated]

List ACP Status

Pagination Sortable Columns: acp.status

Permission Required: kelvin.permission.acp.read.

listACPStatus: GET /api/v4/acps/status/list

Parameters

  • acp_names (Sequence[str]) – Filter by ACP names

  • search (Sequence[str]) – Search ACPs by title and name

  • source (str) – Source should be cache or live. Default: cache

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
status: Optional[kelvin.sdk.client.model.responses.ACPStatusValues]
classmethod update_acp_status(acp_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ACPStatusUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ACPStatus

Update ACP Status

Permission Required: kelvin.permission.acp.update.

updateACPStatus: POST /api/v4/acps/{acp_name}/status/update

Parameters

  • acp_name (str, optional) – ACP name

  • data (requests.ACPStatusUpdate, optional) –

  • **kwargs – Extra parameters for requests.ACPStatusUpdate

class kelvin.sdk.client.model.responses.ACPStatusCount(client: Optional[Client] = None, *, offline: int = None, online: int = None, total: int = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPStatusCount object.

Parameters

  • offline (Optional[int]) –

  • online (Optional[int]) –

  • total (Optional[int]) –

fields: Any = None
classmethod get_acp_status_count(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ACPStatusCount

Get ACP Status Count

Permission Required: kelvin.permission.acp.read.

getACPStatusCount: GET /api/v4/acps/status/count/get

offline: Optional[int]
online: Optional[int]
schema: Any = None
total: Optional[int]
class kelvin.sdk.client.model.responses.ACPStatusListPaginated(*, data: List[kelvin.sdk.client.model.responses.ACPStatus] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ACPStatusListPaginated object.

Parameters

  • data (Optional[List[ACPStatus]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ACPStatus]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ACPStatusValues(client: Optional[Client] = None, *, last_seen: datetime.datetime = None, message: str = None, state: str = None, warnings: List[str] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ACPStatusValues object.

Parameters

  • last_seen (Optional[datetime]) –

  • message (Optional[str]) –

  • state (Optional[str]) –

  • warnings (Optional[List[str]]) –

fields: Any = None
last_seen: Optional[datetime.datetime]
message: Optional[str]
schema: Any = None
state: Optional[str]
warnings: Optional[List[str]]
class kelvin.sdk.client.model.responses.App(client: Optional[Client] = None, *, created: datetime.datetime = None, description: str = None, latest_version: str = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, type: str = None, updated: datetime.datetime = None, versions: List[kelvin.sdk.client.model.responses.AppVersion] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

App object.

Parameters

  • created (Optional[datetime]) –

  • description (Optional[str]) –

  • latest_version (Optional[str]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • type (Optional[str]) –

  • updated (Optional[datetime]) –

  • versions (Optional[List[AppVersion]]) –

classmethod create_app(data: Optional[Union[kelvin.sdk.client.model.requests.AppCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.App

Create App

Note: If the App already exists, the App Version will be appended to the existing App

Permission Required: kelvin.permission.appregistry.create.

createApp: POST /api/v4/appregistry/create

Parameters

  • data (requests.AppCreate, optional) –

  • **kwargs – Extra parameters for requests.AppCreate

created: Optional[datetime.datetime]
classmethod delete_app(app_name: str, dry_run: bool = False, client: Any = None) → None

Delete App

Note: Deleting an App will also delete all App Versions

Permission Required: kelvin.permission.appregistry.delete.

deleteApp: POST /api/v4/appregistry/{app_name}/delete

Parameters

app_name (str, optional) – App name

classmethod delete_app_version(app_name: str, app_version: str, dry_run: bool = False, client: Any = None) → None

Delete App Version

Note: This operation also deletes the associated Docker Image

Permission Required: kelvin.permission.appregistry.delete.

deleteAppVersion: POST /api/v4/appregistry/{app_name}/versions/{app_version}/delete

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

description: Optional[str]
classmethod download_app_version(app_name: str, app_version: str, dry_run: bool = False, client: Any = None) → None

Download App Version

Permission Required: kelvin.permission.appregistry.read.

downloadAppVersion: GET /api/v4/appregistry/{app_name}/versions/{app_version}/download

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

fields: Any = None
classmethod get_app(app_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.App

Get App

Permission Required: kelvin.permission.appregistry.read.

getApp: GET /api/v4/appregistry/{app_name}/get

Parameters

app_name (str, optional) – App name

classmethod get_app_version(app_name: str, app_version: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AppVersion

Get App Version

Permission Required: kelvin.permission.appregistry.read.

getAppVersion: GET /api/v4/appregistry/{app_name}/versions/{app_version}/get

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

classmethod get_app_version_status(app_name: str, app_version: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AppVersionStatus

Get App Version Status

Permission Required: kelvin.permission.appregistry.read.

getAppVersionStatus: GET /api/v4/appregistry/{app_name}/versions/{app_version}/status/get

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

latest_version: Optional[str]
classmethod list_app_version_status(app_versions: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AppVersionStatus], kelvin.sdk.client.model.responses.AppVersionStatusListPaginated]

List App Version Status

Pagination Sortable Columns: app_version.id

Permission Required: kelvin.permission.appregistry.read.

listAppVersionStatus: GET /api/v4/appregistry/versions/status/list

Parameters

  • app_versions (Sequence[str]) – Filter by App Versions. Pattern: <app_name>:<version>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_apps(type: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.App], kelvin.sdk.client.model.responses.AppListPaginated]

List Apps

Pagination Sortable Columns: app.name, app.title, app.type, app.latest_version, app.created, app.updated, status

Permission Required: kelvin.permission.appregistry.read.

listApps: GET /api/v4/appregistry/list

Parameters

  • type (Sequence[str]) – Match the type field

  • search (Sequence[str]) – Search Apps by name and title

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
title: Optional[str]
type: Optional[str]
classmethod update_app(app_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AppUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.App

Update App

Permission Required: kelvin.permission.appregistry.update.

updateApp: POST /api/v4/appregistry/{app_name}/update

Parameters

  • app_name (str, optional) – App name

  • data (requests.AppUpdate, optional) –

  • **kwargs – Extra parameters for requests.AppUpdate

updated: Optional[datetime.datetime]
classmethod upload_app_version(app_name: str, app_version: str, file: str, dry_run: bool = False, client: Any = None) → None

Upload App Version

Permission Required: kelvin.permission.appregistry.create.

uploadAppVersion: POST /api/v4/appregistry/{app_name}/versions/{app_version}/upload

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

  • file (str, optional) – File to upload

versions: Optional[List[kelvin.sdk.client.model.responses.AppVersion]]
class kelvin.sdk.client.model.responses.AppListPaginated(*, data: List[kelvin.sdk.client.model.responses.App] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AppListPaginated object.

Parameters

  • data (Optional[List[App]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.App]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.AppVersion(client: Optional[Client] = None, *, created: datetime.datetime = None, id: str = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, version: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AppVersion object.

Parameters

  • created (Optional[datetime]) –

  • id (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

  • version (Optional[str]) –

created: Optional[datetime.datetime]
classmethod delete_app_version(app_name: str, app_version: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete App Version

Note: This operation also deletes the associated Docker Image

Permission Required: kelvin.permission.appregistry.delete.

deleteAppVersion: POST /api/v4/appregistry/{app_name}/versions/{app_version}/delete

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

classmethod download_app_version(app_name: str, app_version: str, dry_run: bool = False, client: Optional[Any] = None) → None

Download App Version

Permission Required: kelvin.permission.appregistry.read.

downloadAppVersion: GET /api/v4/appregistry/{app_name}/versions/{app_version}/download

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

fields: Any = None
classmethod get_app_version(app_name: str, app_version: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AppVersion

Get App Version

Permission Required: kelvin.permission.appregistry.read.

getAppVersion: GET /api/v4/appregistry/{app_name}/versions/{app_version}/get

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

classmethod get_app_version_status(app_name: str, app_version: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AppVersionStatus

Get App Version Status

Permission Required: kelvin.permission.appregistry.read.

getAppVersionStatus: GET /api/v4/appregistry/{app_name}/versions/{app_version}/status/get

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

id: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
updated: Optional[datetime.datetime]
classmethod upload_app_version(app_name: str, app_version: str, file: str, dry_run: bool = False, client: Optional[Any] = None) → None

Upload App Version

Permission Required: kelvin.permission.appregistry.create.

uploadAppVersion: POST /api/v4/appregistry/{app_name}/versions/{app_version}/upload

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

  • file (str, optional) – File to upload

version: Optional[str]
class kelvin.sdk.client.model.responses.AppVersionStatus(client: Optional[Client] = None, *, build_log: str = None, id: str = None, name: str = None, status: str = None, version: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AppVersionStatus object.

Parameters

  • build_log (Optional[str]) –

  • id (Optional[str]) –

  • name (Optional[str]) –

  • status (Optional[str]) –

  • version (Optional[str]) –

build_log: Optional[str]
fields: Any = None
classmethod get_app_version_status(app_name: str, app_version: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AppVersionStatus

Get App Version Status

Permission Required: kelvin.permission.appregistry.read.

getAppVersionStatus: GET /api/v4/appregistry/{app_name}/versions/{app_version}/status/get

Parameters

  • app_name (str, optional) – App name

  • app_version (str, optional) – App Version

id: Optional[str]
classmethod list_app_version_status(app_versions: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.AppVersionStatus], kelvin.sdk.client.model.responses.AppVersionStatusListPaginated]

List App Version Status

Pagination Sortable Columns: app_version.id

Permission Required: kelvin.permission.appregistry.read.

listAppVersionStatus: GET /api/v4/appregistry/versions/status/list

Parameters

  • app_versions (Sequence[str]) – Filter by App Versions. Pattern: <app_name>:<version>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
status: Optional[str]
version: Optional[str]
class kelvin.sdk.client.model.responses.AppVersionStatusListPaginated(*, data: List[kelvin.sdk.client.model.responses.AppVersionStatus] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AppVersionStatusListPaginated object.

Parameters

  • data (Optional[List[AppVersionStatus]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.AppVersionStatus]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.Asset(client: Optional[Client] = None, *, asset_parent_name: str = None, asset_type_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, created: datetime.datetime = None, location: kelvin.sdk.client.model.responses.AssetLocationItem = None, metadata: Dict[str, Any] = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, path: str = None, status: kelvin.sdk.client.model.responses.AssetStatusItem = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Asset object.

Parameters

  • asset_parent_name (Optional[str]) –

  • asset_type_name (Optional[str]) –

  • created (Optional[datetime]) –

  • location (Optional[AssetLocationItem]) –

  • metadata (Optional[Dict[str, Any]]) –

  • name (Optional[str]) –

  • path (Optional[str]) –

  • status (Optional[AssetStatusItem]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

asset_parent_name: Optional[str]
asset_type_name: Optional[str]
classmethod create_asset(data: Optional[Union[kelvin.sdk.client.model.requests.AssetCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Asset

Create Asset

Permission Required: kelvin.permission.asset.create.

createAsset: POST /api/v4/assets/create

Parameters
classmethod create_asset_class(data: Optional[Union[kelvin.sdk.client.model.requests.AssetClassCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetClass

Create Asset Class

Permission Required: kelvin.permission.asset_class.create.

createAssetClass: POST /api/v4/assets/class/create

Parameters
classmethod create_asset_metadata(asset_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetMetadata

Create Asset Metadata

Permission Required: kelvin.permission.asset.create.

createAssetMetadata: POST /api/v4/assets/{asset_name}/metadata/create

Parameters

  • asset_name (str, optional) – Asset name

  • data (requests.AssetMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.AssetMetadataCreate

classmethod create_asset_property(asset_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetPropertyCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetProperty

Create Asset Property

Permission Required: kelvin.permission.asset.create.

createAssetProperty: POST /api/v4/assets/{asset_name}/properties/create

Parameters

  • asset_name (str, optional) – Asset name

  • data (requests.AssetPropertyCreate, optional) –

  • **kwargs – Extra parameters for requests.AssetPropertyCreate

classmethod create_asset_type(data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetType

Create Asset Type

Permission Required: kelvin.permission.asset_type.create.

createAssetType: POST /api/v4/assets/types/create

Parameters
classmethod create_asset_type_metadata(asset_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Create Asset Type Metadata

Permission Required: kelvin.permission.asset_type.create.

createAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_asset(asset_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset

Permission Required: kelvin.permission.asset.delete.

deleteAsset: POST /api/v4/assets/{asset_name}/delete

Parameters

asset_name (str, optional) – Asset name

classmethod delete_asset_class(asset_class_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete Asset Class

Permission Required: kelvin.permission.asset_class.delete.

deleteAssetClass: POST /api/v4/assets/class/{asset_class_name}/delete

Parameters

asset_class_name (str, optional) – Asset Class Name

classmethod delete_asset_metadata(asset_name: str, asset_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Metadata

Permission Required: kelvin.permission.asset.delete.

deleteAssetMetadata: POST /api/v4/assets/{asset_name}/metadata/{asset_metadata_name}/delete

Parameters

  • asset_name (str, optional) – Asset name

  • asset_metadata_name (str, optional) – Asset Metadata name

classmethod delete_asset_property(asset_name: str, asset_property_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Property

Permission Required: kelvin.permission.asset.delete.

deleteAssetProperty: POST /api/v4/assets/{asset_name}/properties/{asset_property_name}/delete

Parameters

  • asset_name (str, optional) – Asset name

  • asset_property_name (str, optional) – Asset Property name

classmethod delete_asset_type(asset_type_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Type

Permission Required: kelvin.permission.asset_type.delete.

deleteAssetType: POST /api/v4/assets/types/{asset_type_name}/delete

Parameters

asset_type_name (str, optional) – Asset Type name

classmethod delete_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Type Metadata

Permission Required: kelvin.permission.asset_type.delete.

deleteAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/delete

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

fields: Any = None
classmethod get_asset(asset_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.Asset

Get Asset

Permission Required: kelvin.permission.asset.read.

getAsset: GET /api/v4/assets/{asset_name}/get

Parameters

  • asset_name (str, optional) – Asset name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_asset_class(asset_class_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AssetClass

Get Asset Class

Permission Required: kelvin.permission.asset_class.read.

getAssetClass: GET /api/v4/assets/class/{asset_class_name}/get

Parameters

asset_class_name (str, optional) – Asset Class Name

classmethod get_asset_hierarchy(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AssetHierarchyList

Get Asset Hierarchy

Permission Required: kelvin.permission.asset.read.

getAssetHierarchy: GET /api/v4/assets/hierarchy/tree/get

classmethod get_asset_metadata(asset_name: str, asset_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetMetadata

Get Asset Metadata

Permission Required: kelvin.permission.asset.read.

getAssetMetadata: GET /api/v4/assets/{asset_name}/metadata/{asset_metadata_name}/get

Parameters

  • asset_name (str, optional) – Asset name

  • asset_metadata_name (str, optional) – Asset Metadata name

classmethod get_asset_property(asset_name: str, asset_property_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetProperty

Get Asset Property

Permission Required: kelvin.permission.asset.read.

getAssetProperty: GET /api/v4/assets/{asset_name}/properties/{asset_property_name}/get

Parameters

  • asset_name (str, optional) – Asset name

  • asset_property_name (str, optional) – Asset Property name

classmethod get_asset_status_count(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AssetStatusCount

Get Asset Status Count

Permission Required: kelvin.permission.asset.read.

getAssetStatusCount: GET /api/v4/assets/status/count/get

classmethod get_asset_type(asset_type_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetType

Get Asset Type

Permission Required: kelvin.permission.asset_type.read.

getAssetType: GET /api/v4/assets/types/{asset_type_name}/get

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Get Asset Type Metadata

Permission Required: kelvin.permission.asset_type.read.

getAssetTypeMetadata: GET /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/get

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

classmethod list_asset(search: Optional[Sequence[str]] = None, asset_type_name: Optional[Sequence[str]] = None, status_state: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.Asset], kelvin.sdk.client.model.responses.AssetListPaginated]

List Asset

Pagination Sortable Columns: asset.name, asset.title, asset.created, asset.updated, asset_type.name, asset_type.title, status_state, status_last_seen

Permission Required: kelvin.permission.asset.read.

listAsset: GET /api/v4/assets/list

Parameters

  • search (Sequence[str]) – Search assets by name or title

  • asset_type_name (Sequence[str]) – Filter assets by asset type

  • status_state (Sequence[str]) – Filter assets by status state [online, offline, partially_online, unknown]

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_asset_class(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetClass], kelvin.sdk.client.model.responses.AssetClassListPaginated]

List Asset Class

Pagination Sortable Columns: asset_class.name, asset_class.title, asset_class.created, asset_class.updated

Permission Required: kelvin.permission.asset_class.read.

listAssetClass: GET /api/v4/assets/class/list

Parameters

  • search (Sequence[str]) – Search Asset Class by name or title

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_asset_metadata(asset_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetMetadata], kelvin.sdk.client.model.responses.AssetMetadataListPaginated]

List Asset Metadata

Pagination Sortable Columns: asset_metadata.name, asset_metadata.title, asset_metadata.value, asset_metadata.created, asset_metadata.updated

Permission Required: kelvin.permission.asset.read.

listAssetMetadata: GET /api/v4/assets/{asset_name}/metadata/list

Parameters

  • asset_name (str, optional) – Asset name

  • search (Sequence[str]) – Search Asset Metadata by name, title or value

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_asset_property(asset_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetProperty], kelvin.sdk.client.model.responses.AssetPropertyListPaginated]

List Asset Property

Pagination Sortable Columns: asset_property.name, asset_property.title, asset_property.value, asset_property.created, asset_property.updated

Permission Required: kelvin.permission.asset.read.

listAssetProperty: GET /api/v4/assets/{asset_name}/properties/list

Parameters

  • asset_name (str, optional) – Asset name

  • search (Sequence[str]) – Search Asset Property by name, title or value

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_asset_type(search: Optional[Sequence[str]] = None, asset_class_name: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetType], kelvin.sdk.client.model.responses.AssetTypeListPaginated]

List Asset Type

Pagination Sortable Columns: asset_type.name, asset_type.title, asset_type.created, asset_type.updated, asset_class.name, asset_class.title

Permission Required: kelvin.permission.asset_type.read.

listAssetType: GET /api/v4/assets/types/list

Parameters

  • search (Sequence[str]) – Search asset type by name or title

  • asset_class_name (Sequence[str]) – Filter asset type by asset class

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_asset_type_metadata(asset_type_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetTypeMetadata], kelvin.sdk.client.model.responses.AssetTypeMetadataListPaginated]

List Asset Type Metadata

Pagination Sortable Columns: asset_type_metadata.name

Permission Required: kelvin.permission.asset_type.read.

listAssetTypeMetadata: GET /api/v4/assets/types/{asset_type_name}/metadata/list

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • search (Sequence[str]) – Search Asset Type Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_bridge_assets(bridge_name: str, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.Asset], kelvin.sdk.client.model.responses.AssetListPaginated]

List Bridge Assets

Pagination Sortable Columns: asset.name, asset.title, asset.created, asset.updated, asset_type.title

Permission Required: kelvin.permission.bridge.read.

listBridgeAssets: GET /api/v4/bridges/{bridge_name}/assets/list

Parameters

  • bridge_name (str, optional) – Bridge name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

location: Optional[kelvin.sdk.client.model.responses.AssetLocationItem]
metadata: Optional[Dict[str, Any]]
name: Optional[str]
path: Optional[str]
schema: Any = None
status: Optional[kelvin.sdk.client.model.responses.AssetStatusItem]
title: Optional[str]
classmethod update_asset(asset_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Asset

Update Asset

Permission Required: kelvin.permission.asset.update.

updateAsset: POST /api/v4/assets/{asset_name}/update

Parameters

  • asset_name (str, optional) – Asset name

  • data (requests.AssetUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetUpdate

classmethod update_asset_class(asset_class_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetClassUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetClass

Update Asset Class

Permission Required: kelvin.permission.asset_class.update.

updateAssetClass: POST /api/v4/assets/class/{asset_class_name}/update

Parameters

  • asset_class_name (str, optional) – Asset Class Name

  • data (requests.AssetClassUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetClassUpdate

classmethod update_asset_hierarchy(data: Optional[Union[kelvin.sdk.client.model.requests.AssetHierarchyList, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Update Asset Hierarchy

Permission Required: kelvin.permission.asset.create.

updateAssetHierarchy: POST /api/v4/assets/hierarchy/tree/update

Parameters
classmethod update_asset_metadata(asset_name: str, asset_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetMetadata

Update Asset Metadata

Permission Required: kelvin.permission.asset.update.

updateAssetMetadata: POST /api/v4/assets/{asset_name}/metadata/{asset_metadata_name}/update

Parameters

  • asset_name (str, optional) – Asset name

  • asset_metadata_name (str, optional) – Asset Metadata name

  • data (requests.AssetMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetMetadataUpdate

classmethod update_asset_property(asset_name: str, asset_property_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetPropertyUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetProperty

Update Asset Property

Permission Required: kelvin.permission.asset.update.

updateAssetProperty: POST /api/v4/assets/{asset_name}/properties/{asset_property_name}/update

Parameters

  • asset_name (str, optional) – Asset name

  • asset_property_name (str, optional) – Asset Property name

  • data (requests.AssetPropertyUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetPropertyUpdate

classmethod update_asset_type(asset_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetType

Update Asset Type

Permission Required: kelvin.permission.asset_type.update.

updateAssetType: POST /api/v4/assets/types/{asset_type_name}/update

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • data (requests.AssetTypeUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetTypeUpdate

classmethod update_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Update Asset Type Metadata

Permission Required: kelvin.permission.asset_type.update.

updateAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/update

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

  • data (requests.AssetTypeMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetTypeMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.AssetClass(client: Optional[Client] = None, *, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetClass object.

Parameters

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

classmethod create_asset_class(data: Optional[Union[kelvin.sdk.client.model.requests.AssetClassCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetClass

Create Asset Class

Permission Required: kelvin.permission.asset_class.create.

createAssetClass: POST /api/v4/assets/class/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_asset_class(asset_class_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Class

Permission Required: kelvin.permission.asset_class.delete.

deleteAssetClass: POST /api/v4/assets/class/{asset_class_name}/delete

Parameters

asset_class_name (str, optional) – Asset Class Name

fields: Any = None
classmethod get_asset_class(asset_class_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetClass

Get Asset Class

Permission Required: kelvin.permission.asset_class.read.

getAssetClass: GET /api/v4/assets/class/{asset_class_name}/get

Parameters

asset_class_name (str, optional) – Asset Class Name

classmethod list_asset_class(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetClass], kelvin.sdk.client.model.responses.AssetClassListPaginated]

List Asset Class

Pagination Sortable Columns: asset_class.name, asset_class.title, asset_class.created, asset_class.updated

Permission Required: kelvin.permission.asset_class.read.

listAssetClass: GET /api/v4/assets/class/list

Parameters

  • search (Sequence[str]) – Search Asset Class by name or title

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_asset_class(asset_class_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetClassUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetClass

Update Asset Class

Permission Required: kelvin.permission.asset_class.update.

updateAssetClass: POST /api/v4/assets/class/{asset_class_name}/update

Parameters

  • asset_class_name (str, optional) – Asset Class Name

  • data (requests.AssetClassUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetClassUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.AssetClassListPaginated(*, data: List[kelvin.sdk.client.model.responses.AssetClass] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AssetClassListPaginated object.

Parameters

  • data (Optional[List[AssetClass]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.AssetClass]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.AssetHierarchyItem(client: Optional[Client] = None, *, asset_type_name: str = None, children: Optional[List[AssetHierarchyItem]] = None, name: str = None, status: str = None, title: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetHierarchyItem object.

Parameters

  • asset_type_name (Optional[str]) –

  • children (Optional[List[AssetHierarchyItem]]) –

  • name (Optional[str]) –

  • status (Optional[str]) –

  • title (Optional[str]) –

asset_type_name: Optional[str]
children: Optional[List[kelvin.sdk.client.model.responses.AssetHierarchyItem]]
fields: Any = None
name: Optional[str]
schema: Any = None
status: Optional[str]
title: Optional[str]
class kelvin.sdk.client.model.responses.AssetHierarchyList(client: Optional[Client] = None, *, data: List[kelvin.sdk.client.model.responses.AssetHierarchyItem] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetHierarchyList object.

Parameters

data (Optional[List[AssetHierarchyItem]]) –

data: Optional[List[kelvin.sdk.client.model.responses.AssetHierarchyItem]]
fields: Any = None
classmethod get_asset_hierarchy(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AssetHierarchyList

Get Asset Hierarchy

Permission Required: kelvin.permission.asset.read.

getAssetHierarchy: GET /api/v4/assets/hierarchy/tree/get

schema: Any = None
classmethod update_asset_hierarchy(data: Optional[Union[kelvin.sdk.client.model.requests.AssetHierarchyList, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → None

Update Asset Hierarchy

Permission Required: kelvin.permission.asset.create.

updateAssetHierarchy: POST /api/v4/assets/hierarchy/tree/update

Parameters
class kelvin.sdk.client.model.responses.AssetListPaginated(*, data: List[kelvin.sdk.client.model.responses.Asset] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AssetListPaginated object.

Parameters

  • data (Optional[List[Asset]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.Asset]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.AssetLocationItem(client: Optional[Client] = None, *, lat: float = None, lon: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetLocationItem object.

Parameters

  • lat (Optional[float]) –

  • lon (Optional[float]) –

fields: Any = None
lat: Optional[float]
lon: Optional[float]
schema: Any = None
class kelvin.sdk.client.model.responses.AssetMetadata(client: Optional[Client] = None, *, asset_name: str = None, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetMetadata object.

Parameters

  • asset_name (Optional[str]) –

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

asset_name: Optional[str]
classmethod create_asset_metadata(asset_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetMetadata

Create Asset Metadata

Permission Required: kelvin.permission.asset.create.

createAssetMetadata: POST /api/v4/assets/{asset_name}/metadata/create

Parameters

  • asset_name (str, optional) – Asset name

  • data (requests.AssetMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.AssetMetadataCreate

created: Optional[datetime.datetime]
classmethod delete_asset_metadata(asset_name: str, asset_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Metadata

Permission Required: kelvin.permission.asset.delete.

deleteAssetMetadata: POST /api/v4/assets/{asset_name}/metadata/{asset_metadata_name}/delete

Parameters

  • asset_name (str, optional) – Asset name

  • asset_metadata_name (str, optional) – Asset Metadata name

fields: Any = None
classmethod get_asset_metadata(asset_name: str, asset_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetMetadata

Get Asset Metadata

Permission Required: kelvin.permission.asset.read.

getAssetMetadata: GET /api/v4/assets/{asset_name}/metadata/{asset_metadata_name}/get

Parameters

  • asset_name (str, optional) – Asset name

  • asset_metadata_name (str, optional) – Asset Metadata name

classmethod list_asset_metadata(asset_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetMetadata], kelvin.sdk.client.model.responses.AssetMetadataListPaginated]

List Asset Metadata

Pagination Sortable Columns: asset_metadata.name, asset_metadata.title, asset_metadata.value, asset_metadata.created, asset_metadata.updated

Permission Required: kelvin.permission.asset.read.

listAssetMetadata: GET /api/v4/assets/{asset_name}/metadata/list

Parameters

  • asset_name (str, optional) – Asset name

  • search (Sequence[str]) – Search Asset Metadata by name, title or value

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_asset_metadata(asset_name: str, asset_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetMetadata

Update Asset Metadata

Permission Required: kelvin.permission.asset.update.

updateAssetMetadata: POST /api/v4/assets/{asset_name}/metadata/{asset_metadata_name}/update

Parameters

  • asset_name (str, optional) – Asset name

  • asset_metadata_name (str, optional) – Asset Metadata name

  • data (requests.AssetMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.AssetMetadataListPaginated(*, data: List[kelvin.sdk.client.model.responses.AssetMetadata] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AssetMetadataListPaginated object.

Parameters

  • data (Optional[List[AssetMetadata]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.AssetMetadata]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.AssetProperty(client: Optional[Client] = None, *, asset_name: str = None, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: str = None, updated: datetime.datetime = None, value: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetProperty object.

Parameters

  • asset_name (Optional[str]) –

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

  • value (Optional[str]) –

asset_name: Optional[str]
classmethod create_asset_property(asset_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetPropertyCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetProperty

Create Asset Property

Permission Required: kelvin.permission.asset.create.

createAssetProperty: POST /api/v4/assets/{asset_name}/properties/create

Parameters

  • asset_name (str, optional) – Asset name

  • data (requests.AssetPropertyCreate, optional) –

  • **kwargs – Extra parameters for requests.AssetPropertyCreate

created: Optional[datetime.datetime]
classmethod delete_asset_property(asset_name: str, asset_property_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Property

Permission Required: kelvin.permission.asset.delete.

deleteAssetProperty: POST /api/v4/assets/{asset_name}/properties/{asset_property_name}/delete

Parameters

  • asset_name (str, optional) – Asset name

  • asset_property_name (str, optional) – Asset Property name

fields: Any = None
classmethod get_asset_property(asset_name: str, asset_property_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetProperty

Get Asset Property

Permission Required: kelvin.permission.asset.read.

getAssetProperty: GET /api/v4/assets/{asset_name}/properties/{asset_property_name}/get

Parameters

  • asset_name (str, optional) – Asset name

  • asset_property_name (str, optional) – Asset Property name

classmethod list_asset_property(asset_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetProperty], kelvin.sdk.client.model.responses.AssetPropertyListPaginated]

List Asset Property

Pagination Sortable Columns: asset_property.name, asset_property.title, asset_property.value, asset_property.created, asset_property.updated

Permission Required: kelvin.permission.asset.read.

listAssetProperty: GET /api/v4/assets/{asset_name}/properties/list

Parameters

  • asset_name (str, optional) – Asset name

  • search (Sequence[str]) – Search Asset Property by name, title or value

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_asset_property(asset_name: str, asset_property_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetPropertyUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetProperty

Update Asset Property

Permission Required: kelvin.permission.asset.update.

updateAssetProperty: POST /api/v4/assets/{asset_name}/properties/{asset_property_name}/update

Parameters

  • asset_name (str, optional) – Asset name

  • asset_property_name (str, optional) – Asset Property name

  • data (requests.AssetPropertyUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetPropertyUpdate

updated: Optional[datetime.datetime]
value: Optional[str]
class kelvin.sdk.client.model.responses.AssetPropertyListPaginated(*, data: List[kelvin.sdk.client.model.responses.AssetProperty] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AssetPropertyListPaginated object.

Parameters

  • data (Optional[List[AssetProperty]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.AssetProperty]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.AssetStatusCount(client: Optional[Client] = None, *, offline: int = None, online: int = None, partially_online: int = None, total: int = None, unknown: int = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetStatusCount object.

Parameters

  • offline (Optional[int]) –

  • online (Optional[int]) –

  • partially_online (Optional[int]) –

  • total (Optional[int]) –

  • unknown (Optional[int]) –

fields: Any = None
classmethod get_asset_status_count(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.AssetStatusCount

Get Asset Status Count

Permission Required: kelvin.permission.asset.read.

getAssetStatusCount: GET /api/v4/assets/status/count/get

offline: Optional[int]
online: Optional[int]
partially_online: Optional[int]
schema: Any = None
total: Optional[int]
unknown: Optional[int]
class kelvin.sdk.client.model.responses.AssetStatusItem(client: Optional[Client] = None, *, last_seen: datetime.datetime = None, state: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetStatusItem object.

Parameters

  • last_seen (Optional[datetime]) –

  • state (Optional[str]) –

fields: Any = None
last_seen: Optional[datetime.datetime]
schema: Any = None
state: Optional[str]
class kelvin.sdk.client.model.responses.AssetType(client: Optional[Client] = None, *, asset_class_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, created: datetime.datetime = None, metadata: Dict[str, Any] = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetType object.

Parameters

  • asset_class_name (Optional[str]) –

  • created (Optional[datetime]) –

  • metadata (Optional[Dict[str, Any]]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

asset_class_name: Optional[str]
classmethod create_asset_type(data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetType

Create Asset Type

Permission Required: kelvin.permission.asset_type.create.

createAssetType: POST /api/v4/assets/types/create

Parameters
classmethod create_asset_type_metadata(asset_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Create Asset Type Metadata

Permission Required: kelvin.permission.asset_type.create.

createAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_asset_type(asset_type_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Type

Permission Required: kelvin.permission.asset_type.delete.

deleteAssetType: POST /api/v4/assets/types/{asset_type_name}/delete

Parameters

asset_type_name (str, optional) – Asset Type name

classmethod delete_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Type Metadata

Permission Required: kelvin.permission.asset_type.delete.

deleteAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/delete

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

fields: Any = None
classmethod get_asset_type(asset_type_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetType

Get Asset Type

Permission Required: kelvin.permission.asset_type.read.

getAssetType: GET /api/v4/assets/types/{asset_type_name}/get

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Get Asset Type Metadata

Permission Required: kelvin.permission.asset_type.read.

getAssetTypeMetadata: GET /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/get

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

classmethod list_asset_type(search: Optional[Sequence[str]] = None, asset_class_name: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetType], kelvin.sdk.client.model.responses.AssetTypeListPaginated]

List Asset Type

Pagination Sortable Columns: asset_type.name, asset_type.title, asset_type.created, asset_type.updated, asset_class.name, asset_class.title

Permission Required: kelvin.permission.asset_type.read.

listAssetType: GET /api/v4/assets/types/list

Parameters

  • search (Sequence[str]) – Search asset type by name or title

  • asset_class_name (Sequence[str]) – Filter asset type by asset class

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_asset_type_metadata(asset_type_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetTypeMetadata], kelvin.sdk.client.model.responses.AssetTypeMetadataListPaginated]

List Asset Type Metadata

Pagination Sortable Columns: asset_type_metadata.name

Permission Required: kelvin.permission.asset_type.read.

listAssetTypeMetadata: GET /api/v4/assets/types/{asset_type_name}/metadata/list

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • search (Sequence[str]) – Search Asset Type Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metadata: Optional[Dict[str, Any]]
name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_asset_type(asset_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetType

Update Asset Type

Permission Required: kelvin.permission.asset_type.update.

updateAssetType: POST /api/v4/assets/types/{asset_type_name}/update

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • data (requests.AssetTypeUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetTypeUpdate

classmethod update_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Update Asset Type Metadata

Permission Required: kelvin.permission.asset_type.update.

updateAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/update

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

  • data (requests.AssetTypeMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetTypeMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.AssetTypeListPaginated(*, data: List[kelvin.sdk.client.model.responses.AssetType] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AssetTypeListPaginated object.

Parameters

  • data (Optional[List[AssetType]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.AssetType]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.AssetTypeMetadata(client: Optional[Client] = None, *, asset_type_name: str = None, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AssetTypeMetadata object.

Parameters

  • asset_type_name (Optional[str]) –

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

asset_type_name: Optional[str]
classmethod create_asset_type_metadata(asset_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Create Asset Type Metadata

Permission Required: kelvin.permission.asset_type.create.

createAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Asset Type Metadata

Permission Required: kelvin.permission.asset_type.delete.

deleteAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/delete

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

fields: Any = None
classmethod get_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Get Asset Type Metadata

Permission Required: kelvin.permission.asset_type.read.

getAssetTypeMetadata: GET /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/get

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

classmethod list_asset_type_metadata(asset_type_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AssetTypeMetadata], kelvin.sdk.client.model.responses.AssetTypeMetadataListPaginated]

List Asset Type Metadata

Pagination Sortable Columns: asset_type_metadata.name

Permission Required: kelvin.permission.asset_type.read.

listAssetTypeMetadata: GET /api/v4/assets/types/{asset_type_name}/metadata/list

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • search (Sequence[str]) – Search Asset Type Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_asset_type_metadata(asset_type_name: str, asset_type_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.AssetTypeMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.AssetTypeMetadata

Update Asset Type Metadata

Permission Required: kelvin.permission.asset_type.update.

updateAssetTypeMetadata: POST /api/v4/assets/types/{asset_type_name}/metadata/{asset_type_metadata_name}/update

Parameters

  • asset_type_name (str, optional) – Asset Type name

  • asset_type_metadata_name (str, optional) – Asset Type Metadata name

  • data (requests.AssetTypeMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.AssetTypeMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.AssetTypeMetadataListPaginated(*, data: List[kelvin.sdk.client.model.responses.AssetTypeMetadata] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AssetTypeMetadataListPaginated object.

Parameters

  • data (Optional[List[AssetTypeMetadata]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.AssetTypeMetadata]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.AuditLogger(client: Optional[Client] = None, *, action: str = None, created: datetime.datetime = None, id: int = None, identifier: str = None, meta: Dict[str, Any] = None, namespace: str = None, request_id: str = None, user_id: str = None, username: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

AuditLogger object.

Parameters

  • action (Optional[str]) –

  • created (Optional[datetime]) –

  • id (Optional[int]) –

  • identifier (Optional[str]) –

  • meta (Optional[Dict[str, Any]]) –

  • namespace (Optional[str]) –

  • request_id (Optional[str]) –

  • user_id (Optional[str]) –

  • username (Optional[str]) –

action: Optional[str]
created: Optional[datetime.datetime]
fields: Any = None
classmethod get_audit_log(audit_logger_id: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.AuditLogger

Get Audit Log

Permission Required: kelvin.permission.audit_log.read.

getAuditLog: GET /api/v4/instance/auditlog/{audit_logger_id}/get

Parameters

audit_logger_id (str, optional) – Audit Logger ID

id: Optional[int]
identifier: Optional[str]
classmethod list_audit_log(action: Optional[Sequence[str]] = None, user_id: Optional[Sequence[str]] = None, namespace: Optional[Sequence[str]] = None, identifier: Optional[Sequence[str]] = None, username: Optional[Sequence[str]] = None, request_id: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, from_date_time: Optional[datetime.datetime] = None, to_date_time: Optional[datetime.datetime] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.AuditLogger], kelvin.sdk.client.model.responses.AuditLoggerListPaginated]

List Audit Log

Pagination Sortable Columns: audit_log.id, audit_log.action, audit_log.username, audit_log.created, request_uri

Note: Both from_date_time and to_date_time support RFC3339 format with microseconds

Permission Required: kelvin.permission.audit_log.read.

listAuditLog: GET /api/v4/instance/auditlog/list

Parameters

  • action (Sequence[str]) – Filter by action

  • user_id (Sequence[str]) – Filter by user_id

  • namespace (Sequence[str]) – Filter by namespace

  • identifier (Sequence[str]) – Filter by identifier

  • username (Sequence[str]) – Filter by username

  • request_id (Sequence[str]) – Filter by request_id

  • search (Sequence[str]) – Search Audit Log by action, username or namespace

  • from_date_time (datetime) – Filter actions occurred at or after this date-time

  • to_date_time (datetime) – Filter actions occurred until or at this date-time

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: false

meta: Optional[Dict[str, Any]]
namespace: Optional[str]
request_id: Optional[str]
schema: Any = None
user_id: Optional[str]
username: Optional[str]
class kelvin.sdk.client.model.responses.AuditLoggerListPaginated(*, data: List[kelvin.sdk.client.model.responses.AuditLogger] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

AuditLoggerListPaginated object.

Parameters

  • data (Optional[List[AuditLogger]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.AuditLogger]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.Bridge(client: Optional[Client] = None, *, acp_name: str = None, created: datetime.datetime = None, name: str = None, payload: Dict[str, Any] = None, protocol: str = None, title: str = None, updated: datetime.datetime = None, workload_name: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Bridge object.

Parameters

  • acp_name (Optional[str]) –

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • protocol (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

  • workload_name (Optional[str]) –

acp_name: Optional[str]
created: Optional[datetime.datetime]
classmethod delete_bridge(bridge_name: str, dry_run: bool = False, client: Any = None) → None

Delete Bridge application

Permission Required: kelvin.permission.bridge.delete.

deleteBridge: POST /api/v4/bridges/{bridge_name}/delete

Parameters

bridge_name (str, optional) – Bridge name

classmethod deploy_bridge(data: Optional[Union[kelvin.sdk.client.model.requests.BridgeDeploy, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Bridge

Deploy Bridge App

Permission Required: kelvin.permission.bridge.create.

deployBridge: POST /api/v4/bridges/deploy

Parameters
fields: Any = None
classmethod get_bridge(bridge_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.Bridge

Get Bridge

Permission Required: kelvin.permission.bridge.read.

getBridge: GET /api/v4/bridges/{bridge_name}/get

Parameters

bridge_name (str, optional) – Bridge name

classmethod list_bridge(names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, acp_name: Optional[Sequence[str]] = None, protocol: Optional[Sequence[str]] = None, workload_name: Optional[Sequence[str]] = None, status_state: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.Bridge], kelvin.sdk.client.model.responses.BridgeListPaginated]

List Bridge

Pagination Sortable Columns: bridge.name, bridge.title, bridge.protocol, bridge.acp_name, bridge.workload_name, bridge.created, bridge.updated, status_state, status_last_seen

Permission Required: kelvin.permission.bridge.read.

listBridge: GET /api/v4/bridges/list

Parameters

  • names (Sequence[str]) – Filter bridges by name

  • search (Sequence[str]) – Search bridges by name or title

  • acp_name (Sequence[str]) – Filter bridges by acp_name

  • protocol (Sequence[str]) – Filter bridges by protocol

  • workload_name (Sequence[str]) – Filter bridges by workload_name

  • status_state (Sequence[str]) – Filter bridges by status state

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_bridge_assets(bridge_name: str, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.Asset], kelvin.sdk.client.model.responses.AssetListPaginated]

List Bridge Assets

Pagination Sortable Columns: asset.name, asset.title, asset.created, asset.updated, asset_type.title

Permission Required: kelvin.permission.bridge.read.

listBridgeAssets: GET /api/v4/bridges/{bridge_name}/assets/list

Parameters

  • bridge_name (str, optional) – Bridge name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_bridge_data_streams(bridge_name: str, asset_name: Optional[Sequence[str]] = None, metric_name: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.BridgeDataStreamItem], kelvin.sdk.client.model.responses.BridgeDataStreamListPaginated]

List Bridge Data Streams

Pagination Sortable Columns: bridge_metric_asset.asset_name, bridge_metric_asset.metric_name

Permission Required: kelvin.permission.bridge.read.

listBridgeDataStreams: GET /api/v4/bridges/{bridge_name}/datastreams/list

Parameters

  • bridge_name (str, optional) – Bridge name

  • asset_name (Sequence[str]) – Filter data stream by asset name

  • metric_name (Sequence[str]) – Filter data stream by metric name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_bridge_metrics(bridge_name: str, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.Metric], kelvin.sdk.client.model.responses.MetricListPaginated]

List Bridge Metrics

Pagination Sortable Columns: metric.name, metric.title, metric.created, metric.updated, metric.data_type_name

Permission Required: kelvin.permission.bridge.read.

listBridgeMetrics: GET /api/v4/bridges/{bridge_name}/metrics/list

Parameters

  • bridge_name (str, optional) – Bridge name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
protocol: Optional[str]
schema: Any = None
classmethod start_bridge(bridge_name: str, dry_run: bool = False, client: Any = None) → None

Start Bridge application

Permission Required: kelvin.permission.bridge.update.

startBridge: GET /api/v4/bridges/{bridge_name}/start

Parameters

bridge_name (str, optional) – Bridge name

classmethod stop_bridge(bridge_name: str, dry_run: bool = False, client: Any = None) → None

Stop Bridge application

Permission Required: kelvin.permission.bridge.update.

stopBridge: GET /api/v4/bridges/{bridge_name}/stop

Parameters

bridge_name (str, optional) – Bridge name

title: Optional[str]
updated: Optional[datetime.datetime]
workload_name: Optional[str]
class kelvin.sdk.client.model.responses.BridgeDataStreamItem(client: Optional[Client] = None, *, asset_name: str = None, metric_name: str = None, payload: Dict[str, Any] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

BridgeDataStreamItem object.

Parameters

  • asset_name (Optional[str]) –

  • metric_name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

asset_name: Optional[str]
fields: Any = None
classmethod list_bridge_data_streams(bridge_name: str, asset_name: Optional[Sequence[str]] = None, metric_name: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.BridgeDataStreamItem], kelvin.sdk.client.model.responses.BridgeDataStreamListPaginated]

List Bridge Data Streams

Pagination Sortable Columns: bridge_metric_asset.asset_name, bridge_metric_asset.metric_name

Permission Required: kelvin.permission.bridge.read.

listBridgeDataStreams: GET /api/v4/bridges/{bridge_name}/datastreams/list

Parameters

  • bridge_name (str, optional) – Bridge name

  • asset_name (Sequence[str]) – Filter data stream by asset name

  • metric_name (Sequence[str]) – Filter data stream by metric name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metric_name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
class kelvin.sdk.client.model.responses.BridgeDataStreamListPaginated(*, data: List[kelvin.sdk.client.model.responses.BridgeDataStreamItem] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

BridgeDataStreamListPaginated object.

Parameters
data: Optional[List[kelvin.sdk.client.model.responses.BridgeDataStreamItem]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.BridgeListPaginated(*, data: List[kelvin.sdk.client.model.responses.Bridge] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

BridgeListPaginated object.

Parameters

  • data (Optional[List[Bridge]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.Bridge]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.Cluster(client: Optional[Client] = None, *, cidr: kelvin.sdk.client.model.responses.ClusterCIDR = None, created: datetime.datetime = None, info: Dict[str, Any] = None, kelvin_info: Dict[str, Any] = None, kubeconfig: str = None, name: str = None, network_info: Dict[str, Any] = None, ready: bool = None, system_info: Dict[str, Any] = None, title: str = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Cluster object.

Parameters

  • cidr (Optional[ClusterCIDR]) –

  • created (Optional[datetime]) –

  • info (Optional[Dict[str, Any]]) –

  • kelvin_info (Optional[Dict[str, Any]]) –

  • kubeconfig (Optional[str]) –

  • name (Optional[str]) –

  • network_info (Optional[Dict[str, Any]]) –

  • ready (Optional[bool]) –

  • system_info (Optional[Dict[str, Any]]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

cidr: Optional[kelvin.sdk.client.model.responses.ClusterCIDR]
classmethod create_cluster(data: Optional[Union[kelvin.sdk.client.model.requests.ClusterCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Cluster

Create Cluster

Permission Required: kelvin.permission.acp.create.

createCluster: POST /api/v4/orchestration/clusters/create

Parameters
created: Optional[datetime.datetime]
classmethod download_cluster_private_registry_credentials(cluster_name: str, dry_run: bool = False, client: Any = None) → None

Download Cluster Private Registry Credentials

Permission Required: kelvin.permission.acp.read.

downloadClusterPrivateRegistryCredentials: GET /api/v4/orchestration/clusters/{cluster_name}/private-registry/download

Parameters

cluster_name (str, optional) – Cluster name

classmethod download_cluster_provision_binary(dry_run: bool = False, client: Optional[Any] = None) → Iterator[bytes]

Download Cluster Provision Binary

Permission Required: kelvin.permission.orchestration.read.

downloadClusterProvisionBinary: GET /api/v4/orchestration/clusters/provision/bin/download

classmethod download_cluster_provision_script(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.OrchestrationProvision

Download Cluster Provision Script

Permission Required: kelvin.permission.orchestration.read.

downloadClusterProvisionScript: GET /api/v4/orchestration/clusters/provision/script/download

fields: Any = None
classmethod get_cluster(cluster_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.Cluster

Get Cluster

Permission Required: kelvin.permission.acp.read.

getCluster: GET /api/v4/orchestration/clusters/{cluster_name}/get

Parameters

cluster_name (str, optional) – Cluster name

classmethod get_cluster_manifests(cluster_name: str, version: Optional[str] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ClusterManifestList

Get Cluster Manifests

Permission Required: kelvin.permission.acp.read.

getClusterManifests: GET /api/v4/orchestration/clusters/{cluster_name}/manifests/get

Parameters

  • cluster_name (str, optional) – Cluster name

  • version (str) – Current Version

info: Optional[Dict[str, Any]]
kelvin_info: Optional[Dict[str, Any]]
kubeconfig: Optional[str]
classmethod list_cluster(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.Cluster], kelvin.sdk.client.model.responses.ClusterListPaginated]

List Cluster

Pagination Sortable Columns: cluster.name

Permission Required: kelvin.permission.acp.read.

listCluster: GET /api/v4/orchestration/clusters/list

Parameters

  • search (Sequence[str]) – Search Cluster by name or title

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
network_info: Optional[Dict[str, Any]]
ready: Optional[bool]
schema: Any = None
system_info: Optional[Dict[str, Any]]
title: Optional[str]
classmethod update_cluster(cluster_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ClusterUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Cluster

Update Cluster

Permission Required: kelvin.permission.acp.update.

updateCluster: POST /api/v4/orchestration/clusters/{cluster_name}/update

Parameters

  • cluster_name (str, optional) – Cluster name

  • data (requests.ClusterUpdate, optional) –

  • **kwargs – Extra parameters for requests.ClusterUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.ClusterCIDR(client: Optional[Client] = None, *, pod_cidr: str = None, service_cidr: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ClusterCIDR object.

Parameters

  • pod_cidr (Optional[str]) –

  • service_cidr (Optional[str]) –

fields: Any = None
pod_cidr: Optional[str]
schema: Any = None
service_cidr: Optional[str]
class kelvin.sdk.client.model.responses.ClusterCIDRItem(client: Optional[Client] = None, *, cluster_name: str = None, created: datetime.datetime = None, kube_pod_cidr: str = None, kube_service_cidr: str = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ClusterCIDRItem object.

Parameters

  • cluster_name (Optional[str]) –

  • created (Optional[datetime]) –

  • kube_pod_cidr (Optional[str]) –

  • kube_service_cidr (Optional[str]) –

  • updated (Optional[datetime]) –

cluster_name: Optional[str]
created: Optional[datetime.datetime]
fields: Any = None
kube_pod_cidr: Optional[str]
kube_service_cidr: Optional[str]
classmethod list_cluster_cidr(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.ClusterCIDRItem], kelvin.sdk.client.model.responses.ClusterCIDRListPaginated]

List Cluster CIDR

Pagination Sortable Columns: cidr.kube_pod_cidr, cidr.kube_service_cidr

Permission Required: kelvin.permission.acp.read.

listClusterCIDR: GET /api/v4/orchestration/cidr/list

Parameters

  • search (Sequence[str]) – Search CIDR by Kubernetes Pod IP, Kubernetes Service IP or Cluster Name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

schema: Any = None
updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.ClusterCIDRListPaginated(*, data: List[kelvin.sdk.client.model.responses.ClusterCIDRItem] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ClusterCIDRListPaginated object.

Parameters

  • data (Optional[List[ClusterCIDRItem]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ClusterCIDRItem]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ClusterListPaginated(*, data: List[kelvin.sdk.client.model.responses.Cluster] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ClusterListPaginated object.

Parameters

  • data (Optional[List[Cluster]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.Cluster]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ClusterManifestItem(client: Optional[Client] = None, *, content: str = None, file_name: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ClusterManifestItem object.

Parameters

  • content (Optional[str]) –

  • file_name (Optional[str]) –

content: Optional[str]
fields: Any = None
file_name: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.ClusterManifestList(client: Optional[Client] = None, *, manifests: List[kelvin.sdk.client.model.responses.ClusterManifestItem] = None, revision: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ClusterManifestList object.

Parameters
fields: Any = None
classmethod get_cluster_manifests(cluster_name: str, version: Optional[str] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ClusterManifestList

Get Cluster Manifests

Permission Required: kelvin.permission.acp.read.

getClusterManifests: GET /api/v4/orchestration/clusters/{cluster_name}/manifests/get

Parameters

  • cluster_name (str, optional) – Cluster name

  • version (str) – Current Version

manifests: Optional[List[kelvin.sdk.client.model.responses.ClusterManifestItem]]
revision: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.ComponentStatus(client: Optional[Client] = None, *, name: str = None, status: bool = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ComponentStatus object.

Parameters

  • name (Optional[str]) –

  • status (Optional[bool]) –

fields: Any = None
name: Optional[str]
schema: Any = None
status: Optional[bool]
class kelvin.sdk.client.model.responses.DataLabel(client: Optional[Client] = None, *, confidence: int = None, created: datetime.datetime = None, description: str = None, end_date: datetime.datetime = None, id: int = None, info: Dict[str, Any] = None, label_name: str = None, metrics: List[kelvin.sdk.client.model.responses.DataLabelMetricItem] = None, source: kelvin.sdk.client.model.responses.DataLabelSource = None, start_date: datetime.datetime = None, updated: datetime.datetime = None, validation: bool = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

DataLabel object.

Parameters

  • confidence (Optional[int]) –

  • created (Optional[datetime]) –

  • description (Optional[str]) –

  • end_date (Optional[datetime]) –

  • id (Optional[int]) –

  • info (Optional[Dict[str, Any]]) –

  • label_name (Optional[str]) –

  • metrics (Optional[List[DataLabelMetricItem]]) –

  • source (Optional[DataLabelSource]) –

  • start_date (Optional[datetime]) –

  • updated (Optional[datetime]) –

  • validation (Optional[bool]) –

confidence: Optional[int]
classmethod create_data_label(data: Optional[Union[kelvin.sdk.client.model.requests.DataLabelCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.DataLabel

Create Data Label

Note: * If label_name is provided and does not exist, it will create a new label * The source.type can be workload or user

Permission Required: kelvin.permission.data_label.create.

createDataLabel: POST /api/v4/datalabels/create

Parameters
classmethod create_label(data: Optional[Union[kelvin.sdk.client.model.requests.LabelCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Label

Create Label

Permission Required: kelvin.permission.data_label.create.

createLabel: POST /api/v4/datalabels/labels/create

Parameters
classmethod create_label_metadata(label_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.LabelMetadata

Create Label Metadata

Permission Required: kelvin.permission.data_label.create.

createLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/create

Parameters

  • label_name (str, optional) – Label name

  • data (requests.LabelMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.LabelMetadataCreate

classmethod create_label_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create Label Metadata Bulk

Permission Required: kelvin.permission.data_label.create.

createLabelMetadataBulk: POST /api/v4/datalabels/labels/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_data_label(datalabel_id: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete Data Label

Permission Required: kelvin.permission.data_label.delete.

deleteDataLabel: POST /api/v4/datalabels/{datalabel_id}/delete

Parameters

datalabel_id (str, optional) – Data Label id

classmethod delete_label(label_name: str, dry_run: bool = False, client: Any = None) → None

Delete Label

Permission Required: kelvin.permission.data_label.delete.

deleteLabel: POST /api/v4/datalabels/labels/{label_name}/delete

Parameters

label_name (str, optional) – Label name

classmethod delete_label_metadata(label_name: str, label_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Label Metadata

Permission Required: kelvin.permission.data_label.delete.

deleteLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/delete

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

classmethod delete_label_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete Label Metadata Bulk

Permission Required: kelvin.permission.data_label.delete.

deleteLabelMetadataBulk: POST /api/v4/datalabels/labels/metadata/delete

Parameters
description: Optional[str]
end_date: Optional[datetime.datetime]
fields: Any = None
classmethod filter_data_label(page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, data: Optional[Union[kelvin.sdk.client.model.requests.DataLabelFilter, Mapping[str, Any]]] = None, fetch: bool = True, dry_run: bool = False, client: Any = None, **kwargs: Any) → Union[Sequence[kelvin.sdk.client.model.responses.DataLabel], kelvin.sdk.client.model.responses.DataLabelListPaginated]

Filter Data Label

Pagination Sortable Columns: data_label.id

Permission Required: kelvin.permission.data_label.read.

filterDataLabel: POST /api/v4/datalabels/filter

Parameters

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: false

  • data (requests.DataLabelFilter, optional) –

  • **kwargs – Extra parameters for requests.DataLabelFilter

classmethod get_data_label(datalabel_id: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.DataLabel

Get Data Label

Permission Required: kelvin.permission.data_label.read.

getDataLabel: GET /api/v4/datalabels/{datalabel_id}/get

Parameters

datalabel_id (str, optional) – Data Label id

classmethod get_data_label_range(data: Optional[Union[kelvin.sdk.client.model.requests.DataLabelRange, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → Iterator[kelvin.sdk.client.model.responses.DataLabel]

Get Data Label Range

Note: * Between filters a AND*+ operator is implicit * `label_names`: lists data labels using **OR operator; * metrics: lists data labels using OR operator; * start_date: lists data labels with start_date >= query date (RFC3339 format with microseconds); * end_date: lists data labels with end_date <= query date (RFC3339 format with microseconds)

Permission Required: kelvin.permission.data_label.read.

getDataLabelRange: POST /api/v4/datalabels/range/get

Parameters
classmethod get_data_labels_clustering(data: Optional[Union[kelvin.sdk.client.model.requests.DataLabelCluster, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.DataLabelCluster

Get Data Labels Clustering

Note: * time_bucket: needed to aggregate a cluster. Use Go parsing for duration: https://golang.org/pkg/time/#ParseDuration * label_names: lists data labels using OR operator; * metrics: lists data labels using OR operator; * start_date: lists data labels with start_date >= query date (RFC3339 format with microseconds); * end_date: lists data labels with end_date <= query date (RFC3339 format with microseconds)

Permission Required: kelvin.permission.data_label.read.

getDataLabelsClustering: POST /api/v4/datalabels/clustering/get

Parameters
classmethod get_label(label_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.Label

Get Label

Permission Required: kelvin.permission.data_label.read.

getLabel: GET /api/v4/datalabels/labels/{label_name}/get

Parameters

  • label_name (str, optional) – Label name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_label_metadata(label_name: str, label_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.LabelMetadata

Get Label Metadata

Permission Required: kelvin.permission.data_label.read.

getLabelMetadata: GET /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/get

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

id: Optional[int]
info: Optional[Dict[str, Any]]
label_name: Optional[str]
classmethod list_data_label(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.DataLabel], kelvin.sdk.client.model.responses.DataLabelListPaginated]

List Data Label

Pagination Sortable Columns: data_label.id

Permission Required: kelvin.permission.data_label.read.

listDataLabel: GET /api/v4/datalabels/list

Parameters

  • search (Sequence[str]) – Search datalabels by description and label name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: false

classmethod list_label(names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.Label], kelvin.sdk.client.model.responses.LabelListPaginated]

List Label

Pagination Sortable Columns: label.name

Permission Required: kelvin.permission.data_label.read.

listLabel: GET /api/v4/datalabels/labels/list

Parameters

  • names (Sequence[str]) – Filter labels by name

  • search (Sequence[str]) – Search Labels by name or title

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_label_metadata(label_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.LabelMetadata], kelvin.sdk.client.model.responses.LabelMetadataListPaginated]

List Label Metadata

Pagination Sortable Columns: label_metadata.name, label_metadata.label_name

Permission Required: kelvin.permission.data_label.read.

listLabelMetadata: GET /api/v4/datalabels/labels/{label_name}/metadata/list

Parameters

  • label_name (str, optional) – Label name

  • search (Sequence[str]) – Search Label Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metrics: Optional[List[kelvin.sdk.client.model.responses.DataLabelMetricItem]]
schema: Any = None
source: Optional[kelvin.sdk.client.model.responses.DataLabelSource]
start_date: Optional[datetime.datetime]
classmethod update_data_label(datalabel_id: str, data: Optional[Union[kelvin.sdk.client.model.requests.DataLabelCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.DataLabel

Update Data Label

Note: * If metrics are provided, it will replace the full list * If label_name is provided and does not exist, it will create a new label

Permission Required: kelvin.permission.data_label.update.

updateDataLabel: POST /api/v4/datalabels/{datalabel_id}/update

Parameters

  • datalabel_id (str, optional) – DataLabel id

  • data (requests.DataLabelCreate, optional) –

  • **kwargs – Extra parameters for requests.DataLabelCreate

classmethod update_label(label_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Label

Update Label

Permission Required: kelvin.permission.data_label.update.

updateLabel: POST /api/v4/datalabels/labels/{label_name}/update

Parameters

  • label_name (str, optional) – Label name

  • data (requests.LabelUpdate, optional) –

  • **kwargs – Extra parameters for requests.LabelUpdate

classmethod update_label_metadata(label_name: str, label_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.LabelMetadata

Update Label Metadata

Permission Required: kelvin.permission.data_label.update.

updateLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/update

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

  • data (requests.LabelMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.LabelMetadataUpdate

updated: Optional[datetime.datetime]
validation: Optional[bool]
class kelvin.sdk.client.model.responses.DataLabelCluster(client: Optional[Client] = None, *, count: int = None, end_date: datetime.datetime = None, label_names: List[str] = None, start_date: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

DataLabelCluster object.

Parameters

  • count (Optional[int]) –

  • end_date (Optional[datetime]) –

  • label_names (Optional[List[str]]) –

  • start_date (Optional[datetime]) –

count: Optional[int]
end_date: Optional[datetime.datetime]
fields: Any = None
classmethod get_data_labels_clustering(data: Optional[Union[kelvin.sdk.client.model.requests.DataLabelCluster, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.DataLabelCluster

Get Data Labels Clustering

Note: * time_bucket: needed to aggregate a cluster. Use Go parsing for duration: https://golang.org/pkg/time/#ParseDuration * label_names: lists data labels using OR operator; * metrics: lists data labels using OR operator; * start_date: lists data labels with start_date >= query date (RFC3339 format with microseconds); * end_date: lists data labels with end_date <= query date (RFC3339 format with microseconds)

Permission Required: kelvin.permission.data_label.read.

getDataLabelsClustering: POST /api/v4/datalabels/clustering/get

Parameters
label_names: Optional[List[str]]
schema: Any = None
start_date: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.DataLabelListPaginated(*, data: List[kelvin.sdk.client.model.responses.DataLabel] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

DataLabelListPaginated object.

Parameters

  • data (Optional[List[DataLabel]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.DataLabel]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.DataLabelMetricItem(client: Optional[Client] = None, *, asset_name: str = None, name: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

DataLabelMetricItem object.

Parameters

  • asset_name (Optional[str]) –

  • name (Optional[str]) –

asset_name: Optional[str]
fields: Any = None
name: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.DataLabelSource(client: Optional[Client] = None, *, info: Dict[str, Any] = None, type: kelvin.sdk.client.model.responses.Type = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

DataLabelSource object.

Parameters

  • info (Optional[Dict[str, Any]]) –

  • type (Optional[Type]) –

fields: Any = None
info: Optional[Dict[str, Any]]
schema: Any = None
type: Optional[kelvin.sdk.client.model.responses.Type]
class kelvin.sdk.client.model.responses.DataType(client: Optional[Client] = None, *, connect: bool = None, created: datetime.datetime = None, icd: kelvin.sdk.client.model.responses.ICDPayload = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, schema: Dict[str, Any] = None, source: str = None, type: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, version: kelvin.sdk.client.data_model.ConstrainedStrValue = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

DataType object.

Parameters

  • connect (Optional[bool]) –

  • created (Optional[datetime]) –

  • icd (Optional[ICDPayload]) –

  • name (Optional[str]) –

  • schema (Optional[Dict[str, Any]]) –

  • source (Optional[str]) –

  • type (Optional[str]) –

  • updated (Optional[datetime]) –

  • version (Optional[str]) –

connect: Optional[bool]
classmethod create_data_type(data: Optional[Union[kelvin.sdk.client.model.requests.DataTypeCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.DataType

Create Data Type Regex validators: - data type name: ^([a-z][a-z0-9_]+.)+[a-z][a-z0-9_]+$ - data type class_name: ^[a-zA-Z][a-zA-Z0-9_]+$

Permission Required: kelvin.permission.data_type.create.

createDataType: POST /api/v4/datatypes/create

Parameters
created: Optional[datetime.datetime]
fields: Any = None
classmethod get_data_type(data_type_name: str, data_type_version: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.DataType

Get Data Type

Permission Required: kelvin.permission.data_type.read.

getDataType: GET /api/v4/datatypes/{data_type_name}/versions/{data_type_version}/get

Parameters

  • data_type_name (str, optional) – Data Type name

  • data_type_version (str, optional) – Data Type version

classmethod get_data_type_dependencies(data_type_name: str, data_type_version: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.DataType

Get Data Type Dependencies. This endpoint ill return all dependencies levels in a flattened array.

Permission Required: kelvin.permission.data_type.read.

getDataTypeDependencies: GET /api/v4/datatypes/{data_type_name}/versions/{data_type_version}/dependencies/get

Parameters

  • data_type_name (str, optional) – Data Type name

  • data_type_version (str, optional) – Data Type version

classmethod get_data_type_latest_version(data_type_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.DataType

Get Data Type Latest Version

Permission Required: kelvin.permission.data_type.read.

getDataTypeLatestVersion: GET /api/v4/datatypes/{data_type_name}/versions/latest/get

Parameters

data_type_name (str, optional) – Data Type name

classmethod get_data_type_schema(data_type_name: str, data_type_version: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.DataTypeSchema

Get Data Type Schema

Permission Required: kelvin.permission.data_type.read.

getDataTypeSchema: GET /api/v4/datatypes/{data_type_name}/versions/{data_type_version}/schema/get

Parameters

  • data_type_name (str, optional) – Data Type name

  • data_type_version (str, optional) – Data Type version

icd: Optional[kelvin.sdk.client.model.responses.ICDPayload]
classmethod list_data_type(search: Optional[Sequence[str]] = None, all: Optional[bool] = None, connect: Optional[bool] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.DataType], kelvin.sdk.client.model.responses.DataTypeListPaginated]

List Data Type

Pagination Sortable Columns: data_type.name, data_type.version By default returns only the latest versions for each data type

Permission Required: kelvin.permission.data_type.read.

listDataType: GET /api/v4/datatypes/list

Parameters

  • search (Sequence[str]) – Search data types by name

  • all (bool) – List all versions of all data types. If false, it will only list the latest version. Default: False.

  • connect (bool) – Only fetch connect data types. Default: False.

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
schema_: Optional[Dict[str, Any]]
source: Optional[str]
type: Optional[str]
updated: Optional[datetime.datetime]
version: Optional[str]
class kelvin.sdk.client.model.responses.DataTypeListPaginated(*, data: List[kelvin.sdk.client.model.responses.DataType] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

DataTypeListPaginated object.

Parameters

  • data (Optional[List[DataType]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.DataType]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.DataTypeSchema(client: Optional[Client] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

DataTypeSchema object.

class Config

Bases: kelvin.sdk.client.data_model.DataModel.Config

extra = 'allow'
fields: Any = None
classmethod get_data_type_schema(data_type_name: str, data_type_version: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.DataTypeSchema

Get Data Type Schema

Permission Required: kelvin.permission.data_type.read.

getDataTypeSchema: GET /api/v4/datatypes/{data_type_name}/versions/{data_type_version}/schema/get

Parameters

  • data_type_name (str, optional) – Data Type name

  • data_type_version (str, optional) – Data Type version

schema: Any = None
class kelvin.sdk.client.model.responses.Dependencies(client: Optional[Client] = None, *, data: List[kelvin.sdk.client.model.responses.Dependency] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Dependencies object.

Parameters

data (Optional[List[Dependency]]) –

data: Optional[List[kelvin.sdk.client.model.responses.Dependency]]
fields: Any = None
classmethod get_dependencies(data: Optional[Union[kelvin.sdk.client.model.requests.GraphDependencies, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Dependencies

Get Dependencies

Permission Required: kelvin.permission.instance.read.

getDependencies: GET /api/v4/instance/graph/dependencies/get

Parameters
schema: Any = None
class kelvin.sdk.client.model.responses.Dependency(client: Optional[Client] = None, *, collection: str = None, name: str = None, title: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Dependency object.

Parameters

  • collection (Optional[str]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

collection: Optional[str]
fields: Any = None
name: Optional[str]
schema: Any = None
title: Optional[str]
class kelvin.sdk.client.model.responses.ErrorMessage(client: Optional[Client] = None, *, error_code: int = None, http_status_code: int = None, message: List[str] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ErrorMessage object.

Parameters

  • error_code (Optional[int]) –

  • http_status_code (Optional[int]) –

  • message (Optional[List[str]]) –

error_code: Optional[int]
fields: Any = None
http_status_code: Optional[int]
message: Optional[List[str]]
schema: Any = None
class kelvin.sdk.client.model.responses.ErrorMessages(client: Optional[Client] = None, *, errors: List[kelvin.sdk.client.model.responses.ErrorMessage] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ErrorMessages object.

Parameters

errors (Optional[List[ErrorMessage]]) –

errors: Optional[List[kelvin.sdk.client.model.responses.ErrorMessage]]
fields: Any = None
schema: Any = None
class kelvin.sdk.client.model.responses.ICDField(client: Optional[Client] = None, *, array: bool = None, description: str = None, name: str = None, type: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ICDField object.

Parameters

  • array (Optional[bool]) –

  • description (Optional[str]) –

  • name (Optional[str]) –

  • type (Optional[str]) –

array: Optional[bool]
description: Optional[str]
fields: Any = None
name: Optional[str]
schema: Any = None
type: Optional[str]
class kelvin.sdk.client.model.responses.ICDPayload(client: Optional[Client] = None, *, class_name: str = None, description: str = None, fields: List[kelvin.sdk.client.model.responses.ICDField] = None, name: str = None, version: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ICDPayload object.

Parameters

  • class_name (Optional[str]) –

  • description (Optional[str]) –

  • fields (Optional[List[ICDField]]) –

  • name (Optional[str]) –

  • version (Optional[str]) –

class_name: Optional[str]
description: Optional[str]
fields: Optional[List[kelvin.sdk.client.model.responses.ICDField]] = None
name: Optional[str]
schema: Any = None
version: Optional[str]
class kelvin.sdk.client.model.responses.InstanceHealthStatus(client: Optional[Client] = None, *, components: List[kelvin.sdk.client.model.responses.ComponentStatus] = None, status: bool = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

InstanceHealthStatus object.

Parameters
components: Optional[List[kelvin.sdk.client.model.responses.ComponentStatus]]
fields: Any = None
classmethod get_instance_health_status(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.InstanceHealthStatus

Get Instance Health Status

Permission Required: n/a.

getInstanceHealthStatus: GET /api/v4/instance/status/get

schema: Any = None
status: Optional[bool]
class kelvin.sdk.client.model.responses.InstanceSettings(client: Optional[Client] = None, *, acp: kelvin.sdk.client.model.responses.ACPSettings = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

InstanceSettings object.

Parameters

acp (Optional[ACPSettings]) –

acp: Optional[kelvin.sdk.client.model.responses.ACPSettings]
fields: Any = None
classmethod get_instance_settings(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.InstanceSettings

Get Instance Settings

Permission Required: kelvin.permission.instance.read.

getInstanceSettings: GET /api/v4/instance/settings/get

schema: Any = None
classmethod update_instance_settings(data: Optional[Union[kelvin.sdk.client.model.requests.InstanceSettings, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.InstanceSettings

Update Instance Settings

Permission Required: kelvin.permission.instance.update.

updateInstanceSettings: POST /api/v4/instance/settings/update

Parameters
class kelvin.sdk.client.model.responses.Label(client: Optional[Client] = None, *, created: datetime.datetime = None, metadata: Dict[str, Any] = None, name: str = None, title: str = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Label object.

Parameters

  • created (Optional[datetime]) –

  • metadata (Optional[Dict[str, Any]]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

classmethod create_label(data: Optional[Union[kelvin.sdk.client.model.requests.LabelCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Label

Create Label

Permission Required: kelvin.permission.data_label.create.

createLabel: POST /api/v4/datalabels/labels/create

Parameters
classmethod create_label_metadata(label_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.LabelMetadata

Create Label Metadata

Permission Required: kelvin.permission.data_label.create.

createLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/create

Parameters

  • label_name (str, optional) – Label name

  • data (requests.LabelMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.LabelMetadataCreate

classmethod create_label_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create Label Metadata Bulk

Permission Required: kelvin.permission.data_label.create.

createLabelMetadataBulk: POST /api/v4/datalabels/labels/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_label(label_name: str, dry_run: bool = False, client: Any = None) → None

Delete Label

Permission Required: kelvin.permission.data_label.delete.

deleteLabel: POST /api/v4/datalabels/labels/{label_name}/delete

Parameters

label_name (str, optional) – Label name

classmethod delete_label_metadata(label_name: str, label_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Label Metadata

Permission Required: kelvin.permission.data_label.delete.

deleteLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/delete

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

classmethod delete_label_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete Label Metadata Bulk

Permission Required: kelvin.permission.data_label.delete.

deleteLabelMetadataBulk: POST /api/v4/datalabels/labels/metadata/delete

Parameters
fields: Any = None
classmethod get_label(label_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.Label

Get Label

Permission Required: kelvin.permission.data_label.read.

getLabel: GET /api/v4/datalabels/labels/{label_name}/get

Parameters

  • label_name (str, optional) – Label name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_label_metadata(label_name: str, label_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.LabelMetadata

Get Label Metadata

Permission Required: kelvin.permission.data_label.read.

getLabelMetadata: GET /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/get

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

classmethod list_label(names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.Label], kelvin.sdk.client.model.responses.LabelListPaginated]

List Label

Pagination Sortable Columns: label.name

Permission Required: kelvin.permission.data_label.read.

listLabel: GET /api/v4/datalabels/labels/list

Parameters

  • names (Sequence[str]) – Filter labels by name

  • search (Sequence[str]) – Search Labels by name or title

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_label_metadata(label_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.LabelMetadata], kelvin.sdk.client.model.responses.LabelMetadataListPaginated]

List Label Metadata

Pagination Sortable Columns: label_metadata.name, label_metadata.label_name

Permission Required: kelvin.permission.data_label.read.

listLabelMetadata: GET /api/v4/datalabels/labels/{label_name}/metadata/list

Parameters

  • label_name (str, optional) – Label name

  • search (Sequence[str]) – Search Label Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metadata: Optional[Dict[str, Any]]
name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_label(label_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Label

Update Label

Permission Required: kelvin.permission.data_label.update.

updateLabel: POST /api/v4/datalabels/labels/{label_name}/update

Parameters

  • label_name (str, optional) – Label name

  • data (requests.LabelUpdate, optional) –

  • **kwargs – Extra parameters for requests.LabelUpdate

classmethod update_label_metadata(label_name: str, label_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.LabelMetadata

Update Label Metadata

Permission Required: kelvin.permission.data_label.update.

updateLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/update

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

  • data (requests.LabelMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.LabelMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.LabelListPaginated(*, data: List[kelvin.sdk.client.model.responses.Label] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

LabelListPaginated object.

Parameters

  • data (Optional[List[Label]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.Label]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.LabelMetadata(client: Optional[Client] = None, *, created: datetime.datetime = None, label_name: str = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

LabelMetadata object.

Parameters

  • created (Optional[datetime]) –

  • label_name (Optional[str]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

classmethod create_label_metadata(label_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.LabelMetadata

Create Label Metadata

Permission Required: kelvin.permission.data_label.create.

createLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/create

Parameters

  • label_name (str, optional) – Label name

  • data (requests.LabelMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.LabelMetadataCreate

created: Optional[datetime.datetime]
classmethod delete_label_metadata(label_name: str, label_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete Label Metadata

Permission Required: kelvin.permission.data_label.delete.

deleteLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/delete

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

fields: Any = None
classmethod get_label_metadata(label_name: str, label_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.LabelMetadata

Get Label Metadata

Permission Required: kelvin.permission.data_label.read.

getLabelMetadata: GET /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/get

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

label_name: Optional[str]
classmethod list_label_metadata(label_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.LabelMetadata], kelvin.sdk.client.model.responses.LabelMetadataListPaginated]

List Label Metadata

Pagination Sortable Columns: label_metadata.name, label_metadata.label_name

Permission Required: kelvin.permission.data_label.read.

listLabelMetadata: GET /api/v4/datalabels/labels/{label_name}/metadata/list

Parameters

  • label_name (str, optional) – Label name

  • search (Sequence[str]) – Search Label Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_label_metadata(label_name: str, label_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.LabelMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.LabelMetadata

Update Label Metadata

Permission Required: kelvin.permission.data_label.update.

updateLabelMetadata: POST /api/v4/datalabels/labels/{label_name}/metadata/{label_metadata_name}/update

Parameters

  • label_name (str, optional) – Label name

  • label_metadata_name (str, optional) – Label Metadata name

  • data (requests.LabelMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.LabelMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.LabelMetadataListPaginated(*, data: List[kelvin.sdk.client.model.responses.LabelMetadata] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

LabelMetadataListPaginated object.

Parameters

  • data (Optional[List[LabelMetadata]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.LabelMetadata]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.Metric(client: Optional[Client] = None, *, created: datetime.datetime = None, data_type_name: str = None, data_type_version: str = None, display_unit: str = None, name: str = None, payload: Dict[str, Any] = None, semantic_type_name: str = None, title: str = None, updated: datetime.datetime = None, write: bool = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Metric object.

Parameters

  • created (Optional[datetime]) –

  • data_type_name (Optional[str]) –

  • data_type_version (Optional[str]) –

  • display_unit (Optional[str]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • semantic_type_name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

  • write (Optional[bool]) –

classmethod create_metric(data: Optional[Union[kelvin.sdk.client.model.requests.MetricCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Metric

Create Metric

Permission Required: kelvin.permission.metric.create.

createMetric: POST /api/v4/metrics/create

Parameters
created: Optional[datetime.datetime]
data_type_name: Optional[str]
data_type_version: Optional[str]
classmethod delete_metric(metric_name: str, dry_run: bool = False, client: Any = None) → None

Delete Metric

Permission Required: kelvin.permission.metric.delete.

deleteMetric: POST /api/v4/metrics/{metric_name}/delete

Parameters

metric_name (str, optional) – Metric name

display_unit: Optional[str]
fields: Any = None
classmethod get_metric(metric_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.Metric

Get Metric

Permission Required: kelvin.permission.metric.read.

getMetric: GET /api/v4/metrics/{metric_name}/get

Parameters

metric_name (str, optional) – Metric name

classmethod list_bridge_metrics(bridge_name: str, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.Metric], kelvin.sdk.client.model.responses.MetricListPaginated]

List Bridge Metrics

Pagination Sortable Columns: metric.name, metric.title, metric.created, metric.updated, metric.data_type_name

Permission Required: kelvin.permission.bridge.read.

listBridgeMetrics: GET /api/v4/bridges/{bridge_name}/metrics/list

Parameters

  • bridge_name (str, optional) – Bridge name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_metric(data_type_name: Optional[Sequence[str]] = None, data_type_version: Optional[Sequence[str]] = None, semantic_type_name: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, search: Optional[Sequence[str]] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.Metric], kelvin.sdk.client.model.responses.MetricListPaginated]

List Metric

Pagination Sortable Columns: metric.name, metric.title, metric.data_type_name, metric.data_type_version, metric.display_unit, metric.semantic_type_name, metric.write, metric.created, metric.updated, semantic_type.title

Permission Required: kelvin.permission.metric.read.

listMetric: GET /api/v4/metrics/list

Parameters

  • data_type_name (Sequence[str]) – Filter metrics by Data Type Name

  • data_type_version (Sequence[str]) – Filter metrics by Data Type Version

  • semantic_type_name (Sequence[str]) – Filter metrics by Semantic Type Name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

  • search (Sequence[str]) – Search metric by name, title

classmethod list_semantic_type(names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.SemanticTypeList

List Semantic Type

Sortable Columns: semantictype.name, semantictype.title, semantictype.created, semantictype.updated

Permission Required: kelvin.permission.metric.read.

listSemanticType: GET /api/v4/metrics/semantictypes/list

Parameters

  • names (Sequence[str]) – Filter semantic types by name

  • search (Sequence[str]) – Search semantic types by name or title

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
semantic_type_name: Optional[str]
title: Optional[str]
classmethod update_metric(metric_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.MetricUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Metric

Update Metric

Permission Required: kelvin.permission.metric.update.

updateMetric: POST /api/v4/metrics/{metric_name}/update

Parameters

  • metric_name (str, optional) – Metric name

  • data (requests.MetricUpdate, optional) –

  • **kwargs – Extra parameters for requests.MetricUpdate

updated: Optional[datetime.datetime]
write: Optional[bool]
class kelvin.sdk.client.model.responses.MetricListPaginated(*, data: List[kelvin.sdk.client.model.responses.Metric] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

MetricListPaginated object.

Parameters

  • data (Optional[List[Metric]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.Metric]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.NetworkingAddressItem(client: Optional[Client] = None, *, address: str = None, interface: str = None, port: int = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

NetworkingAddressItem object.

Parameters

  • address (Optional[str]) –

  • interface (Optional[str]) –

  • port (Optional[int]) –

address: Optional[str]
fields: Any = None
interface: Optional[str]
port: Optional[int]
schema: Any = None
class kelvin.sdk.client.model.responses.NetworkingItem(client: Optional[Client] = None, *, addresses: List[kelvin.sdk.client.model.responses.NetworkingAddressItem] = None, name: str = None, protocol: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

NetworkingItem object.

Parameters
addresses: Optional[List[kelvin.sdk.client.model.responses.NetworkingAddressItem]]
fields: Any = None
name: Optional[str]
protocol: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.OrchestrationProvision(client: Optional[Client] = None, *, provision_script: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

OrchestrationProvision object.

Parameters

provision_script (Optional[str]) –

classmethod download_cluster_provision_script(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.OrchestrationProvision

Download Cluster Provision Script

Permission Required: kelvin.permission.orchestration.read.

downloadClusterProvisionScript: GET /api/v4/orchestration/clusters/provision/script/download

fields: Any = None
provision_script: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.Secret(client: Optional[Client] = None, *, name: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Secret object.

Parameters

name (Optional[str]) –

classmethod create_secret(data: Optional[Union[kelvin.sdk.client.model.requests.SecretCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Secret

Create Secret

Permission Required: kelvin.permission.secret.update.

createSecret: POST /api/v4/secrets/create

Parameters
classmethod delete_secret(secret_name: str, dry_run: bool = False, client: Any = None) → None

Delete Secret

Permission Required: kelvin.permission.secret.delete.

deleteSecret: POST /api/v4/secrets/{secret_name}/delete

Parameters

secret_name (str, optional) – Secret name

fields: Any = None
classmethod list_secret(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.Secret], kelvin.sdk.client.model.responses.SecretListPaginated]

List Secret

Permission Required: kelvin.permission.secret.read.

listSecret: GET /api/v4/secrets/list

Parameters

  • search (Sequence[str]) – Search secrets by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.SecretListPaginated(*, data: List[kelvin.sdk.client.model.responses.Secret] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

SecretListPaginated object.

Parameters

  • data (Optional[List[Secret]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.Secret]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.SemanticTypeItem(client: Optional[Client] = None, *, created: datetime.datetime = None, name: str = None, title: str = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

SemanticTypeItem object.

Parameters

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

created: Optional[datetime.datetime]
fields: Any = None
name: Optional[str]
schema: Any = None
title: Optional[str]
updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.SemanticTypeList(client: Optional[Client] = None, *, data: List[kelvin.sdk.client.model.responses.SemanticTypeItem] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

SemanticTypeList object.

Parameters

data (Optional[List[SemanticTypeItem]]) –

data: Optional[List[kelvin.sdk.client.model.responses.SemanticTypeItem]]
fields: Any = None
classmethod list_semantic_type(names: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.SemanticTypeList

List Semantic Type

Sortable Columns: semantictype.name, semantictype.title, semantictype.created, semantictype.updated

Permission Required: kelvin.permission.metric.read.

listSemanticType: GET /api/v4/metrics/semantictypes/list

Parameters

  • names (Sequence[str]) – Filter semantic types by name

  • search (Sequence[str]) – Search semantic types by name or title

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

schema: Any = None
class kelvin.sdk.client.model.responses.Storage(client: Optional[Client] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Storage object.

classmethod create_historian_metric(data: Optional[Union[kelvin.sdk.client.model.requests.StorageBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create Historian Metric persists time series data.

Note: * If a Metric timestamp already exists on the database, this endpoint will overwrite the stored payload with the new payload value.

Payload Details: * name: name of the Metric * source: application that generated the data. Example: modbus * asset_name: name of the Asset * payload: data to persist * timestamp: UNIX timestamp in nanoseconds or RFC3339 string

Permission Required: kelvin.permission.storage.create.

createHistorianMetric: POST /api/v4/storage/historian/create

Parameters
classmethod delete_historian_range(data: Optional[Union[kelvin.sdk.client.model.requests.StorageDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete Historian Range will delete all associated time series values between a given time-range.

Payload Details: * start_time: supports RFC3339 timestamps with added micro-second precision * end_time: supports RFC3339 timestamps with added micro-second precision

Permission Required: kelvin.permission.storage.delete.

deleteHistorianRange: POST /api/v4/storage/historian/range/delete

Parameters
classmethod download_historian_metrics(data: Optional[Union[kelvin.sdk.client.model.requests.StorageRangeAdvanced, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Download Historian Metrics returns a CSV file with time series data for a given time range List of Metric selectors.

Payload Description: * start_time supports RFC3339 timestamps with added micro-second precision * end_time supports RFC3339 timestamps with added micro-second precision * time_bucket uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: 5m, 1h, 1w * time_shift is used to shift the time buckets from the epoch. Every time bucket starts from epoch so, if you want to calculate the time bucket starting on a different date and time, you’ll need to set this. Example: 5m, 1h, 1w * fill allows you to fill missing points from a time bucket. Check below for supported fill values. * agg allows you to choose an aggregation. Check below for supported aggregations.

Supported Fill: * none: Default behaviour. * null: Fills the missing points with null string * linear: Performs a linear regression * previous: Uses the previous non-empty value * int value: Fills the missing points with the specified number

Supported Aggregations: * Numeric types (int32, int64, etc) are: none, count, distinct, integral, mean, median, mode, spread, stddev, sum, max & min * Non-numeric types (text, etc) are: count, distinct and mode

Permission Required: kelvin.permission.storage.read.

downloadHistorianMetrics: POST /api/v4/storage/historian/range/download

Parameters
fields: Any = None
classmethod get_historian_metric_advanced_range(data: Optional[Union[kelvin.sdk.client.model.requests.StorageRangeAdvanced, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → Iterator[kelvin.sdk.client.model.responses.StorageData]

Get Historian Metric Advanced Range returns time series data for a given time range and a list of Metric selectors.

Payload Description: * start_time supports RFC3339 timestamps with added micro-second precision * end_time supports RFC3339 timestamps with added micro-second precision * time_bucket uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: 5m, 1h, 1w * time_shift is used to shift the time buckets from the epoch. Every time bucket starts from epoch so, if you want to calculate the time bucket starting on a different date and time, you’ll need to set this. Example: 5m, 1h, 1w * fill allows you to fill missing points from a time bucket. Check below for supported fill values. * agg allows you to choose an aggregation. Check below for supported aggregations.

Supported Fill: * none: Default behaviour. * null: Fills the missing points with null string * linear: Performs a linear regression * previous: Uses the previous non-empty value * int value: Fills the missing points with the specified number

Supported Aggregations: * Numeric types (int32, int64, etc) are: none, count, distinct, integral, mean, median, mode, spread, stddev, sum, max & min * Non-numeric types (text, etc) are: count, distinct and mode

Permission Required: kelvin.permission.storage.read.

getHistorianMetricAdvancedRange: POST /api/v4/storage/historian/range/get

Parameters
classmethod get_historian_metric_last(name: str, asset_name: str, fields: Optional[str] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.StorageData

Get Historian Metric Last returns the last value inserted on the time series database for a single Metric. The calculation is based on the most recent timestamp available for the Metric.

Permission Required: kelvin.permission.storage.read.

getHistorianMetricLast: GET /api/v4/storage/historian/last/get

Parameters

  • name (str, optional) – Metric Name

  • asset_name (str, optional) – Asset name

  • fields (str) – List of field identifiers

classmethod get_historian_metric_last_advanced(data: Optional[Union[kelvin.sdk.client.model.requests.StorageLast, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → Iterator[kelvin.sdk.client.model.responses.StorageData]

Get Historian Metric Last Advanced returns the last values inserted on the time series database for a list of Metric selectors. The calculation is based on the most recent timestamp available for each Metric.

Permission Required: kelvin.permission.storage.read.

getHistorianMetricLastAdvanced: POST /api/v4/storage/historian/last/get

Parameters
classmethod get_historian_metric_range(name: str, asset_name: str, start_time: datetime.datetime, end_time: datetime.datetime, agg: Optional[typing_extensions.Literal[none, count, distinct, integral, mean, median, mode, spread, stddev, sum, max, min]] = None, time_bucket: Optional[str] = None, time_shift: Optional[str] = None, fill: Optional[str] = None, order: Optional[str] = None, fields: Optional[Sequence[str]] = None, dry_run: bool = False, client: Optional[Any] = None) → Iterator[kelvin.sdk.client.model.responses.StorageData]

Get Historian Metric Range returns time series data for a given time range and a list of Metric selectors.

Payload Description: * start_time supports RFC3339 timestamps with added micro-second precision * end_time supports RFC3339 timestamps with added micro-second precision * time_bucket uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: 5m, 1h, 1w * time_shift is used to shift the time buckets from the epoch. Every time bucket starts from epoch so, if you want to calculate the time bucket starting on a different date and time, you’ll need to set this. Example: 5m, 1h, 1w * fill allows you to fill missing points from a time bucket. Check below for supported fill values. * agg allows you to choose an aggregation. Check below for supported aggregations.

Supported Fill: * none: Default behaviour. * null: Fills the missing points with null string * linear: Performs a linear regression * previous: Uses the previous non-empty value * int value: Fills the missing points with the specified number

Supported Aggregations: * Numeric types (int32, int64, etc) are: none, count, distinct, integral, mean, median, mode, spread, stddev, sum, max & min * Non-numeric types (text, etc) are: count, distinct and mode

Permission Required: kelvin.permission.storage.read.

getHistorianMetricRange: GET /api/v4/storage/historian/range/get

Parameters

  • name (str, optional) – Metric Name

  • asset_name (str, optional) – Asset name

  • start_time (datetime, optional) – Value for the start of the range for which to get data

  • end_time (datetime, optional) – Value for the end of the range for which to get data

  • agg (Literal['none', 'count', 'distinct', 'integral', 'mean', 'median', 'mode', 'spread', 'stddev', 'sum', 'max', 'min']) – Aggregation (none, count, distinct, integral, mean, median, mode, spread, stddev, sum, max, min)

  • time_bucket (str) – Interval for which to group by, in human readable format

  • time_shift (str) – Interval by which to shift the time buckets, from epoch

  • fill (str) – Filling for empty time buckets (check description for possible values)

  • order (str) – Order of the data

  • fields (Sequence[str]) – Fields

classmethod list_historian_metric(name: Optional[str] = None, asset_name: Optional[str] = None, search: Optional[str] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.StorageMetric], kelvin.sdk.client.model.responses.StorageMetricListPaginated]

List Historian Metric

Pagination Sortable Columns: metric.name, metric.asset_name

Permission Required: kelvin.permission.storage.read.

listHistorianMetric: GET /api/v4/storage/historian/list

Parameters

  • name (str) – Metric name

  • asset_name (str) – Asset name

  • search (str) – Search metrics by name or asset_name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

schema: Any = None
classmethod update_historian_metric(data: Optional[Union[kelvin.sdk.client.model.requests.StorageUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Update Historian Metric allows updating the title of a Metric.

Permission Required: kelvin.permission.storage.update.

updateHistorianMetric: POST /api/v4/storage/historian/update

Parameters
classmethod upload_historian_metrics(file: str, dry_run: bool = False, client: Optional[Any] = None) → None

Upload Historian Metrics allows sending a CSV file with time series data to be persisted.

Permission Required: kelvin.permission.storage.create.

uploadHistorianMetrics: POST /api/v4/storage/historian/upload

Parameters

file (str, optional) – CSV File

class kelvin.sdk.client.model.responses.StorageData(client: Optional[Client] = None, *, asset_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, timestamp: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

StorageData object.

Parameters

  • _insertion_timestamp (Optional[datetime]) –

  • asset_name (Optional[str]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • timestamp (Optional[datetime]) –

asset_name: Optional[str]
fields: Any = None
name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
timestamp: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.StorageMetric(client: Optional[Client] = None, *, asset_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, created: datetime.datetime = None, fields: List[str] = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

StorageMetric object.

Parameters

  • asset_name (Optional[str]) –

  • created (Optional[datetime]) –

  • fields (Optional[List[str]]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

asset_name: Optional[str]
created: Optional[datetime.datetime]
fields: Optional[List[str]] = None
name: Optional[str]
schema: Any = None
title: Optional[str]
updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.StorageMetricListPaginated(*, data: List[kelvin.sdk.client.model.responses.StorageMetric] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

StorageMetricListPaginated object.

Parameters

  • data (Optional[List[StorageMetric]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.StorageMetric]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.Type(value)

Bases: enum.Enum

An enumeration.

user = 'user'
workload = 'workload'
class kelvin.sdk.client.model.responses.User(client: Optional[Client] = None, *, created: datetime.datetime = None, email: pydantic.networks.EmailStr = None, first_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, id: uuid.UUID = None, last_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, username: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

User object.

Parameters

  • created (Optional[datetime]) –

  • email (Optional[EmailStr]) –

  • first_name (Optional[str]) –

  • id (Optional[UUID]) –

  • last_name (Optional[str]) –

  • username (Optional[str]) –

created: Optional[datetime.datetime]
email: Optional[pydantic.networks.EmailStr]
fields: Any = None
first_name: Optional[str]
classmethod get_current_user(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.UserWithPermissions

Get Current User

Permission Required: n/a.

getCurrentUser: GET /api/v4/users/me

classmethod get_user(user_id: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.User

Get User

Permission Required: kelvin.permission.user.read.

getUser: GET /api/v4/users/{user_id}/get

Parameters

user_id (str, optional) – User ID

id: Optional[uuid.UUID]
last_name: Optional[str]
classmethod list_user(username: Optional[Sequence[str]] = None, email: Optional[Sequence[str]] = None, name: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.User], kelvin.sdk.client.model.responses.UserListPaginated]

List User

Pagination Sortable Columns: user_entity.id

Permission Required: kelvin.permission.user.read.

listUser: GET /api/v4/users/list

Parameters

  • username (Sequence[str]) – User’s username

  • email (Sequence[str]) – User’s email

  • name (Sequence[str]) – User’s name

  • search (Sequence[str]) – Search Users by name or email

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

schema: Any = None
username: Optional[str]
class kelvin.sdk.client.model.responses.UserListPaginated(*, data: List[kelvin.sdk.client.model.responses.User] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

UserListPaginated object.

Parameters

  • data (Optional[List[User]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.User]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.UserWithPermissions(client: Optional[Client] = None, *, created: datetime.datetime = None, email: pydantic.networks.EmailStr = None, first_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, id: uuid.UUID = None, last_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, permissions: List[str] = None, username: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

UserWithPermissions object.

Parameters

  • created (Optional[datetime]) –

  • email (Optional[EmailStr]) –

  • first_name (Optional[str]) –

  • id (Optional[UUID]) –

  • last_name (Optional[str]) –

  • permissions (Optional[List[str]]) –

  • username (Optional[str]) –

created: Optional[datetime.datetime]
email: Optional[pydantic.networks.EmailStr]
fields: Any = None
first_name: Optional[str]
classmethod get_current_user(dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.UserWithPermissions

Get Current User

Permission Required: n/a.

getCurrentUser: GET /api/v4/users/me

classmethod get_user(user_id: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.User

Get User

Permission Required: kelvin.permission.user.read.

getUser: GET /api/v4/users/{user_id}/get

Parameters

user_id (str, optional) – User ID

id: Optional[uuid.UUID]
last_name: Optional[str]
classmethod list_user(username: Optional[Sequence[str]] = None, email: Optional[Sequence[str]] = None, name: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.User], kelvin.sdk.client.model.responses.UserListPaginated]

List User

Pagination Sortable Columns: user_entity.id

Permission Required: kelvin.permission.user.read.

listUser: GET /api/v4/users/list

Parameters

  • username (Sequence[str]) – User’s username

  • email (Sequence[str]) – User’s email

  • name (Sequence[str]) – User’s name

  • search (Sequence[str]) – Search Users by name or email

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

permissions: Optional[List[str]]
schema: Any = None
username: Optional[str]
class kelvin.sdk.client.model.responses.View(client: Optional[Client] = None, *, created: datetime.datetime = None, groups: List[kelvin.sdk.client.model.responses.ViewGroup] = None, metadata: Dict[str, Any] = None, metrics: List[kelvin.sdk.client.model.responses.ViewMetric] = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, view_type_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

View object.

Parameters

  • created (Optional[datetime]) –

  • groups (Optional[List[ViewGroup]]) –

  • metadata (Optional[Dict[str, Any]]) –

  • metrics (Optional[List[ViewMetric]]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

  • view_type_name (Optional[str]) –

classmethod create_view(data: Optional[Union[kelvin.sdk.client.model.requests.ViewCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.View

Create View

Permission Required: kelvin.permission.view.create.

createView: POST /api/v4/views/create

Parameters

  • data (requests.ViewCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewCreate

classmethod create_view_group(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroup

Create View Group

Permission Required: kelvin.permission.view.create.

createViewGroup: POST /api/v4/views/groups/create

Parameters
classmethod create_view_group_metadata(view_group_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Create View Group Metadata

Permission Required: kelvin.permission.view.create.

createViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/create

Parameters
classmethod create_view_group_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Group Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewGroupMetadataBulk: POST /api/v4/views/groups/metadata/create

Parameters
classmethod create_view_metadata(view_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewMetadata

Create View Metadata

Permission Required: kelvin.permission.view.create.

createViewMetadata: POST /api/v4/views/{view_name}/metadata/create

Parameters

  • view_name (str, optional) – View name

  • data (requests.ViewMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewMetadataCreate

classmethod create_view_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewMetadataBulk: POST /api/v4/views/metadata/create

Parameters
classmethod create_view_type(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewType

Create View Type

Permission Required: kelvin.permission.view.create.

createViewType: POST /api/v4/views/types/create

Parameters
classmethod create_view_type_metadata(view_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Create View Type Metadata

Permission Required: kelvin.permission.view.create.

createViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/create

Parameters

  • view_type_name (str, optional) – View Type name

  • data (requests.ViewTypeMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataCreate

classmethod create_view_type_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Type Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewTypeMetadataBulk: POST /api/v4/views/types/metadata/create

Parameters
classmethod create_view_view_group_relationship(view_name: str, view_group_name: str, dry_run: bool = False, client: Any = None) → None

Create View View Group Relationship

Permission Required: kelvin.permission.view.create.

createViewViewGroupRelationship: POST /api/v4/views/{view_name}/groups/{view_group_name}/create

Parameters

  • view_name (str, optional) – View name

  • view_group_name (str, optional) – View Group name

created: Optional[datetime.datetime]
classmethod delete_view(view_name: str, dry_run: bool = False, client: Any = None) → None

Delete View

Permission Required: kelvin.permission.view.delete.

deleteView: POST /api/v4/views/{view_name}/delete

Parameters

view_name (str, optional) – View name

classmethod delete_view_group(view_group_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete View Group

Permission Required: kelvin.permission.view.delete.

deleteViewGroup: POST /api/v4/views/groups/{view_group_name}/delete

Parameters

view_group_name (str, optional) – View Group name

classmethod delete_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete View Group Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/delete

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

classmethod delete_view_group_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Group Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewGroupMetadataBulk: POST /api/v4/views/groups/metadata/delete

Parameters
classmethod delete_view_metadata(view_name: str, view_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewMetadata: POST /api/v4/views/{view_name}/metadata/{view_metadata_name}/delete

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

classmethod delete_view_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewMetadataBulk: POST /api/v4/views/metadata/delete

Parameters
classmethod delete_view_type(view_type_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Type

Permission Required: kelvin.permission.view.delete.

deleteViewType: POST /api/v4/views/types/{view_type_name}/delete

Parameters

view_type_name (str, optional) – View Type name

classmethod delete_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Type Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/delete

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

classmethod delete_view_type_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Type Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewTypeMetadataBulk: POST /api/v4/views/types/metadata/delete

Parameters
classmethod delete_view_view_group_relationship(view_name: str, view_group_name: str, dry_run: bool = False, client: Any = None) → None

Delete View View Group Relationship

Permission Required: kelvin.permission.view.delete.

deleteViewViewGroupRelationship: POST /api/v4/views/{view_name}/groups/{view_group_name}/delete

Parameters

  • view_name (str, optional) – View name

  • view_group_name (str, optional) – View Group name

fields: Any = None
classmethod get_view(view_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.View

Get View

Permission Required: kelvin.permission.view.read.

getView: GET /api/v4/views/{view_name}/get

Parameters

  • view_name (str, optional) – View name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_group(view_group_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewGroup

Get View Group

Permission Required: kelvin.permission.view.read.

getViewGroup: GET /api/v4/views/groups/{view_group_name}/get

Parameters

  • view_group_name (str, optional) – View Group name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Get View Group Metadata

Permission Required: kelvin.permission.view.read.

getViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/get

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

classmethod get_view_metadata(view_name: str, view_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewMetadata

Get View Metadata

Permission Required: kelvin.permission.view.read.

getViewMetadata: GET /api/v4/views/{view_name}/metadata/{view_metadata_name}/get

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

classmethod get_view_type(view_type_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewType

Get View Type

Permission Required: kelvin.permission.view.read.

getViewType: GET /api/v4/views/types/{view_type_name}/get

Parameters

  • view_type_name (str, optional) – View Type name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Get View Type Metadata

Permission Required: kelvin.permission.view.read.

getViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/get

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

groups: Optional[List[kelvin.sdk.client.model.responses.ViewGroup]]
classmethod list_view(search: Optional[Sequence[str]] = None, view_type_name: Optional[Sequence[str]] = None, view_group_name: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewItem], kelvin.sdk.client.model.responses.ViewListPaginated]

List View

List $1

Pagination Sortable Columns: view.name

Permission Required: kelvin.permission.view.read.

listView: GET /api/v4/views/list

Parameters

  • search (Sequence[str]) – Search views by name or title

  • view_type_name (Sequence[str]) – Filter views by view type

  • view_group_name (Sequence[str]) – Filter views by view group

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_group(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewGroup], kelvin.sdk.client.model.responses.ViewGroupListPaginated]

List View Group

Pagination Sortable Columns: view_group.name

Permission Required: kelvin.permission.view.read.

listViewGroup: GET /api/v4/views/groups/list

Parameters

  • search (Sequence[str]) – Search View Group by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_group_metadata(view_group_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewGroupMetadata], kelvin.sdk.client.model.responses.ViewGroupMetadataListPaginated]

List View Group Metadata

Pagination Sortable Columns: view_group_metadata.name, view_group_metadata.view_group_name

Permission Required: kelvin.permission.view.read.

listViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/list

Parameters

  • view_group_name (str, optional) – View group name

  • search (Sequence[str]) – Search View Group Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_metadata(view_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewMetadata], kelvin.sdk.client.model.responses.ViewMetadataListPaginated]

List View Metadata

Pagination Sortable Columns: view_metadata.name, view_metadata.view_name

Permission Required: kelvin.permission.view.read.

listViewMetadata: GET /api/v4/views/{view_name}/metadata/list

Parameters

  • view_name (str, optional) – View name

  • search (Sequence[str]) – Search View Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_type(search: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewType], kelvin.sdk.client.model.responses.ViewTypeListPaginated]

List View Type

Pagination Sortable Columns: view_type.name

Permission Required: kelvin.permission.view.read.

listViewType: GET /api/v4/views/types/list

Parameters

  • search (Sequence[str]) – Search View Type by name

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_type_metadata(view_type_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewTypeMetadata], kelvin.sdk.client.model.responses.ViewTypeMetadataListPaginated]

List View Type Metadata

Pagination Sortable Columns: view_type_metadata.name, view_type_metadata.view_type_name

Permission Required: kelvin.permission.view.read.

listViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/list

Parameters

  • view_type_name (str, optional) – View Type name

  • search (Sequence[str]) – Search View Type Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metadata: Optional[Dict[str, Any]]
metrics: Optional[List[kelvin.sdk.client.model.responses.ViewMetric]]
name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_view(view_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.View

Update View

Permission Required: kelvin.permission.view.update.

updateView: POST /api/v4/views/{view_name}/update

Parameters

  • view_name (str, optional) – View name

  • data (requests.ViewUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewUpdate

classmethod update_view_group(view_group_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroup

Update View Group

Permission Required: kelvin.permission.view.update.

updateViewGroup: POST /api/v4/views/groups/{view_group_name}/update

Parameters

  • view_group_name (str, optional) – View Group name

  • data (requests.ViewGroupUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewGroupUpdate

classmethod update_view_group_metadata(view_group_name: str, view_group_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Update View Group Metadata

Permission Required: kelvin.permission.view.update.

updateViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/update

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

  • data (requests.ViewGroupMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewGroupMetadataUpdate

classmethod update_view_metadata(view_name: str, view_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewMetadata

Update View Metadata

Permission Required: kelvin.permission.view.update.

updateViewMetadata: POST /api/v4/views/{view_name}/metadata/{view_metadata_name}/update

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

  • data (requests.ViewMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewMetadataUpdate

classmethod update_view_type(view_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewType

Update View Type

Permission Required: kelvin.permission.view.update.

updateViewType: POST /api/v4/views/types/{view_type_name}/update

Parameters

  • view_type_name (str, optional) – View Type name

  • data (requests.ViewTypeUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeUpdate

classmethod update_view_type_metadata(view_type_name: str, view_type_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Update View Type Metadata

Permission Required: kelvin.permission.view.update.

updateViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/update

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

  • data (requests.ViewTypeMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataUpdate

updated: Optional[datetime.datetime]
view_type_name: Optional[str]
class kelvin.sdk.client.model.responses.ViewGroup(client: Optional[Client] = None, *, created: datetime.datetime = None, metadata: Dict[str, Any] = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, views: List[kelvin.sdk.client.model.responses.ViewItem] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ViewGroup object.

Parameters

  • created (Optional[datetime]) –

  • metadata (Optional[Dict[str, Any]]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

  • views (Optional[List[ViewItem]]) –

classmethod create_view_group(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroup

Create View Group

Permission Required: kelvin.permission.view.create.

createViewGroup: POST /api/v4/views/groups/create

Parameters
classmethod create_view_group_metadata(view_group_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Create View Group Metadata

Permission Required: kelvin.permission.view.create.

createViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/create

Parameters
classmethod create_view_group_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Group Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewGroupMetadataBulk: POST /api/v4/views/groups/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_view_group(view_group_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Group

Permission Required: kelvin.permission.view.delete.

deleteViewGroup: POST /api/v4/views/groups/{view_group_name}/delete

Parameters

view_group_name (str, optional) – View Group name

classmethod delete_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Group Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/delete

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

classmethod delete_view_group_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Group Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewGroupMetadataBulk: POST /api/v4/views/groups/metadata/delete

Parameters
fields: Any = None
classmethod get_view_group(view_group_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewGroup

Get View Group

Permission Required: kelvin.permission.view.read.

getViewGroup: GET /api/v4/views/groups/{view_group_name}/get

Parameters

  • view_group_name (str, optional) – View Group name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Get View Group Metadata

Permission Required: kelvin.permission.view.read.

getViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/get

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

classmethod list_view_group(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewGroup], kelvin.sdk.client.model.responses.ViewGroupListPaginated]

List View Group

Pagination Sortable Columns: view_group.name

Permission Required: kelvin.permission.view.read.

listViewGroup: GET /api/v4/views/groups/list

Parameters

  • search (Sequence[str]) – Search View Group by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_group_metadata(view_group_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewGroupMetadata], kelvin.sdk.client.model.responses.ViewGroupMetadataListPaginated]

List View Group Metadata

Pagination Sortable Columns: view_group_metadata.name, view_group_metadata.view_group_name

Permission Required: kelvin.permission.view.read.

listViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/list

Parameters

  • view_group_name (str, optional) – View group name

  • search (Sequence[str]) – Search View Group Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metadata: Optional[Dict[str, Any]]
name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_view_group(view_group_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroup

Update View Group

Permission Required: kelvin.permission.view.update.

updateViewGroup: POST /api/v4/views/groups/{view_group_name}/update

Parameters

  • view_group_name (str, optional) – View Group name

  • data (requests.ViewGroupUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewGroupUpdate

classmethod update_view_group_metadata(view_group_name: str, view_group_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Update View Group Metadata

Permission Required: kelvin.permission.view.update.

updateViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/update

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

  • data (requests.ViewGroupMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewGroupMetadataUpdate

updated: Optional[datetime.datetime]
views: Optional[List[kelvin.sdk.client.model.responses.ViewItem]]
class kelvin.sdk.client.model.responses.ViewGroupListPaginated(*, data: List[kelvin.sdk.client.model.responses.ViewGroup] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ViewGroupListPaginated object.

Parameters

  • data (Optional[List[ViewGroup]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ViewGroup]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ViewGroupMetadata(client: Optional[Client] = None, *, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, view_group_name: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ViewGroupMetadata object.

Parameters

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

  • view_group_name (Optional[str]) –

classmethod create_view_group_metadata(view_group_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Create View Group Metadata

Permission Required: kelvin.permission.view.create.

createViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Group Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/delete

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

fields: Any = None
classmethod get_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Get View Group Metadata

Permission Required: kelvin.permission.view.read.

getViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/get

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

classmethod list_view_group_metadata(view_group_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewGroupMetadata], kelvin.sdk.client.model.responses.ViewGroupMetadataListPaginated]

List View Group Metadata

Pagination Sortable Columns: view_group_metadata.name, view_group_metadata.view_group_name

Permission Required: kelvin.permission.view.read.

listViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/list

Parameters

  • view_group_name (str, optional) – View group name

  • search (Sequence[str]) – Search View Group Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_view_group_metadata(view_group_name: str, view_group_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Update View Group Metadata

Permission Required: kelvin.permission.view.update.

updateViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/update

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

  • data (requests.ViewGroupMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewGroupMetadataUpdate

updated: Optional[datetime.datetime]
view_group_name: Optional[str]
class kelvin.sdk.client.model.responses.ViewGroupMetadataListPaginated(*, data: List[kelvin.sdk.client.model.responses.ViewGroupMetadata] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ViewGroupMetadataListPaginated object.

Parameters

  • data (Optional[List[ViewGroupMetadata]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ViewGroupMetadata]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ViewItem(client: Optional[Client] = None, *, created: datetime.datetime = None, metadata: Dict[str, Any] = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, view_type_name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ViewItem object.

Parameters

  • created (Optional[datetime]) –

  • metadata (Optional[Dict[str, Any]]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

  • view_type_name (Optional[str]) –

classmethod create_view(data: Optional[Union[kelvin.sdk.client.model.requests.ViewCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.View

Create View

Permission Required: kelvin.permission.view.create.

createView: POST /api/v4/views/create

Parameters

  • data (requests.ViewCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewCreate

classmethod create_view_group(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroup

Create View Group

Permission Required: kelvin.permission.view.create.

createViewGroup: POST /api/v4/views/groups/create

Parameters
classmethod create_view_group_metadata(view_group_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Create View Group Metadata

Permission Required: kelvin.permission.view.create.

createViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/create

Parameters
classmethod create_view_group_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Group Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewGroupMetadataBulk: POST /api/v4/views/groups/metadata/create

Parameters
classmethod create_view_metadata(view_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewMetadata

Create View Metadata

Permission Required: kelvin.permission.view.create.

createViewMetadata: POST /api/v4/views/{view_name}/metadata/create

Parameters

  • view_name (str, optional) – View name

  • data (requests.ViewMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewMetadataCreate

classmethod create_view_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewMetadataBulk: POST /api/v4/views/metadata/create

Parameters
classmethod create_view_type(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewType

Create View Type

Permission Required: kelvin.permission.view.create.

createViewType: POST /api/v4/views/types/create

Parameters
classmethod create_view_type_metadata(view_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Create View Type Metadata

Permission Required: kelvin.permission.view.create.

createViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/create

Parameters

  • view_type_name (str, optional) – View Type name

  • data (requests.ViewTypeMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataCreate

classmethod create_view_type_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Type Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewTypeMetadataBulk: POST /api/v4/views/types/metadata/create

Parameters
classmethod create_view_view_group_relationship(view_name: str, view_group_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Create View View Group Relationship

Permission Required: kelvin.permission.view.create.

createViewViewGroupRelationship: POST /api/v4/views/{view_name}/groups/{view_group_name}/create

Parameters

  • view_name (str, optional) – View name

  • view_group_name (str, optional) – View Group name

created: Optional[datetime.datetime]
classmethod delete_view(view_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete View

Permission Required: kelvin.permission.view.delete.

deleteView: POST /api/v4/views/{view_name}/delete

Parameters

view_name (str, optional) – View name

classmethod delete_view_group(view_group_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete View Group

Permission Required: kelvin.permission.view.delete.

deleteViewGroup: POST /api/v4/views/groups/{view_group_name}/delete

Parameters

view_group_name (str, optional) – View Group name

classmethod delete_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete View Group Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/delete

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

classmethod delete_view_group_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Group Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewGroupMetadataBulk: POST /api/v4/views/groups/metadata/delete

Parameters
classmethod delete_view_metadata(view_name: str, view_metadata_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete View Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewMetadata: POST /api/v4/views/{view_name}/metadata/{view_metadata_name}/delete

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

classmethod delete_view_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewMetadataBulk: POST /api/v4/views/metadata/delete

Parameters
classmethod delete_view_type(view_type_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Type

Permission Required: kelvin.permission.view.delete.

deleteViewType: POST /api/v4/views/types/{view_type_name}/delete

Parameters

view_type_name (str, optional) – View Type name

classmethod delete_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Type Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/delete

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

classmethod delete_view_type_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Type Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewTypeMetadataBulk: POST /api/v4/views/types/metadata/delete

Parameters
classmethod delete_view_view_group_relationship(view_name: str, view_group_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete View View Group Relationship

Permission Required: kelvin.permission.view.delete.

deleteViewViewGroupRelationship: POST /api/v4/views/{view_name}/groups/{view_group_name}/delete

Parameters

  • view_name (str, optional) – View name

  • view_group_name (str, optional) – View Group name

fields: Any = None
classmethod get_view(view_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.View

Get View

Permission Required: kelvin.permission.view.read.

getView: GET /api/v4/views/{view_name}/get

Parameters

  • view_name (str, optional) – View name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_group(view_group_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewGroup

Get View Group

Permission Required: kelvin.permission.view.read.

getViewGroup: GET /api/v4/views/groups/{view_group_name}/get

Parameters

  • view_group_name (str, optional) – View Group name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_group_metadata(view_group_name: str, view_group_metadata_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Get View Group Metadata

Permission Required: kelvin.permission.view.read.

getViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/get

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

classmethod get_view_metadata(view_name: str, view_metadata_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.ViewMetadata

Get View Metadata

Permission Required: kelvin.permission.view.read.

getViewMetadata: GET /api/v4/views/{view_name}/metadata/{view_metadata_name}/get

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

classmethod get_view_type(view_type_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewType

Get View Type

Permission Required: kelvin.permission.view.read.

getViewType: GET /api/v4/views/types/{view_type_name}/get

Parameters

  • view_type_name (str, optional) – View Type name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Get View Type Metadata

Permission Required: kelvin.permission.view.read.

getViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/get

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

classmethod list_view(search: Optional[Sequence[str]] = None, view_type_name: Optional[Sequence[str]] = None, view_group_name: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewItem], kelvin.sdk.client.model.responses.ViewListPaginated]

List View

List $1

Pagination Sortable Columns: view.name

Permission Required: kelvin.permission.view.read.

listView: GET /api/v4/views/list

Parameters

  • search (Sequence[str]) – Search views by name or title

  • view_type_name (Sequence[str]) – Filter views by view type

  • view_group_name (Sequence[str]) – Filter views by view group

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_group(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewGroup], kelvin.sdk.client.model.responses.ViewGroupListPaginated]

List View Group

Pagination Sortable Columns: view_group.name

Permission Required: kelvin.permission.view.read.

listViewGroup: GET /api/v4/views/groups/list

Parameters

  • search (Sequence[str]) – Search View Group by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_group_metadata(view_group_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewGroupMetadata], kelvin.sdk.client.model.responses.ViewGroupMetadataListPaginated]

List View Group Metadata

Pagination Sortable Columns: view_group_metadata.name, view_group_metadata.view_group_name

Permission Required: kelvin.permission.view.read.

listViewGroupMetadata: GET /api/v4/views/groups/{view_group_name}/metadata/list

Parameters

  • view_group_name (str, optional) – View group name

  • search (Sequence[str]) – Search View Group Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_metadata(view_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewMetadata], kelvin.sdk.client.model.responses.ViewMetadataListPaginated]

List View Metadata

Pagination Sortable Columns: view_metadata.name, view_metadata.view_name

Permission Required: kelvin.permission.view.read.

listViewMetadata: GET /api/v4/views/{view_name}/metadata/list

Parameters

  • view_name (str, optional) – View name

  • search (Sequence[str]) – Search View Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_type(search: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewType], kelvin.sdk.client.model.responses.ViewTypeListPaginated]

List View Type

Pagination Sortable Columns: view_type.name

Permission Required: kelvin.permission.view.read.

listViewType: GET /api/v4/views/types/list

Parameters

  • search (Sequence[str]) – Search View Type by name

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_type_metadata(view_type_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewTypeMetadata], kelvin.sdk.client.model.responses.ViewTypeMetadataListPaginated]

List View Type Metadata

Pagination Sortable Columns: view_type_metadata.name, view_type_metadata.view_type_name

Permission Required: kelvin.permission.view.read.

listViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/list

Parameters

  • view_type_name (str, optional) – View Type name

  • search (Sequence[str]) – Search View Type Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metadata: Optional[Dict[str, Any]]
name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_view(view_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.View

Update View

Permission Required: kelvin.permission.view.update.

updateView: POST /api/v4/views/{view_name}/update

Parameters

  • view_name (str, optional) – View name

  • data (requests.ViewUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewUpdate

classmethod update_view_group(view_group_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroup

Update View Group

Permission Required: kelvin.permission.view.update.

updateViewGroup: POST /api/v4/views/groups/{view_group_name}/update

Parameters

  • view_group_name (str, optional) – View Group name

  • data (requests.ViewGroupUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewGroupUpdate

classmethod update_view_group_metadata(view_group_name: str, view_group_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewGroupMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewGroupMetadata

Update View Group Metadata

Permission Required: kelvin.permission.view.update.

updateViewGroupMetadata: POST /api/v4/views/groups/{view_group_name}/metadata/{view_group_metadata_name}/update

Parameters

  • view_group_name (str, optional) – View group name

  • view_group_metadata_name (str, optional) – View Group Metadata name

  • data (requests.ViewGroupMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewGroupMetadataUpdate

classmethod update_view_metadata(view_name: str, view_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewMetadata

Update View Metadata

Permission Required: kelvin.permission.view.update.

updateViewMetadata: POST /api/v4/views/{view_name}/metadata/{view_metadata_name}/update

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

  • data (requests.ViewMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewMetadataUpdate

classmethod update_view_type(view_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewType

Update View Type

Permission Required: kelvin.permission.view.update.

updateViewType: POST /api/v4/views/types/{view_type_name}/update

Parameters

  • view_type_name (str, optional) – View Type name

  • data (requests.ViewTypeUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeUpdate

classmethod update_view_type_metadata(view_type_name: str, view_type_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Update View Type Metadata

Permission Required: kelvin.permission.view.update.

updateViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/update

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

  • data (requests.ViewTypeMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataUpdate

updated: Optional[datetime.datetime]
view_type_name: Optional[str]
class kelvin.sdk.client.model.responses.ViewListPaginated(*, data: List[kelvin.sdk.client.model.responses.ViewItem] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ViewListPaginated object.

Parameters

  • data (Optional[List[ViewItem]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ViewItem]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ViewMetadata(client: Optional[Client] = None, *, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, view_name: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ViewMetadata object.

Parameters

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

  • view_name (Optional[str]) –

classmethod create_view_metadata(view_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewMetadata

Create View Metadata

Permission Required: kelvin.permission.view.create.

createViewMetadata: POST /api/v4/views/{view_name}/metadata/create

Parameters

  • view_name (str, optional) – View name

  • data (requests.ViewMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewMetadataCreate

created: Optional[datetime.datetime]
classmethod delete_view_metadata(view_name: str, view_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewMetadata: POST /api/v4/views/{view_name}/metadata/{view_metadata_name}/delete

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

fields: Any = None
classmethod get_view_metadata(view_name: str, view_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewMetadata

Get View Metadata

Permission Required: kelvin.permission.view.read.

getViewMetadata: GET /api/v4/views/{view_name}/metadata/{view_metadata_name}/get

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

classmethod list_view_metadata(view_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewMetadata], kelvin.sdk.client.model.responses.ViewMetadataListPaginated]

List View Metadata

Pagination Sortable Columns: view_metadata.name, view_metadata.view_name

Permission Required: kelvin.permission.view.read.

listViewMetadata: GET /api/v4/views/{view_name}/metadata/list

Parameters

  • view_name (str, optional) – View name

  • search (Sequence[str]) – Search View Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_view_metadata(view_name: str, view_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewMetadata

Update View Metadata

Permission Required: kelvin.permission.view.update.

updateViewMetadata: POST /api/v4/views/{view_name}/metadata/{view_metadata_name}/update

Parameters

  • view_name (str, optional) – View name

  • view_metadata_name (str, optional) – View Metadata name

  • data (requests.ViewMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewMetadataUpdate

updated: Optional[datetime.datetime]
view_name: Optional[str]
class kelvin.sdk.client.model.responses.ViewMetadataListPaginated(*, data: List[kelvin.sdk.client.model.responses.ViewMetadata] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ViewMetadataListPaginated object.

Parameters

  • data (Optional[List[ViewMetadata]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ViewMetadata]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ViewMetric(client: Optional[Client] = None, *, asset_name: str = None, name: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ViewMetric object.

Parameters

  • asset_name (Optional[str]) –

  • name (Optional[str]) –

asset_name: Optional[str]
fields: Any = None
name: Optional[str]
schema: Any = None
class kelvin.sdk.client.model.responses.ViewType(client: Optional[Client] = None, *, created: datetime.datetime = None, metadata: Dict[str, Any] = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, title: kelvin.sdk.client.data_model.ConstrainedStrValue = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ViewType object.

Parameters

  • created (Optional[datetime]) –

  • metadata (Optional[Dict[str, Any]]) –

  • name (Optional[str]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

classmethod create_view_type(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewType

Create View Type

Permission Required: kelvin.permission.view.create.

createViewType: POST /api/v4/views/types/create

Parameters
classmethod create_view_type_metadata(view_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Create View Type Metadata

Permission Required: kelvin.permission.view.create.

createViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/create

Parameters

  • view_type_name (str, optional) – View Type name

  • data (requests.ViewTypeMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataCreate

classmethod create_view_type_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataBulkCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Create View Type Metadata Bulk

Permission Required: kelvin.permission.view.create.

createViewTypeMetadataBulk: POST /api/v4/views/types/metadata/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_view_type(view_type_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Type

Permission Required: kelvin.permission.view.delete.

deleteViewType: POST /api/v4/views/types/{view_type_name}/delete

Parameters

view_type_name (str, optional) – View Type name

classmethod delete_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Type Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/delete

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

classmethod delete_view_type_metadata_bulk(data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataBulkDelete, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → None

Delete View Type Metadata Bulk

Permission Required: kelvin.permission.view.delete.

deleteViewTypeMetadataBulk: POST /api/v4/views/types/metadata/delete

Parameters
fields: Any = None
classmethod get_view_type(view_type_name: str, metadata: Optional[Sequence[str]] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewType

Get View Type

Permission Required: kelvin.permission.view.read.

getViewType: GET /api/v4/views/types/{view_type_name}/get

Parameters

  • view_type_name (str, optional) – View Type name

  • metadata (Sequence[str]) – Inject metadata into the response

classmethod get_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Get View Type Metadata

Permission Required: kelvin.permission.view.read.

getViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/get

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

classmethod list_view_type(search: Optional[Sequence[str]] = None, metadata: Optional[Sequence[str]] = None, metadata_filter: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewType], kelvin.sdk.client.model.responses.ViewTypeListPaginated]

List View Type

Pagination Sortable Columns: view_type.name

Permission Required: kelvin.permission.view.read.

listViewType: GET /api/v4/views/types/list

Parameters

  • search (Sequence[str]) – Search View Type by name

  • metadata (Sequence[str]) – Inject metadata into the response

  • metadata_filter (Sequence[str]) – Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_view_type_metadata(view_type_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewTypeMetadata], kelvin.sdk.client.model.responses.ViewTypeMetadataListPaginated]

List View Type Metadata

Pagination Sortable Columns: view_type_metadata.name, view_type_metadata.view_type_name

Permission Required: kelvin.permission.view.read.

listViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/list

Parameters

  • view_type_name (str, optional) – View Type name

  • search (Sequence[str]) – Search View Type Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

metadata: Optional[Dict[str, Any]]
name: Optional[str]
schema: Any = None
title: Optional[str]
classmethod update_view_type(view_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewType

Update View Type

Permission Required: kelvin.permission.view.update.

updateViewType: POST /api/v4/views/types/{view_type_name}/update

Parameters

  • view_type_name (str, optional) – View Type name

  • data (requests.ViewTypeUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeUpdate

classmethod update_view_type_metadata(view_type_name: str, view_type_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Update View Type Metadata

Permission Required: kelvin.permission.view.update.

updateViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/update

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

  • data (requests.ViewTypeMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataUpdate

updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.ViewTypeListPaginated(*, data: List[kelvin.sdk.client.model.responses.ViewType] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ViewTypeListPaginated object.

Parameters

  • data (Optional[List[ViewType]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ViewType]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.ViewTypeMetadata(client: Optional[Client] = None, *, created: datetime.datetime = None, name: kelvin.sdk.client.data_model.ConstrainedStrValue = None, payload: Dict[str, Any] = None, updated: datetime.datetime = None, view_typename: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

ViewTypeMetadata object.

Parameters

  • created (Optional[datetime]) –

  • name (Optional[str]) –

  • payload (Optional[Dict[str, Any]]) –

  • updated (Optional[datetime]) –

  • view_typename (Optional[str]) –

classmethod create_view_type_metadata(view_type_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Create View Type Metadata

Permission Required: kelvin.permission.view.create.

createViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/create

Parameters

  • view_type_name (str, optional) – View Type name

  • data (requests.ViewTypeMetadataCreate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataCreate

created: Optional[datetime.datetime]
classmethod delete_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → None

Delete View Type Metadata

Permission Required: kelvin.permission.view.delete.

deleteViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/delete

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

fields: Any = None
classmethod get_view_type_metadata(view_type_name: str, view_type_metadata_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Get View Type Metadata

Permission Required: kelvin.permission.view.read.

getViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/get

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

classmethod list_view_type_metadata(view_type_name: str, search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.ViewTypeMetadata], kelvin.sdk.client.model.responses.ViewTypeMetadataListPaginated]

List View Type Metadata

Pagination Sortable Columns: view_type_metadata.name, view_type_metadata.view_type_name

Permission Required: kelvin.permission.view.read.

listViewTypeMetadata: GET /api/v4/views/types/{view_type_name}/metadata/list

Parameters

  • view_type_name (str, optional) – View Type name

  • search (Sequence[str]) – Search View Type Metadata by name

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod update_view_type_metadata(view_type_name: str, view_type_metadata_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.ViewTypeMetadataUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.ViewTypeMetadata

Update View Type Metadata

Permission Required: kelvin.permission.view.update.

updateViewTypeMetadata: POST /api/v4/views/types/{view_type_name}/metadata/{view_type_metadata_name}/update

Parameters

  • view_type_name (str, optional) – View Type name

  • view_type_metadata_name (str, optional) – View Type Metadata name

  • data (requests.ViewTypeMetadataUpdate, optional) –

  • **kwargs – Extra parameters for requests.ViewTypeMetadataUpdate

updated: Optional[datetime.datetime]
view_typename: Optional[str]
class kelvin.sdk.client.model.responses.ViewTypeMetadataListPaginated(*, data: List[kelvin.sdk.client.model.responses.ViewTypeMetadata] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

ViewTypeMetadataListPaginated object.

Parameters

  • data (Optional[List[ViewTypeMetadata]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.ViewTypeMetadata]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.WireguardPeer(client: Optional[Client] = None, *, allowed_ips: List[str] = None, created: datetime.datetime = None, endpoint: str = None, name: str = None, public_key: str = None, title: str = None, type: str = None, updated: datetime.datetime = None, wireguard_ip: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WireguardPeer object.

Parameters

  • allowed_ips (Optional[List[str]]) –

  • created (Optional[datetime]) –

  • endpoint (Optional[str]) –

  • name (Optional[str]) –

  • public_key (Optional[str]) –

  • title (Optional[str]) –

  • type (Optional[str]) –

  • updated (Optional[datetime]) –

  • wireguard_ip (Optional[str]) –

allowed_ips: Optional[List[str]]
classmethod create_wireguard_peer(data: Optional[Union[kelvin.sdk.client.model.requests.WireguardPeerCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.WireguardPeer

Create Wireguard Peer

Permission Required: kelvin.permission.acp.create.

createWireguardPeer: POST /api/v4/wireguard/peers/create

Parameters
classmethod create_wireguard_tunnel(peer_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.WireguardTunnelCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Optional[Any] = None, **kwargs: Any) → kelvin.sdk.client.model.responses.WireguardTunnel

Create Wireguard Tunnel

Permission Required: kelvin.permission.acp.create.

createWireguardTunnel: POST /api/v4/wireguard/peers/{peer_name}/tunnels/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_wireguard_peer(peer_name: str, dry_run: bool = False, client: Optional[Any] = None) → None

Delete Wireguard Peer

Permission Required: kelvin.permission.acp.delete.

deleteWireguardPeer: POST /api/v4/wireguard/peers/{peer_name}/delete

Parameters

peer_name (str, optional) – Peer name

classmethod delete_wireguard_tunnel(peer_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WireguardTunnel

Delete Wireguard Tunnel

Permission Required: kelvin.permission.acp.delete.

deleteWireguardTunnel: POST /api/v4/wireguard/peers/{peer_name}/tunnels/delete

Parameters

peer_name (str, optional) – Source peer

endpoint: Optional[str]
fields: Any = None
classmethod get_wireguard_graph(format: Optional[str] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WireguardTunnel

Get Wireguard Graph returns a visual representation of all the tunnels in the system

Permission Required: kelvin.permission.acp.read.

getWireguardGraph: POST /api/v4/wireguard/peers/tunnels/graph/get

Parameters

format (str) – Desired return format (svg or dot)

classmethod get_wireguard_peer(peer_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WireguardPeer

Get Wireguard Peer

Permission Required: kelvin.permission.acp.read.

getWireguardPeer: GET /api/v4/wireguard/peers/{peer_name}/get

Parameters

peer_name (str, optional) – Peer name

classmethod list_wireguard_peer(search: Optional[Sequence[str]] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.WireguardPeer], kelvin.sdk.client.model.responses.WireguardPeerListPaginated]

List Wireguard Peer

Pagination Sortable Columns: wireguard_peer.name

Permission Required: kelvin.permission.acp.read.

listWireguardPeer: GET /api/v4/wireguard/peers/list

Parameters

  • search (Sequence[str]) – Search Peers by name, title or public key

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

classmethod list_wireguard_tunnel(peer_name: str, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.WireguardPeer], kelvin.sdk.client.model.responses.WireguardPeerListPaginated]

List Wireguard Tunnel

Pagination Sortable Columns: wireguard_tunnel.wg_src, wireguard_tunnel.wg_peer

Permission Required: kelvin.permission.acp.read.

listWireguardTunnel: GET /api/v4/wireguard/peers/{peer_name}/tunnels/list

Parameters

  • peer_name (str, optional) – Source peer

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
public_key: Optional[str]
schema: Any = None
title: Optional[str]
type: Optional[str]
classmethod update_wireguard_peer(peer_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.WireguardPeerUpdate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.WireguardPeer

Update Wireguard Peer

Permission Required: kelvin.permission.acp.update.

updateWireguardPeer: POST /api/v4/wireguard/peers/{peer_name}/update

Parameters
updated: Optional[datetime.datetime]
wireguard_ip: Optional[str]
class kelvin.sdk.client.model.responses.WireguardPeerListPaginated(*, data: List[kelvin.sdk.client.model.responses.WireguardPeer] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

WireguardPeerListPaginated object.

Parameters

  • data (Optional[List[WireguardPeer]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.WireguardPeer]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.WireguardTunnel(client: Optional[Client] = None, *, created: datetime.datetime = None, keep_alive: int = None, updated: datetime.datetime = None, wireguard_peer: str = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WireguardTunnel object.

Parameters

  • created (Optional[datetime]) –

  • keep_alive (Optional[int]) –

  • updated (Optional[datetime]) –

  • wireguard_peer (Optional[str]) –

classmethod create_wireguard_tunnel(peer_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.WireguardTunnelCreate, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.WireguardTunnel

Create Wireguard Tunnel

Permission Required: kelvin.permission.acp.create.

createWireguardTunnel: POST /api/v4/wireguard/peers/{peer_name}/tunnels/create

Parameters
created: Optional[datetime.datetime]
classmethod delete_wireguard_tunnel(peer_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WireguardTunnel

Delete Wireguard Tunnel

Permission Required: kelvin.permission.acp.delete.

deleteWireguardTunnel: POST /api/v4/wireguard/peers/{peer_name}/tunnels/delete

Parameters

peer_name (str, optional) – Source peer

fields: Any = None
classmethod get_wireguard_graph(format: Optional[str] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WireguardTunnel

Get Wireguard Graph returns a visual representation of all the tunnels in the system

Permission Required: kelvin.permission.acp.read.

getWireguardGraph: POST /api/v4/wireguard/peers/tunnels/graph/get

Parameters

format (str) – Desired return format (svg or dot)

keep_alive: Optional[int]
classmethod list_wireguard_tunnel(peer_name: str, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.WireguardPeer], kelvin.sdk.client.model.responses.WireguardPeerListPaginated]

List Wireguard Tunnel

Pagination Sortable Columns: wireguard_tunnel.wg_src, wireguard_tunnel.wg_peer

Permission Required: kelvin.permission.acp.read.

listWireguardTunnel: GET /api/v4/wireguard/peers/{peer_name}/tunnels/list

Parameters

  • peer_name (str, optional) – Source peer

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

schema: Any = None
updated: Optional[datetime.datetime]
wireguard_peer: Optional[str]
class kelvin.sdk.client.model.responses.Workload(client: Optional[Client] = None, *, acp_name: str = None, app_name: str = None, app_version: str = None, created: datetime.datetime = None, enabled: bool = None, name: str = None, networking: List[kelvin.sdk.client.model.responses.NetworkingItem] = None, payload: Dict[str, Any] = None, title: str = None, updated: datetime.datetime = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

Workload object.

Parameters

  • acp_name (Optional[str]) –

  • app_name (Optional[str]) –

  • app_version (Optional[str]) –

  • created (Optional[datetime]) –

  • enabled (Optional[bool]) –

  • name (Optional[str]) –

  • networking (Optional[List[NetworkingItem]]) –

  • payload (Optional[Dict[str, Any]]) –

  • title (Optional[str]) –

  • updated (Optional[datetime]) –

acp_name: Optional[str]
app_name: Optional[str]
app_version: Optional[str]
created: Optional[datetime.datetime]
classmethod deploy_workload(data: Optional[Union[kelvin.sdk.client.model.requests.WorkloadDeploy, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → kelvin.sdk.client.model.responses.Workload

Deploy Workload

Permission Required: kelvin.permission.workload.update.

deployWorkload: POST /api/v4/workloads/deploy

Parameters
enabled: Optional[bool]
fields: Any = None
classmethod get_workload(workload_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.Workload

Get Workload

Permission Required: kelvin.permission.workload.read.

getWorkload: GET /api/v4/workloads/{workload_name}/get

Parameters

workload_name (str, optional) – Workload name

classmethod get_workload_logs(workload_name: str, tail_lines: Optional[str] = None, since_time: Optional[str] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.WorkloadLogs

Get Workload Logs

Permission Required: kelvin.permission.workload.read.

getWorkloadLogs: GET /api/v4/workloads/{workload_name}/logs/get

Parameters

  • workload_name (str, optional) – Workload name

  • tail_lines (str) – The number of lines from the end of the logs to show

  • since_time (str) – A timestamp from which to show logs

classmethod get_workload_metrics(workload_name: str, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.WorkloadMetrics

Get Workload Metrics

Permission Required: kelvin.permission.workload.read.

getWorkloadMetrics: GET /api/v4/workloads/{workload_name}/metrics/get

Parameters

workload_name (str, optional) – Workload name

classmethod get_workload_status(workload_name: str, source: Optional[str] = None, dry_run: bool = False, client: Any = None) → kelvin.sdk.client.model.responses.WorkloadStatusItem

Get Workload Status

Permission Required: kelvin.permission.workload.read.

getWorkloadStatus: GET /api/v4/workloads/{workload_name}/status/get

Parameters

  • workload_name (str, optional) – Workload name

  • source (str) – Source should be ‘cache’ or ‘live’ (default is cache)

classmethod list_workload(app_name: Optional[Sequence[str]] = None, app_version: Optional[Sequence[str]] = None, acp_name: Optional[Sequence[str]] = None, workload_name: Optional[Sequence[str]] = None, enabled: Optional[bool] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, search: Optional[Sequence[str]] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.Workload], kelvin.sdk.client.model.responses.WorkloadListPaginated]

List Workload

Pagination Sortable Columns: workload.name, `workload.enabled

Permission Required: kelvin.permission.workload.read.

listWorkload: GET /api/v4/workloads/list

Parameters

  • app_name (Sequence[str]) – App Name

  • app_version (Sequence[str]) – App Version

  • acp_name (Sequence[str]) – ACP Name

  • workload_name (Sequence[str]) – Workload Name

  • enabled (bool) – Filter workloads by enabled status

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

  • search (Sequence[str]) – Search workloads by name, title, App name and ACP name

classmethod list_workload_status(app_name: Optional[Sequence[str]] = None, app_version: Optional[Sequence[str]] = None, acp_name: Optional[Sequence[str]] = None, workload_name: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, source: Optional[str] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Any = None) → Union[Sequence[kelvin.sdk.client.model.responses.WorkloadStatusItem], kelvin.sdk.client.model.responses.WorkloadStatusListPaginated]

List Workload Status

Pagination Sortable Columns: workload.status

Permission Required: kelvin.permission.workload.read.

listWorkloadStatus: GET /api/v4/workloads/status/list

Parameters

  • app_name (Sequence[str]) – App Name

  • app_version (Sequence[str]) – App Version

  • acp_name (Sequence[str]) – ACP Name

  • workload_name (Sequence[str]) – Workload Name

  • search (Sequence[str]) – Search Workloads by title and name

  • source (str) – Source should be ‘cache’ or ‘live’ (default is cache)

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
networking: Optional[List[kelvin.sdk.client.model.responses.NetworkingItem]]
payload: Optional[Dict[str, Any]]
schema: Any = None
classmethod start_workload(workload_name: str, dry_run: bool = False, client: Any = None) → None

Start Workload

Permission Required: kelvin.permission.workload.update.

startWorkload: GET /api/v4/workloads/{workload_name}/start

Parameters

workload_name (str, optional) – Workload name

classmethod stop_workload(workload_name: str, dry_run: bool = False, client: Any = None) → None

Stop Workload

Permission Required: kelvin.permission.workload.update.

stopWorkload: GET /api/v4/workloads/{workload_name}/stop

Parameters

workload_name (str, optional) – Workload name

title: Optional[str]
classmethod undeploy_workload(workload_name: str, data: Optional[Union[kelvin.sdk.client.model.requests.WorkloadUndeployOptions, Mapping[str, Any]]] = None, dry_run: bool = False, client: Any = None, **kwargs: Any) → None

Undeploy Workload

Permission Required: kelvin.permission.workload.delete.

undeployWorkload: POST /api/v4/workloads/{workload_name}/undeploy

Parameters
updated: Optional[datetime.datetime]
class kelvin.sdk.client.model.responses.WorkloadAllocation(client: Optional[Client] = None, *, cpu_requests: float = None, memory_requests: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadAllocation object.

Parameters

  • cpu_requests (Optional[float]) –

  • memory_requests (Optional[float]) –

cpu_requests: Optional[float]
fields: Any = None
memory_requests: Optional[float]
schema: Any = None
class kelvin.sdk.client.model.responses.WorkloadCPUUtilization(client: Optional[Client] = None, *, timestamp: int = None, value: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadCPUUtilization object.

Parameters

  • timestamp (Optional[int]) –

  • value (Optional[float]) –

fields: Any = None
schema: Any = None
timestamp: Optional[int]
value: Optional[float]
class kelvin.sdk.client.model.responses.WorkloadListPaginated(*, data: List[kelvin.sdk.client.model.responses.Workload] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

WorkloadListPaginated object.

Parameters

  • data (Optional[List[Workload]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.Workload]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None
class kelvin.sdk.client.model.responses.WorkloadLogs(client: Optional[Client] = None, *, logs: Dict[str, List[str]] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadLogs object.

Parameters

logs (Optional[Dict[str, List[str]]]) –

fields: Any = None
classmethod get_workload_logs(workload_name: str, tail_lines: Optional[str] = None, since_time: Optional[str] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WorkloadLogs

Get Workload Logs

Permission Required: kelvin.permission.workload.read.

getWorkloadLogs: GET /api/v4/workloads/{workload_name}/logs/get

Parameters

  • workload_name (str, optional) – Workload name

  • tail_lines (str) – The number of lines from the end of the logs to show

  • since_time (str) – A timestamp from which to show logs

logs: Optional[Dict[str, List[str]]]
schema: Any = None
class kelvin.sdk.client.model.responses.WorkloadMemoryUsage(client: Optional[Client] = None, *, timestamp: int = None, value: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadMemoryUsage object.

Parameters

  • timestamp (Optional[int]) –

  • value (Optional[float]) –

fields: Any = None
schema: Any = None
timestamp: Optional[int]
value: Optional[float]
class kelvin.sdk.client.model.responses.WorkloadMetrics(client: Optional[Client] = None, *, allocation: kelvin.sdk.client.model.responses.WorkloadAllocation = None, cpu_utilization: List[kelvin.sdk.client.model.responses.WorkloadCPUUtilization] = None, memory_usage: List[kelvin.sdk.client.model.responses.WorkloadMemoryUsage] = None, network: kelvin.sdk.client.model.responses.WorkloadNetwork = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadMetrics object.

Parameters
allocation: Optional[kelvin.sdk.client.model.responses.WorkloadAllocation]
cpu_utilization: Optional[List[kelvin.sdk.client.model.responses.WorkloadCPUUtilization]]
fields: Any = None
classmethod get_workload_metrics(workload_name: str, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WorkloadMetrics

Get Workload Metrics

Permission Required: kelvin.permission.workload.read.

getWorkloadMetrics: GET /api/v4/workloads/{workload_name}/metrics/get

Parameters

workload_name (str, optional) – Workload name

memory_usage: Optional[List[kelvin.sdk.client.model.responses.WorkloadMemoryUsage]]
network: Optional[kelvin.sdk.client.model.responses.WorkloadNetwork]
schema: Any = None
class kelvin.sdk.client.model.responses.WorkloadNetwork(client: Optional[Client] = None, *, total_rx: float = None, total_tx: float = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadNetwork object.

Parameters

  • total_rx (Optional[float]) –

  • total_tx (Optional[float]) –

fields: Any = None
schema: Any = None
total_rx: Optional[float]
total_tx: Optional[float]
class kelvin.sdk.client.model.responses.WorkloadStatus(client: Optional[Client] = None, *, last_seen: datetime.datetime = None, message: str = None, state: str = None, warnings: List[str] = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadStatus object.

Parameters

  • last_seen (Optional[datetime]) –

  • message (Optional[str]) –

  • state (Optional[str]) –

  • warnings (Optional[List[str]]) –

fields: Any = None
last_seen: Optional[datetime.datetime]
message: Optional[str]
schema: Any = None
state: Optional[str]
warnings: Optional[List[str]]
class kelvin.sdk.client.model.responses.WorkloadStatusItem(client: Optional[Client] = None, *, name: str = None, status: kelvin.sdk.client.model.responses.WorkloadStatus = None, **kwargs: Any)

Bases: pydantic.main.BaseModel, Mapping[str, Any]

WorkloadStatusItem object.

Parameters
fields: Any = None
classmethod get_workload_status(workload_name: str, source: Optional[str] = None, dry_run: bool = False, client: Optional[Any] = None) → kelvin.sdk.client.model.responses.WorkloadStatusItem

Get Workload Status

Permission Required: kelvin.permission.workload.read.

getWorkloadStatus: GET /api/v4/workloads/{workload_name}/status/get

Parameters

  • workload_name (str, optional) – Workload name

  • source (str) – Source should be ‘cache’ or ‘live’ (default is cache)

classmethod list_workload_status(app_name: Optional[Sequence[str]] = None, app_version: Optional[Sequence[str]] = None, acp_name: Optional[Sequence[str]] = None, workload_name: Optional[Sequence[str]] = None, search: Optional[Sequence[str]] = None, source: Optional[str] = None, page_size: Optional[int] = None, starting_after: Optional[str] = None, ending_before: Optional[str] = None, sort_by: Optional[str] = None, sort_asc: Optional[bool] = None, fetch: bool = True, dry_run: bool = False, client: Optional[Any] = None) → Union[Sequence[kelvin.sdk.client.model.responses.WorkloadStatusItem], kelvin.sdk.client.model.responses.WorkloadStatusListPaginated]

List Workload Status

Pagination Sortable Columns: workload.status

Permission Required: kelvin.permission.workload.read.

listWorkloadStatus: GET /api/v4/workloads/status/list

Parameters

  • app_name (Sequence[str]) – App Name

  • app_version (Sequence[str]) – App Version

  • acp_name (Sequence[str]) – ACP Name

  • workload_name (Sequence[str]) – Workload Name

  • search (Sequence[str]) – Search Workloads by title and name

  • source (str) – Source should be ‘cache’ or ‘live’ (default is cache)

  • page_size (int) – Number of objects to be returned, between 1 and 1000. Default: 20

  • starting_after (str) – Lower bound cursor for use in pagination

  • ending_before (str) – Upper bound cursor for use in pagination

  • sort_by (str) – Parameter to sort by. Must be one of the sortable columns

  • sort_asc (bool) – Order of sorting is Ascending. Possible Values: true/false. Default: true

name: Optional[str]
schema: Any = None
status: Optional[kelvin.sdk.client.model.responses.WorkloadStatus]
class kelvin.sdk.client.model.responses.WorkloadStatusListPaginated(*, data: List[kelvin.sdk.client.model.responses.WorkloadStatusItem] = None, pagination: kelvin.sdk.client.model.pagination.Pagination = None, **kwargs: Any)

Bases: kelvin.sdk.client.data_model.[kelvin.sdk.client.model.responses.]

WorkloadStatusListPaginated object.

Parameters

  • data (Optional[List[WorkloadStatusItem]]) –

  • pagination (Optional[pagination.Pagination]) –

data: Optional[List[kelvin.sdk.client.model.responses.WorkloadStatusItem]]
fields: Any = None
pagination: Optional[kelvin.sdk.client.model.pagination.Pagination]
schema: Any = None