Core Data Model

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360Image( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, translation_x: float | None = None, translation_y: float | None = None, translation_z: float | None = None, euler_rotation_x: float | None = None, euler_rotation_y: float | None = None, euler_rotation_z: float | None = None, scale_x: float | None = None, scale_y: float | None = None, scale_z: float | None = None, front: DirectRelationReference | None = None, back: DirectRelationReference | None = None, left: DirectRelationReference | None = None, right: DirectRelationReference | None = None, top: DirectRelationReference | None = None, bottom: DirectRelationReference | None = None, collection_360: DirectRelationReference | None = None, station_360: DirectRelationReference | None = None, taken_at: datetime | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite360ImageProperties, TypedNode

This represents the reading format of Cognite 360 image.

It is used when data is read from CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
translation_x (float | None) – The displacement of the object along the X-axis in the 3D coordinate system
translation_y (float | None) – The displacement of the object along the Y-axis in the 3D coordinate system
translation_z (float | None) – The displacement of the object along the Z-axis in the 3D coordinate system
euler_rotation_x (float | None) – The rotation of the object around the X-axis in radians
euler_rotation_y (float | None) – The rotation of the object around the Y-axis in radians
euler_rotation_z (float | None) – The rotation of the object around the Z-axis in radians
scale_x (float | None) – The scaling factor applied to the object along the X-axis
scale_y (float | None) – The scaling factor applied to the object along the Y-axis
scale_z (float | None) – The scaling factor applied to the object along the Z-axis
front (DirectRelationReference | None) – Direct relation to a file holding the front projection of the cube map
back (DirectRelationReference | None) – Direct relation to a file holding the back projection of the cube map
left (DirectRelationReference | None) – Direct relation to a file holding the left projection of the cube map
right (DirectRelationReference | None) – Direct relation to a file holding the right projection of the cube map
top (DirectRelationReference | None) – Direct relation to a file holding the top projection of the cube map
bottom (DirectRelationReference | None) – Direct relation to a file holding the bottom projection of the cube map
collection_360 (DirectRelationReference | None) – Direct relation to Cognite360ImageCollection
station_360 (DirectRelationReference | None) – Direct relation to Cognite3DGroup instance that groups different Cognite360Image instances to the same station
taken_at (datetime | None) – The timestamp when the 6 photos were taken
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageAnnotation( space: str, external_id: str, type: DirectRelationReference, start_node: DirectRelationReference, end_node: DirectRelationReference, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, confidence: float | None = None, status: Literal['Approved', 'Rejected', 'Suggested'] | None = None, polygon: list[float] | None = None, format_version: str | None = None, deleted_time: int | None = None, )

Bases: _Cognite360ImageAnnotationProperties, TypedEdge

This represents the reading format of Cognite 360 image annotation.

It is used when data is read from CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image annotation.
type (DirectRelationReference) – The type of edge.
start_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
confidence (float | None) – The confidence that the annotation is a good match
status (Literal['Approved', 'Rejected', 'Suggested'] | None) – The status of the annotation
polygon (list[float] | None) – List of floats representing the polygon. Format depends on formatVersion
format_version (str | None) – Specifies the storage representation for the polygon
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageAnnotationApply(space: str, external_id: str, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], start_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], end_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, confidence: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, status: ~typing.Literal['Approved', 'Rejected', 'Suggested'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, polygon: list[float] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, format_version: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None)

Bases: _Cognite360ImageAnnotationProperties, TypedEdgeApply

This represents the writing format of Cognite 360 image annotation.

It is used when data is written to CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image annotation.
type (DirectRelationReference | tuple[str, str]) – The type of edge.
start_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
confidence (float | None | Omitted) – The confidence that the annotation is a good match
status (Literal['Approved', 'Rejected', 'Suggested'] | None | Omitted) – The status of the annotation
polygon (list[float] | None | Omitted) – List of floats representing the polygon. Format depends on formatVersion
format_version (str | None | Omitted) – Specifies the storage representation for the polygon
existing_version (int | None) – Fail the ingestion request if the edge’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the edge (for the specified container or edge). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageApply( space: str, external_id: str, *, translation_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, translation_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, translation_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, front: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, back: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, left: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, right: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, top: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, bottom: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, collection_360: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, station_360: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, taken_at: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite360ImageProperties, TypedNodeApply

This represents the writing format of Cognite 360 image.

It is used when data is written to CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image.
translation_x (float | None | Omitted) – The displacement of the object along the X-axis in the 3D coordinate system
translation_y (float | None | Omitted) – The displacement of the object along the Y-axis in the 3D coordinate system
translation_z (float | None | Omitted) – The displacement of the object along the Z-axis in the 3D coordinate system
euler_rotation_x (float | None | Omitted) – The rotation of the object around the X-axis in radians
euler_rotation_y (float | None | Omitted) – The rotation of the object around the Y-axis in radians
euler_rotation_z (float | None | Omitted) – The rotation of the object around the Z-axis in radians
scale_x (float | None | Omitted) – The scaling factor applied to the object along the X-axis
scale_y (float | None | Omitted) – The scaling factor applied to the object along the Y-axis
scale_z (float | None | Omitted) – The scaling factor applied to the object along the Z-axis
front (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the front projection of the cube map
back (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the back projection of the cube map
left (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the left projection of the cube map
right (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the right projection of the cube map
top (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the top projection of the cube map
bottom (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the bottom projection of the cube map
collection_360 (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to Cognite360ImageCollection
station_360 (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to Cognite3DGroup instance that groups different Cognite360Image instances to the same station
taken_at (datetime | None | Omitted) – The timestamp when the 6 photos were taken
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageCollection( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, status: Literal['Done', 'Failed', 'Processing', 'Queued'] | None = None, published: bool | None = None, revision_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, model_3d: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite360ImageCollectionProperties, TypedNode

This represents the reading format of Cognite 360 image collection.

It is used when data is read from CDF.

Represents a logical collection of Cognite360Image instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image collection.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None) – The status field.
published (bool | None) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – The revision type field.
model_3d (DirectRelationReference | None) – The model 3d field.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageCollectionApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, status: ~typing.Literal['Done', 'Failed', 'Processing', 'Queued'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, published: bool | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revision_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite360ImageCollectionProperties, TypedNodeApply

This represents the writing format of Cognite 360 image collection.

It is used when data is written to CDF.

Represents a logical collection of Cognite360Image instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image collection.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None | Omitted) – The status field.
published (bool | None | Omitted) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – The revision type field.
model_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – The model 3d field.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageModel( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, model_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, thumbnail: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite360ImageModelProperties, TypedNode

This represents the reading format of Cognite 360 image model.

It is used when data is read from CDF.

Navigational aid for traversing Cognite360ImageModel instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image model.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | None) – Thumbnail of the 3D model
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageModelApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, thumbnail: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite360ImageModelProperties, TypedNodeApply

This represents the writing format of Cognite 360 image model.

It is used when data is written to CDF.

Navigational aid for traversing Cognite360ImageModel instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image model.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | tuple[str, str] | None | Omitted) – Thumbnail of the 3D model
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageStation( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, group_type: Literal['Station360'] | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite360ImageStationProperties, TypedNode

This represents the reading format of Cognite 360 image station.

It is used when data is read from CDF.

A way to group images across collections. Used for creating visual scan history

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image station.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
group_type (Literal['Station360'] | None) – Type of group
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite360ImageStationApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, group_type: ~typing.Literal['Station360'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite360ImageStationProperties, TypedNodeApply

This represents the writing format of Cognite 360 image station.

It is used when data is written to CDF.

A way to group images across collections. Used for creating visual scan history

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 360 image station.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
group_type (Literal['Station360'] | None | Omitted) – Type of group
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DModel( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, model_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, thumbnail: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite3DModelProperties, TypedNode

This represents the reading format of Cognite 3D model.

It is used when data is read from CDF.

Groups revisions of 3D data of various kinds together (CAD, PointCloud, Image360)

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D model.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | None) – Thumbnail of the 3D model
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DModelApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, thumbnail: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite3DModelProperties, TypedNodeApply

This represents the writing format of Cognite 3D model.

It is used when data is written to CDF.

Groups revisions of 3D data of various kinds together (CAD, PointCloud, Image360)

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D model.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | tuple[str, str] | None | Omitted) – Thumbnail of the 3D model
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DObject( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, x_min: float | None = None, x_max: float | None = None, y_min: float | None = None, y_max: float | None = None, z_min: float | None = None, z_max: float | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite3DObjectProperties, TypedNode

This represents the reading format of Cognite 3D object.

It is used when data is read from CDF.

This is the virtual position representation of an object in the physical world, connecting an asset to one or more 3D resources

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D object.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
x_min (float | None) – Lowest X value in bounding box
x_max (float | None) – Highest X value in bounding box
y_min (float | None) – Lowest Y value in bounding box
y_max (float | None) – Highest Y value in bounding box
z_min (float | None) – Lowest Z value in bounding box
z_max (float | None) – Highest Z value in bounding box
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DObjectApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, x_min: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, x_max: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, y_min: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, y_max: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, z_min: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, z_max: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite3DObjectProperties, TypedNodeApply

This represents the writing format of Cognite 3D object.

It is used when data is written to CDF.

This is the virtual position representation of an object in the physical world, connecting an asset to one or more 3D resources

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D object.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
x_min (float | None | Omitted) – Lowest X value in bounding box
x_max (float | None | Omitted) – Highest X value in bounding box
y_min (float | None | Omitted) – Lowest Y value in bounding box
y_max (float | None | Omitted) – Highest Y value in bounding box
z_min (float | None | Omitted) – Lowest Z value in bounding box
z_max (float | None | Omitted) – Highest Z value in bounding box
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DRevision( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, status: Literal['Done', 'Failed', 'Processing', 'Queued'] | None = None, published: bool | None = None, revision_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, model_3d: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite3DRevisionProperties, TypedNode

This represents the reading format of Cognite 3D revision.

It is used when data is read from CDF.

Shared revision information for various 3D data types. Normally not used directly, but through CognitePointCloudRevision, Image360Collection or CogniteCADRevision

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D revision.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None) – The status field.
published (bool | None) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – The revision type field.
model_3d (DirectRelationReference | None) – The model 3d field.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DRevisionApply( space: str, external_id: str, *, status: ~typing.Literal['Done', 'Failed', 'Processing', 'Queued'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, published: bool | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revision_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite3DRevisionProperties, TypedNodeApply

This represents the writing format of Cognite 3D revision.

It is used when data is written to CDF.

Shared revision information for various 3D data types. Normally not used directly, but through CognitePointCloudRevision, Image360Collection or CogniteCADRevision

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D revision.
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None | Omitted) – The status field.
published (bool | None | Omitted) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – The revision type field.
model_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – The model 3d field.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DTransformationEdge( space: str, external_id: str, type: DirectRelationReference, start_node: DirectRelationReference, end_node: DirectRelationReference, version: int, last_updated_time: int, created_time: int, *, translation_x: float | None = None, translation_y: float | None = None, translation_z: float | None = None, euler_rotation_x: float | None = None, euler_rotation_y: float | None = None, euler_rotation_z: float | None = None, scale_x: float | None = None, scale_y: float | None = None, scale_z: float | None = None, deleted_time: int | None = None, )

Bases: _Cognite3DTransformationProperties, TypedEdge

This represents the reading format of Cognite 3D transformation edge.

It is used when data is read from CDF.

The Cognite3DTransformation object defines a comprehensive 3D transformation, enabling precise adjustments to an object’s position, orientation, and size in the 3D coordinate system. It allows for the translation of objects along the three spatial axes, rotation around these axes using Euler angles, and scaling along each axis to modify the object’s dimensions. The object’s transformation is defined in “CDF space”, a coordinate system where the positive Z axis is the up direction

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D transformation edge.
type (DirectRelationReference) – The type of edge.
start_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
translation_x (float | None) – The displacement of the object along the X-axis in the 3D coordinate system
translation_y (float | None) – The displacement of the object along the Y-axis in the 3D coordinate system
translation_z (float | None) – The displacement of the object along the Z-axis in the 3D coordinate system
euler_rotation_x (float | None) – The rotation of the object around the X-axis in radians
euler_rotation_y (float | None) – The rotation of the object around the Y-axis in radians
euler_rotation_z (float | None) – The rotation of the object around the Z-axis in radians
scale_x (float | None) – The scaling factor applied to the object along the X-axis
scale_y (float | None) – The scaling factor applied to the object along the Y-axis
scale_z (float | None) – The scaling factor applied to the object along the Z-axis
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DTransformationEdgeApply(space: str, external_id: str, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], start_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], end_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], *, translation_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, translation_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, translation_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None)

Bases: _Cognite3DTransformationProperties, TypedEdgeApply

This represents the writing format of Cognite 3D transformation edge.

It is used when data is written to CDF.

The Cognite3DTransformation object defines a comprehensive 3D transformation, enabling precise adjustments to an object’s position, orientation, and size in the 3D coordinate system. It allows for the translation of objects along the three spatial axes, rotation around these axes using Euler angles, and scaling along each axis to modify the object’s dimensions. The object’s transformation is defined in “CDF space”, a coordinate system where the positive Z axis is the up direction

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D transformation edge.
type (DirectRelationReference | tuple[str, str]) – The type of edge.
start_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
translation_x (float | None | Omitted) – The displacement of the object along the X-axis in the 3D coordinate system
translation_y (float | None | Omitted) – The displacement of the object along the Y-axis in the 3D coordinate system
translation_z (float | None | Omitted) – The displacement of the object along the Z-axis in the 3D coordinate system
euler_rotation_x (float | None | Omitted) – The rotation of the object around the X-axis in radians
euler_rotation_y (float | None | Omitted) – The rotation of the object around the Y-axis in radians
euler_rotation_z (float | None | Omitted) – The rotation of the object around the Z-axis in radians
scale_x (float | None | Omitted) – The scaling factor applied to the object along the X-axis
scale_y (float | None | Omitted) – The scaling factor applied to the object along the Y-axis
scale_z (float | None | Omitted) – The scaling factor applied to the object along the Z-axis
existing_version (int | None) – Fail the ingestion request if the edge’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the edge (for the specified container or edge). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DTransformationNode( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, translation_x: float | None = None, translation_y: float | None = None, translation_z: float | None = None, euler_rotation_x: float | None = None, euler_rotation_y: float | None = None, euler_rotation_z: float | None = None, scale_x: float | None = None, scale_y: float | None = None, scale_z: float | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _Cognite3DTransformationProperties, TypedNode

This represents the reading format of Cognite 3D transformation node.

It is used when data is read from CDF.

The Cognite3DTransformation object defines a comprehensive 3D transformation, enabling precise adjustments to an object’s position, orientation, and size in the 3D coordinate system. It allows for the translation of objects along the three spatial axes, rotation around these axes using Euler angles, and scaling along each axis to modify the object’s dimensions. The object’s transformation is defined in “CDF space”, a coordinate system where the positive Z axis is the up direction

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D transformation node.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
translation_x (float | None) – The displacement of the object along the X-axis in the 3D coordinate system
translation_y (float | None) – The displacement of the object along the Y-axis in the 3D coordinate system
translation_z (float | None) – The displacement of the object along the Z-axis in the 3D coordinate system
euler_rotation_x (float | None) – The rotation of the object around the X-axis in radians
euler_rotation_y (float | None) – The rotation of the object around the Y-axis in radians
euler_rotation_z (float | None) – The rotation of the object around the Z-axis in radians
scale_x (float | None) – The scaling factor applied to the object along the X-axis
scale_y (float | None) – The scaling factor applied to the object along the Y-axis
scale_z (float | None) – The scaling factor applied to the object along the Z-axis
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.Cognite3DTransformationNodeApply( space: str, external_id: str, *, translation_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, translation_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, translation_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, euler_rotation_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_x: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_y: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scale_z: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _Cognite3DTransformationProperties, TypedNodeApply

This represents the writing format of Cognite 3D transformation node.

It is used when data is written to CDF.

The Cognite3DTransformation object defines a comprehensive 3D transformation, enabling precise adjustments to an object’s position, orientation, and size in the 3D coordinate system. It allows for the translation of objects along the three spatial axes, rotation around these axes using Euler angles, and scaling along each axis to modify the object’s dimensions. The object’s transformation is defined in “CDF space”, a coordinate system where the positive Z axis is the up direction

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite 3D transformation node.
translation_x (float | None | Omitted) – The displacement of the object along the X-axis in the 3D coordinate system
translation_y (float | None | Omitted) – The displacement of the object along the Y-axis in the 3D coordinate system
translation_z (float | None | Omitted) – The displacement of the object along the Z-axis in the 3D coordinate system
euler_rotation_x (float | None | Omitted) – The rotation of the object around the X-axis in radians
euler_rotation_y (float | None | Omitted) – The rotation of the object around the Y-axis in radians
euler_rotation_z (float | None | Omitted) – The rotation of the object around the Z-axis in radians
scale_x (float | None | Omitted) – The scaling factor applied to the object along the X-axis
scale_y (float | None | Omitted) – The scaling factor applied to the object along the Y-axis
scale_z (float | None | Omitted) – The scaling factor applied to the object along the Z-axis
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteActivity( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, start_time: datetime | None = None, end_time: datetime | None = None, scheduled_start_time: datetime | None = None, scheduled_end_time: datetime | None = None, assets: list[DirectRelationReference] | None = None, equipment: list[DirectRelationReference] | None = None, time_series: list[DirectRelationReference] | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteActivityProperties, TypedNode

This represents the reading format of Cognite activity.

It is used when data is read from CDF.

Represents activities. Activities typically happen over a period and have a start and end time.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite activity.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
start_time (datetime | None) – The actual start time of an activity (or similar that extends this)
end_time (datetime | None) – The actual end time of an activity (or similar that extends this)
scheduled_start_time (datetime | None) – The planned start time of an activity (or similar that extends this)
scheduled_end_time (datetime | None) – The planned end time of an activity (or similar that extends this)
assets (list[DirectRelationReference] | None) – A list of assets the activity is related to.
equipment (list[DirectRelationReference] | None) – A list of equipment the activity is related to.
time_series (list[DirectRelationReference] | None) – A list of time series the activity is related to.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteActivityApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, start_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scheduled_start_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scheduled_end_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, assets: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, equipment: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, time_series: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteActivityProperties, TypedNodeApply

This represents the writing format of Cognite activity.

It is used when data is written to CDF.

Represents activities. Activities typically happen over a period and have a start and end time.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite activity.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
start_time (datetime | None | Omitted) – The actual start time of an activity (or similar that extends this)
end_time (datetime | None | Omitted) – The actual end time of an activity (or similar that extends this)
scheduled_start_time (datetime | None | Omitted) – The planned start time of an activity (or similar that extends this)
scheduled_end_time (datetime | None | Omitted) – The planned end time of an activity (or similar that extends this)
assets (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – A list of assets the activity is related to.
equipment (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – A list of equipment the activity is related to.
time_series (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – A list of time series the activity is related to.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAnnotation( space: str, external_id: str, type: DirectRelationReference, start_node: DirectRelationReference, end_node: DirectRelationReference, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, confidence: float | None = None, status: Literal['Approved', 'Rejected', 'Suggested'] | None = None, deleted_time: int | None = None, )

Bases: _CogniteAnnotationProperties, TypedEdge

This represents the reading format of Cognite annotation.

It is used when data is read from CDF.

Annotation represents contextualization results or links

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite annotation.
type (DirectRelationReference) – The type of edge.
start_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
confidence (float | None) – The confidence that the annotation is a good match
status (Literal['Approved', 'Rejected', 'Suggested'] | None) – The status of the annotation
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAnnotationApply(space: str, external_id: str, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], start_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], end_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, confidence: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, status: ~typing.Literal['Approved', 'Rejected', 'Suggested'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None)

Bases: _CogniteAnnotationProperties, TypedEdgeApply

This represents the writing format of Cognite annotation.

It is used when data is written to CDF.

Annotation represents contextualization results or links

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite annotation.
type (DirectRelationReference | tuple[str, str]) – The type of edge.
start_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
confidence (float | None | Omitted) – The confidence that the annotation is a good match
status (Literal['Approved', 'Rejected', 'Suggested'] | None | Omitted) – The status of the annotation
existing_version (int | None) – Fail the ingestion request if the edge’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the edge (for the specified container or edge). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAsset( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, object_3d: DirectRelationReference | None = None, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, parent: DirectRelationReference | None = None, root: DirectRelationReference | None = None, path: list[DirectRelationReference] | None = None, path_last_updated_time: datetime | None = None, asset_class: DirectRelationReference | None = None, asset_type: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteAssetProperties, TypedNode

This represents the reading format of Cognite asset.

It is used when data is read from CDF.

Assets represent systems that support industrial functions or processes. Assets are often called ‘functional location’.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite asset.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
object_3d (DirectRelationReference | None) – Direct relation to an Object3D instance representing the 3D resource
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
parent (DirectRelationReference | None) – The parent of the asset.
root (DirectRelationReference | None) – An automatically updated reference to the top-level asset of the hierarchy.
path (list[DirectRelationReference] | None) – An automatically updated ordered list of this asset’s ancestors, starting with the root asset. Enables subtree filtering to find all assets under a parent.
path_last_updated_time (datetime | None) – The last time the path was updated for this asset.
asset_class (DirectRelationReference | None) – Specifies the class of the asset. It’s a direct relation to CogniteAssetClass.
asset_type (DirectRelationReference | None) – Specifies the type of the asset. It’s a direct relation to CogniteAssetType.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAssetApply( space: str, external_id: str, *, object_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, parent: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, asset_class: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, asset_type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteAssetProperties, TypedNodeApply

This represents the writing format of Cognite asset.

It is used when data is written to CDF.

Assets represent systems that support industrial functions or processes. Assets are often called ‘functional location’.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite asset.
object_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to an Object3D instance representing the 3D resource
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
parent (DirectRelationReference | tuple[str, str] | None | Omitted) – The parent of the asset.
asset_class (DirectRelationReference | tuple[str, str] | None | Omitted) – Specifies the class of the asset. It’s a direct relation to CogniteAssetClass.
asset_type (DirectRelationReference | tuple[str, str] | None | Omitted) – Specifies the type of the asset. It’s a direct relation to CogniteAssetType.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAssetClass( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, code: str | None = None, standard: str | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteAssetClassProperties, TypedNode

This represents the reading format of Cognite asset clas.

It is used when data is read from CDF.

Represents the class of an asset.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite asset clas.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
code (str | None) – A unique identifier for the class of asset.
standard (str | None) – A text string to specify which standard the class is from.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAssetClassApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, code: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, standard: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteAssetClassProperties, TypedNodeApply

This represents the writing format of Cognite asset clas.

It is used when data is written to CDF.

Represents the class of an asset.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite asset clas.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
code (str | None | Omitted) – A unique identifier for the class of asset.
standard (str | None | Omitted) – A text string to specify which standard the class is from.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAssetType( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, code: str | None = None, standard: str | None = None, asset_class: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteAssetTypeProperties, TypedNode

This represents the reading format of Cognite asset type.

It is used when data is read from CDF.

Represents the type of an asset.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite asset type.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
code (str | None) – A unique identifier for the type of asset.
standard (str | None) – A text string to specify which standard the type is from.
asset_class (DirectRelationReference | None) – Specifies the class the type belongs to. It’s a direct relation to CogniteAssetClass.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteAssetTypeApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, code: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, standard: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, asset_class: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteAssetTypeProperties, TypedNodeApply

This represents the writing format of Cognite asset type.

It is used when data is written to CDF.

Represents the type of an asset.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite asset type.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
code (str | None | Omitted) – A unique identifier for the type of asset.
standard (str | None | Omitted) – A text string to specify which standard the type is from.
asset_class (DirectRelationReference | tuple[str, str] | None | Omitted) – Specifies the class the type belongs to. It’s a direct relation to CogniteAssetClass.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCADModel( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, model_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, thumbnail: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteCADModelProperties, TypedNode

This represents the reading format of Cognite cad model.

It is used when data is read from CDF.

Navigational aid for traversing CogniteCADModel instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cad model.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | None) – Thumbnail of the 3D model
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCADModelApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, thumbnail: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteCADModelProperties, TypedNodeApply

This represents the writing format of Cognite cad model.

It is used when data is written to CDF.

Navigational aid for traversing CogniteCADModel instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cad model.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | tuple[str, str] | None | Omitted) – Thumbnail of the 3D model
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCADNode( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, object_3d: DirectRelationReference | None = None, model_3d: DirectRelationReference | None = None, cad_node_reference: str | None = None, revisions: list[DirectRelationReference] | None = None, tree_indexes: list[int] | None = None, sub_tree_sizes: list[int] | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteCADNodeProperties, TypedNode

This represents the reading format of Cognite cad node.

It is used when data is read from CDF.

Represents nodes from the 3D model that have been contextualized

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cad node.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
object_3d (DirectRelationReference | None) – Direct relation to object3D grouping for this node
model_3d (DirectRelationReference | None) – Direct relation to Cognite3DModel
cad_node_reference (str | None) – Reference to a node within a CAD model from the 3D API
revisions (list[DirectRelationReference] | None) – List of direct relations to instances of Cognite3DRevision which this CogniteCADNode exists in.
tree_indexes (list[int] | None) – List of tree indexes in the same order as revisions. Used by Reveal and similar applications to map from CogniteCADNode to tree index
sub_tree_sizes (list[int] | None) – List of subtree sizes in the same order as revisions. Used by Reveal and similar applications to know how many nodes exists below this node in the hierarchy
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCADNodeApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, object_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, cad_node_reference: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revisions: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tree_indexes: list[int] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, sub_tree_sizes: list[int] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteCADNodeProperties, TypedNodeApply

This represents the writing format of Cognite cad node.

It is used when data is written to CDF.

Represents nodes from the 3D model that have been contextualized

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cad node.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
object_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to object3D grouping for this node
model_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to Cognite3DModel
cad_node_reference (str | None | Omitted) – Reference to a node within a CAD model from the 3D API
revisions (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – List of direct relations to instances of Cognite3DRevision which this CogniteCADNode exists in.
tree_indexes (list[int] | None | Omitted) – List of tree indexes in the same order as revisions. Used by Reveal and similar applications to map from CogniteCADNode to tree index
sub_tree_sizes (list[int] | None | Omitted) – List of subtree sizes in the same order as revisions. Used by Reveal and similar applications to know how many nodes exists below this node in the hierarchy
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCADRevision( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, status: Literal['Done', 'Failed', 'Processing', 'Queued'] | None = None, published: bool | None = None, revision_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, model_3d: DirectRelationReference | None = None, revision_id: int | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteCADRevisionProperties, TypedNode

This represents the reading format of Cognite cad revision.

It is used when data is read from CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cad revision.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None) – The status field.
published (bool | None) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – The revision type field.
model_3d (DirectRelationReference | None) –
.
revision_id (int | None) – The 3D API revision identifier for this CAD model
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCADRevisionApply( space: str, external_id: str, *, status: ~typing.Literal['Done', 'Failed', 'Processing', 'Queued'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, published: bool | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revision_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revision_id: int | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteCADRevisionProperties, TypedNodeApply

This represents the writing format of Cognite cad revision.

It is used when data is written to CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cad revision.
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None | Omitted) – The status field.
published (bool | None | Omitted) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – The revision type field.
model_3d (DirectRelationReference | tuple[str, str] | None | Omitted) –
.
revision_id (int | None | Omitted) – The 3D API revision identifier for this CAD model
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCubeMap( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, front: DirectRelationReference | None = None, back: DirectRelationReference | None = None, left: DirectRelationReference | None = None, right: DirectRelationReference | None = None, top: DirectRelationReference | None = None, bottom: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteCubeMapProperties, TypedNode

This represents the reading format of Cognite cube map.

It is used when data is read from CDF.

The cube map holds references to 6 images in used to visually represent the surrounding environment

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cube map.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
front (DirectRelationReference | None) – Direct relation to a file holding the front projection of the cube map
back (DirectRelationReference | None) – Direct relation to a file holding the back projection of the cube map
left (DirectRelationReference | None) – Direct relation to a file holding the left projection of the cube map
right (DirectRelationReference | None) – Direct relation to a file holding the right projection of the cube map
top (DirectRelationReference | None) – Direct relation to a file holding the top projection of the cube map
bottom (DirectRelationReference | None) – Direct relation to a file holding the bottom projection of the cube map
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteCubeMapApply( space: str, external_id: str, *, front: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, back: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, left: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, right: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, top: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, bottom: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteCubeMapProperties, TypedNodeApply

This represents the writing format of Cognite cube map.

It is used when data is written to CDF.

The cube map holds references to 6 images in used to visually represent the surrounding environment

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite cube map.
front (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the front projection of the cube map
back (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the back projection of the cube map
left (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the left projection of the cube map
right (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the right projection of the cube map
top (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the top projection of the cube map
bottom (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a file holding the bottom projection of the cube map
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteDescribableEdge( space: str, external_id: str, type: DirectRelationReference, start_node: DirectRelationReference, end_node: DirectRelationReference, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, deleted_time: int | None = None, )

Bases: _CogniteDescribableProperties, TypedEdge

This represents the reading format of Cognite describable edge.

It is used when data is read from CDF.

The describable core concept is used as a standard way of holding the bare minimum of information about the instance

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite describable edge.
type (DirectRelationReference) – The type of edge.
start_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteDescribableEdgeApply(space: str, external_id: str, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], start_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], end_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None)

Bases: _CogniteDescribableProperties, TypedEdgeApply

This represents the writing format of Cognite describable edge.

It is used when data is written to CDF.

The describable core concept is used as a standard way of holding the bare minimum of information about the instance

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite describable edge.
type (DirectRelationReference | tuple[str, str]) – The type of edge.
start_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
existing_version (int | None) – Fail the ingestion request if the edge’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the edge (for the specified container or edge). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteDescribableNode( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteDescribableProperties, TypedNode

This represents the reading format of Cognite describable node.

It is used when data is read from CDF.

The describable core concept is used as a standard way of holding the bare minimum of information about the instance

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite describable node.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteDescribableNodeApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteDescribableProperties, TypedNodeApply

This represents the writing format of Cognite describable node.

It is used when data is written to CDF.

The describable core concept is used as a standard way of holding the bare minimum of information about the instance

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite describable node.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteDiagramAnnotation( space: str, external_id: str, type: DirectRelationReference, start_node: DirectRelationReference, end_node: DirectRelationReference, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, confidence: float | None = None, status: Literal['Approved', 'Rejected', 'Suggested'] | None = None, start_node_page_number: int | None = None, end_node_page_number: int | None = None, start_node_x_min: float | None = None, start_node_x_max: float | None = None, start_node_y_min: float | None = None, start_node_y_max: float | None = None, start_node_text: str | None = None, end_node_x_min: float | None = None, end_node_x_max: float | None = None, end_node_y_min: float | None = None, end_node_y_max: float | None = None, end_node_text: str | None = None, deleted_time: int | None = None, )

Bases: _CogniteDiagramAnnotationProperties, TypedEdge

This represents the reading format of Cognite diagram annotation.

It is used when data is read from CDF.

Annotation for diagrams

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite diagram annotation.
type (DirectRelationReference) – The type of edge.
start_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
confidence (float | None) – The confidence that the annotation is a good match
status (Literal['Approved', 'Rejected', 'Suggested'] | None) – The status of the annotation
start_node_page_number (int | None) – The number of the page on which this annotation is located in startNode File. The first page has number 1
end_node_page_number (int | None) – The number of the page on which this annotation is located in the endNode File if an endNode is present. The first page has number 1
start_node_x_min (float | None) – Value between [0,1]. Minimum abscissa of the bounding box (left edge). Must be strictly less than startNodeXMax
start_node_x_max (float | None) – Value between [0,1]. Maximum abscissa of the bounding box (right edge). Must be strictly more than startNodeXMin
start_node_y_min (float | None) – Value between [0,1]. Minimum ordinate of the bounding box (bottom edge). Must be strictly less than startNodeYMax
start_node_y_max (float | None) – Value between [0,1]. Maximum ordinate of the bounding box (top edge). Must be strictly more than startNodeYMin
start_node_text (str | None) – The text extracted from within the bounding box on the startNode
end_node_x_min (float | None) – Value between [0,1]. Minimum abscissa of the bounding box (left edge). Must be strictly less than endNodeXMax. Only applicable if an endNode is defined
end_node_x_max (float | None) – Value between [0,1]. Maximum abscissa of the bounding box (right edge). Must be strictly more than endNodeXMin. Only applicable if an endNode is defined
end_node_y_min (float | None) – Value between [0,1]. Minimum ordinate of the bounding box (bottom edge). Must be strictly less than endNodeYMax. Only applicable if an endNode is defined
end_node_y_max (float | None) – Value between [0,1]. Maximum ordinate of the bounding box (top edge). Must be strictly more than endNodeYMin. Only applicable if an endNode is defined
end_node_text (str | None) – The text extracted from within the bounding box on the endNode. Only applicable if an endNode is defined
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteDiagramAnnotationApply(space: str, external_id: str, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], start_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], end_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, confidence: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, status: ~typing.Literal['Approved', 'Rejected', 'Suggested'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, start_node_page_number: int | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_node_page_number: int | None | ~cognite.client._constants.Omitted = <Omitted parameter>, start_node_x_min: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, start_node_x_max: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, start_node_y_min: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, start_node_y_max: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, start_node_text: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_node_x_min: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_node_x_max: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_node_y_min: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_node_y_max: float | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_node_text: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None)

Bases: _CogniteDiagramAnnotationProperties, TypedEdgeApply

This represents the writing format of Cognite diagram annotation.

It is used when data is written to CDF.

Annotation for diagrams

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite diagram annotation.
type (DirectRelationReference | tuple[str, str]) – The type of edge.
start_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
confidence (float | None | Omitted) – The confidence that the annotation is a good match
status (Literal['Approved', 'Rejected', 'Suggested'] | None | Omitted) – The status of the annotation
start_node_page_number (int | None | Omitted) – The number of the page on which this annotation is located in startNode File. The first page has number 1
end_node_page_number (int | None | Omitted) – The number of the page on which this annotation is located in the endNode File if an endNode is present. The first page has number 1
start_node_x_min (float | None | Omitted) – Value between [0,1]. Minimum abscissa of the bounding box (left edge). Must be strictly less than startNodeXMax
start_node_x_max (float | None | Omitted) – Value between [0,1]. Maximum abscissa of the bounding box (right edge). Must be strictly more than startNodeXMin
start_node_y_min (float | None | Omitted) – Value between [0,1]. Minimum ordinate of the bounding box (bottom edge). Must be strictly less than startNodeYMax
start_node_y_max (float | None | Omitted) – Value between [0,1]. Maximum ordinate of the bounding box (top edge). Must be strictly more than startNodeYMin
start_node_text (str | None | Omitted) – The text extracted from within the bounding box on the startNode
end_node_x_min (float | None | Omitted) – Value between [0,1]. Minimum abscissa of the bounding box (left edge). Must be strictly less than endNodeXMax. Only applicable if an endNode is defined
end_node_x_max (float | None | Omitted) – Value between [0,1]. Maximum abscissa of the bounding box (right edge). Must be strictly more than endNodeXMin. Only applicable if an endNode is defined
end_node_y_min (float | None | Omitted) – Value between [0,1]. Minimum ordinate of the bounding box (bottom edge). Must be strictly less than endNodeYMax. Only applicable if an endNode is defined
end_node_y_max (float | None | Omitted) – Value between [0,1]. Maximum ordinate of the bounding box (top edge). Must be strictly more than endNodeYMin. Only applicable if an endNode is defined
end_node_text (str | None | Omitted) – The text extracted from within the bounding box on the endNode. Only applicable if an endNode is defined
existing_version (int | None) – Fail the ingestion request if the edge’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the edge (for the specified container or edge). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteEquipment( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, asset: DirectRelationReference | None = None, serial_number: str | None = None, manufacturer: str | None = None, equipment_type: DirectRelationReference | None = None, files: list[DirectRelationReference] | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteEquipmentProperties, TypedNode

This represents the reading format of Cognite equipment.

It is used when data is read from CDF.

Equipment represents physical supplies or devices.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite equipment.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
asset (DirectRelationReference | None) – The asset the equipment is related to.
serial_number (str | None) – The serial number of the equipment.
manufacturer (str | None) – The manufacturer of the equipment.
equipment_type (DirectRelationReference | None) – Specifies the type of the equipment. It’s a direct relation to CogniteEquipmentType.
files (list[DirectRelationReference] | None) – A list of files the equipment relates to.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteEquipmentApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, asset: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, serial_number: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, manufacturer: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, equipment_type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, files: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteEquipmentProperties, TypedNodeApply

This represents the writing format of Cognite equipment.

It is used when data is written to CDF.

Equipment represents physical supplies or devices.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite equipment.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
asset (DirectRelationReference | tuple[str, str] | None | Omitted) – The asset the equipment is related to.
serial_number (str | None | Omitted) – The serial number of the equipment.
manufacturer (str | None | Omitted) – The manufacturer of the equipment.
equipment_type (DirectRelationReference | tuple[str, str] | None | Omitted) – Specifies the type of the equipment. It’s a direct relation to CogniteEquipmentType.
files (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – A list of files the equipment relates to.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteEquipmentType( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, code: str | None = None, equipment_class: str | None = None, standard: str | None = None, standard_reference: str | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteEquipmentTypeProperties, TypedNode

This represents the reading format of Cognite equipment type.

It is used when data is read from CDF.

Represents the type of equipment.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite equipment type.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
code (str | None) – A unique identifier for the type of equipment.
equipment_class (str | None) – Represents the class of equipment.
standard (str | None) – An identifier for the standard this equipment type is sourced from, for example, ISO14224.
standard_reference (str | None) – A reference to the source of the equipment standard.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteEquipmentTypeApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, code: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, equipment_class: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, standard: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, standard_reference: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteEquipmentTypeProperties, TypedNodeApply

This represents the writing format of Cognite equipment type.

It is used when data is written to CDF.

Represents the type of equipment.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite equipment type.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
code (str | None | Omitted) – A unique identifier for the type of equipment.
equipment_class (str | None | Omitted) – Represents the class of equipment.
standard (str | None | Omitted) – An identifier for the standard this equipment type is sourced from, for example, ISO14224.
standard_reference (str | None | Omitted) – A reference to the source of the equipment standard.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteFile( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, assets: list[DirectRelationReference] | None = None, mime_type: str | None = None, directory: str | None = None, is_uploaded: bool | None = None, uploaded_time: datetime | None = None, category: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteFileProperties, TypedNode

This represents the reading format of Cognite file.

It is used when data is read from CDF.

Represents files.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite file.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
assets (list[DirectRelationReference] | None) – A list of assets this file is related to.
mime_type (str | None) – The MIME type of the file.
directory (str | None) – Contains the path elements from the source (if the source system has a file system hierarchy or similar.)
is_uploaded (bool | None) – Specifies if the file content has been uploaded to Cognite Data Fusion or not.
uploaded_time (datetime | None) – The time the file upload completed.
category (DirectRelationReference | None) – Specifies the detected category the file belongs to. It’s a direct relation to an instance of CogniteFileCategory.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteFileApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, assets: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, mime_type: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, directory: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, category: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteFileProperties, TypedNodeApply

This represents the writing format of Cognite file.

It is used when data is written to CDF.

Represents files.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite file.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
assets (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – A list of assets this file is related to.
mime_type (str | None | Omitted) – The MIME type of the file.
directory (str | None | Omitted) – Contains the path elements from the source (if the source system has a file system hierarchy or similar.)
category (DirectRelationReference | tuple[str, str] | None | Omitted) – Specifies the detected category the file belongs to. It’s a direct relation to an instance of CogniteFileCategory.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteFileCategory( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, code: str, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, standard: str | None = None, standard_reference: str | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteFileCategoryProperties, TypedNode

This represents the reading format of Cognite file category.

It is used when data is read from CDF.

Represents the categories of files as determined by contextualization or categorization.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite file category.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
code (str) – An identifier for the category, for example, ‘AA’ for Accounting (from Norsok.)
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
standard (str | None) – The name of the standard the category originates from, for example, ‘Norsok’.
standard_reference (str | None) – A reference to the source of the category standard.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteFileCategoryApply( space: str, external_id: str, *, code: str, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, standard: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, standard_reference: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteFileCategoryProperties, TypedNodeApply

This represents the writing format of Cognite file category.

It is used when data is written to CDF.

Represents the categories of files as determined by contextualization or categorization.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite file category.
code (str) – An identifier for the category, for example, ‘AA’ for Accounting (from Norsok.)
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
standard (str | None | Omitted) – The name of the standard the category originates from, for example, ‘Norsok’.
standard_reference (str | None | Omitted) – A reference to the source of the category standard.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CognitePointCloudModel( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, model_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, thumbnail: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CognitePointCloudModelProperties, TypedNode

This represents the reading format of Cognite point cloud model.

It is used when data is read from CDF.

Navigational aid for traversing CognitePointCloudModel instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite point cloud model.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | None) – Thumbnail of the 3D model
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CognitePointCloudModelApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, thumbnail: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CognitePointCloudModelProperties, TypedNodeApply

This represents the writing format of Cognite point cloud model.

It is used when data is written to CDF.

Navigational aid for traversing CognitePointCloudModel instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite point cloud model.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
model_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – CAD, PointCloud or Image360
thumbnail (DirectRelationReference | tuple[str, str] | None | Omitted) – Thumbnail of the 3D model
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CognitePointCloudRevision( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, status: Literal['Done', 'Failed', 'Processing', 'Queued'] | None = None, published: bool | None = None, revision_type: Literal['CAD', 'Image360', 'PointCloud'] | None = None, model_3d: DirectRelationReference | None = None, revision_id: int | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CognitePointCloudRevisionProperties, TypedNode

This represents the reading format of Cognite point cloud revision.

It is used when data is read from CDF.

Navigational aid for traversing CognitePointCloudRevision instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite point cloud revision.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None) – The status field.
published (bool | None) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None) – The revision type field.
model_3d (DirectRelationReference | None) –
.
revision_id (int | None) – The 3D API revision identifier for this PointCloud model
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CognitePointCloudRevisionApply( space: str, external_id: str, *, status: ~typing.Literal['Done', 'Failed', 'Processing', 'Queued'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, published: bool | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revision_type: ~typing.Literal['CAD', 'Image360', 'PointCloud'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revision_id: int | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CognitePointCloudRevisionProperties, TypedNodeApply

This represents the writing format of Cognite point cloud revision.

It is used when data is written to CDF.

Navigational aid for traversing CognitePointCloudRevision instances

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite point cloud revision.
status (Literal['Done', 'Failed', 'Processing', 'Queued'] | None | Omitted) – The status field.
published (bool | None | Omitted) – The published field.
revision_type (Literal['CAD', 'Image360', 'PointCloud'] | None | Omitted) – The revision type field.
model_3d (DirectRelationReference | tuple[str, str] | None | Omitted) –
.
revision_id (int | None | Omitted) – The 3D API revision identifier for this PointCloud model
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CognitePointCloudVolume( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, object_3d: DirectRelationReference | None = None, model_3d: DirectRelationReference | None = None, volume_references: list[str] | None = None, revisions: list[DirectRelationReference] | None = None, volume_type: Literal['Box', 'Cylinder'] | None = None, volume: list[float] | None = None, format_version: str | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CognitePointCloudVolumeProperties, TypedNode

This represents the reading format of Cognite point cloud volume.

It is used when data is read from CDF.

PointCloud volume definition

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite point cloud volume.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
object_3d (DirectRelationReference | None) – Direct relation to object3D grouping for this node
model_3d (DirectRelationReference | None) – Direct relation to Cognite3DModel instance
volume_references (list[str] | None) – Unique volume metric hashes used to access the 3D specialized data storage
revisions (list[DirectRelationReference] | None) – List of direct relations to revision information
volume_type (Literal['Box', 'Cylinder'] | None) – Type of volume (Cylinder or Box)
volume (list[float] | None) – Relevant coordinates for the volume type, 9 floats in total, that defines the volume
format_version (str | None) – Specifies the version the ‘volume’ field is following. Volume definition is today 9 floats (property volume)
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CognitePointCloudVolumeApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, object_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, model_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, volume_references: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, revisions: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, volume_type: ~typing.Literal['Box', 'Cylinder'] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, volume: list[float] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, format_version: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CognitePointCloudVolumeProperties, TypedNodeApply

This represents the writing format of Cognite point cloud volume.

It is used when data is written to CDF.

PointCloud volume definition

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite point cloud volume.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
object_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to object3D grouping for this node
model_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to Cognite3DModel instance
volume_references (list[str] | None | Omitted) – Unique volume metric hashes used to access the 3D specialized data storage
revisions (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – List of direct relations to revision information
volume_type (Literal['Box', 'Cylinder'] | None | Omitted) – Type of volume (Cylinder or Box)
volume (list[float] | None | Omitted) – Relevant coordinates for the volume type, 9 floats in total, that defines the volume
format_version (str | None | Omitted) – Specifies the version the ‘volume’ field is following. Volume definition is today 9 floats (property volume)
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSchedulable( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, start_time: datetime | None = None, end_time: datetime | None = None, scheduled_start_time: datetime | None = None, scheduled_end_time: datetime | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteSchedulableProperties, TypedNode

This represents the reading format of Cognite schedulable.

It is used when data is read from CDF.

CogniteSchedulable represents the metadata about when an activity (or similar) starts and ends.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite schedulable.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
start_time (datetime | None) – The actual start time of an activity (or similar that extends this)
end_time (datetime | None) – The actual end time of an activity (or similar that extends this)
scheduled_start_time (datetime | None) – The planned start time of an activity (or similar that extends this)
scheduled_end_time (datetime | None) – The planned end time of an activity (or similar that extends this)
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSchedulableApply( space: str, external_id: str, *, start_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, end_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scheduled_start_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, scheduled_end_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteSchedulableProperties, TypedNodeApply

This represents the writing format of Cognite schedulable.

It is used when data is written to CDF.

CogniteSchedulable represents the metadata about when an activity (or similar) starts and ends.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite schedulable.
start_time (datetime | None | Omitted) – The actual start time of an activity (or similar that extends this)
end_time (datetime | None | Omitted) – The actual end time of an activity (or similar that extends this)
scheduled_start_time (datetime | None | Omitted) – The planned start time of an activity (or similar that extends this)
scheduled_end_time (datetime | None | Omitted) – The planned end time of an activity (or similar that extends this)
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSourceSystem( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_system_version: str | None = None, manufacturer: str | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteSourceSystemProperties, TypedNode

This represents the reading format of Cognite source system.

It is used when data is read from CDF.

The CogniteSourceSystem core concept is used to standardize the way source system is stored.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite source system.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_system_version (str | None) – Version identifier for the source system
manufacturer (str | None) – Manufacturer of the source system
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSourceSystemApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_system_version: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, manufacturer: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteSourceSystemProperties, TypedNodeApply

This represents the writing format of Cognite source system.

It is used when data is written to CDF.

The CogniteSourceSystem core concept is used to standardize the way source system is stored.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite source system.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_system_version (str | None | Omitted) – Version identifier for the source system
manufacturer (str | None | Omitted) – Manufacturer of the source system
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSourceableEdge( space: str, external_id: str, type: DirectRelationReference, start_node: DirectRelationReference, end_node: DirectRelationReference, version: int, last_updated_time: int, created_time: int, *, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, deleted_time: int | None = None, )

Bases: _CogniteSourceableProperties, TypedEdge

This represents the reading format of Cognite sourceable edge.

It is used when data is read from CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite sourceable edge.
type (DirectRelationReference) – The type of edge.
start_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference) – Reference to the direct relation. The reference consists of a space and an external-id.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSourceableEdgeApply(space: str, external_id: str, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], start_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], end_node: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str], *, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None)

Bases: _CogniteSourceableProperties, TypedEdgeApply

This represents the writing format of Cognite sourceable edge.

It is used when data is written to CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite sourceable edge.
type (DirectRelationReference | tuple[str, str]) – The type of edge.
start_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
end_node (DirectRelationReference | tuple[str, str]) – Reference to the direct relation. The reference consists of a space and an external-id.
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
existing_version (int | None) – Fail the ingestion request if the edge’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the edge (for the specified container or edge). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSourceableNode( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteSourceableProperties, TypedNode

This represents the reading format of Cognite sourceable node.

It is used when data is read from CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite sourceable node.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteSourceableNodeApply( space: str, external_id: str, *, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteSourceableProperties, TypedNodeApply

This represents the writing format of Cognite sourceable node.

It is used when data is written to CDF.

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite sourceable node.
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteTimeSeries( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, is_step: bool, time_series_type: Literal['numeric', 'string'], name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, source_id: str | None = None, source_context: str | None = None, source: DirectRelationReference | None = None, source_created_time: datetime | None = None, source_updated_time: datetime | None = None, source_created_user: str | None = None, source_updated_user: str | None = None, source_unit: str | None = None, unit: DirectRelationReference | None = None, assets: list[DirectRelationReference] | None = None, equipment: list[DirectRelationReference] | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteTimeSeriesProperties, TypedNode

This represents the reading format of Cognite time series.

It is used when data is read from CDF.

Represents a series of data points in time order.”

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite time series.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
is_step (bool) – Specifies whether the time series is a step time series or not.
time_series_type (Literal['numeric', 'string']) – Specifies the data type of the data points.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
source_id (str | None) – Identifier from the source system
source_context (str | None) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | None) – Direct relation to a source system
source_created_time (datetime | None) – When the instance was created in source system (if available)
source_updated_time (datetime | None) – When the instance was last updated in the source system (if available)
source_created_user (str | None) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_unit (str | None) – The unit specified in the source system.
unit (DirectRelationReference | None) – The unit of the time series.
assets (list[DirectRelationReference] | None) – A list of assets the time series is related to.
equipment (list[DirectRelationReference] | None) – A list of equipment the time series is related to.
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteTimeSeriesApply(space: str, external_id: str, *, is_step: bool, time_series_type: ~typing.Literal['numeric', 'string'], name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_id: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_context: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_time: ~datetime.datetime | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_created_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_updated_user: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_unit: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, unit: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, assets: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, equipment: list[~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str]] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>)

Bases: _CogniteTimeSeriesProperties, TypedNodeApply

This represents the writing format of Cognite time series.

It is used when data is written to CDF.

Represents a series of data points in time order.”

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite time series.
is_step (bool) – Specifies whether the time series is a step time series or not.
time_series_type (Literal['numeric', 'string']) – Specifies the data type of the data points.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
source_id (str | None | Omitted) – Identifier from the source system
source_context (str | None | Omitted) – Context of the source id. For systems where the sourceId is globally unique, the sourceContext is expected to not be set.
source (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to a source system
source_created_time (datetime | None | Omitted) – When the instance was created in source system (if available)
source_updated_time (datetime | None | Omitted) – When the instance was last updated in the source system (if available)
source_created_user (str | None | Omitted) – User identifier from the source system on who created the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_updated_user (str | None | Omitted) – User identifier from the source system on who last updated the source data. This identifier is not guaranteed to match the user identifiers in CDF
source_unit (str | None | Omitted) – The unit specified in the source system.
unit (DirectRelationReference | tuple[str, str] | None | Omitted) – The unit of the time series.
assets (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – A list of assets the time series is related to.
equipment (list[DirectRelationReference | tuple[str, str]] | None | Omitted) – A list of equipment the time series is related to.
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteUnit( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, name: str | None = None, description: str | None = None, tags: list[str] | None = None, aliases: list[str] | None = None, symbol: str | None = None, quantity: str | None = None, source: str | None = None, source_reference: str | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteUnitProperties, TypedNode

This represents the reading format of Cognite unit.

It is used when data is read from CDF.

Represents a single unit of measurement

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite unit.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
name (str | None) – Name of the instance
description (str | None) – Description of the instance
tags (list[str] | None) – Text based labels for generic use, limited to 1000
aliases (list[str] | None) – Alternative names for the node
symbol (str | None) – The symbol for the unit of measurement
quantity (str | None) – Specifies the physical quantity the unit measures
source (str | None) – Source of the unit definition
source_reference (str | None) – Reference to the source of the unit definition
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteUnitApply( space: str, external_id: str, *, name: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, description: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, tags: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, aliases: list[str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, symbol: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, quantity: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, source_reference: str | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteUnitProperties, TypedNodeApply

This represents the writing format of Cognite unit.

It is used when data is written to CDF.

Represents a single unit of measurement

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite unit.
name (str | None | Omitted) – Name of the instance
description (str | None | Omitted) – Description of the instance
tags (list[str] | None | Omitted) – Text based labels for generic use, limited to 1000
aliases (list[str] | None | Omitted) – Alternative names for the node
symbol (str | None | Omitted) – The symbol for the unit of measurement
quantity (str | None | Omitted) – Specifies the physical quantity the unit measures
source (str | None | Omitted) – Source of the unit definition
source_reference (str | None | Omitted) – Reference to the source of the unit definition
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteVisualizable( space: str, external_id: str, version: int, last_updated_time: int, created_time: int, *, object_3d: DirectRelationReference | None = None, type: DirectRelationReference | None = None, deleted_time: int | None = None, )

Bases: _CogniteVisualizableProperties, TypedNode

This represents the reading format of Cognite visualizable.

It is used when data is read from CDF.

CogniteVisualizable defines the standard way to reference a related 3D resource

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite visualizable.
version (int) – DMS version.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
object_3d (DirectRelationReference | None) – Direct relation to an Object3D instance representing the 3D resource
type (DirectRelationReference | None) – Direct relation pointing to the type node.
deleted_time (int | None) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Timestamp when the instance was soft deleted. Note that deleted instances are filtered out of query results, but present in sync results

class cognite.client.data_classes.data_modeling.cdm.v1.CogniteVisualizableApply( space: str, external_id: str, *, object_3d: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, existing_version: int | None = None, type: ~cognite.client.data_classes.data_modeling.data_types.DirectRelationReference | tuple[str, str] | None | ~cognite.client._constants.Omitted = <Omitted parameter>, )

Bases: _CogniteVisualizableProperties, TypedNodeApply

This represents the writing format of Cognite visualizable.

It is used when data is written to CDF.

CogniteVisualizable defines the standard way to reference a related 3D resource

Parameters:

space (str) – The space where the node is located.
external_id (str) – The external id of the Cognite visualizable.
object_3d (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation to an Object3D instance representing the 3D resource
existing_version (int | None) – Fail the ingestion request if the node’s version is greater than or equal to this value. If no existingVersion is specified, the ingestion will always overwrite any existing data for the node (for the specified container or node). If existingVersion is set to 0, the upsert will behave as an insert, so it will fail the bulk if the item already exists. If skipOnVersionConflict is set on the ingestion request, then the item will be skipped instead of failing the ingestion request.
type (DirectRelationReference | tuple[str, str] | None | Omitted) – Direct relation pointing to the type node.