com.cognite.sdk.scala.v1

Type members

Classlikes

final case class ApiKey(id: Long, serviceAccountId: Long, createdTime: Instant, status: String) extends WithId[Long]
final case class Asset(externalId: Option[String], name: String, parentId: Option[Long], description: Option[String], metadata: Option[Map[String, String]], source: Option[String], id: Long, createdTime: Instant, lastUpdatedTime: Instant, rootId: Option[Long], aggregates: Option[Map[String, Long]], dataSetId: Option[Long], parentExternalId: Option[String], labels: Option[Seq[CogniteExternalId]]) extends WithId[Long] with WithExternalId with WithCreatedTime with ToCreate[AssetCreate] with ToUpdate[AssetUpdate]
final case class AssetCreate(name: String, parentId: Option[Long], description: Option[String], source: Option[String], externalId: Option[String], metadata: Option[Map[String, String]], parentExternalId: Option[String], dataSetId: Option[Long], labels: Option[Seq[CogniteExternalId]]) extends WithExternalId
final case class AssetUpdate(name: Option[NonNullableSetter[String]], description: Option[Setter[String]], source: Option[Setter[String]], externalId: Option[Setter[String]], metadata: Option[NonNullableSetter[Map[String, String]]], parentId: Option[Setter[Long]], parentExternalId: Option[Setter[String]], dataSetId: Option[Setter[Long]], labels: Option[LabelsOnUpdate]) extends WithSetExternalId
final case class AssetsFilter(name: Option[String], parentIds: Option[Seq[Long]], rootIds: Option[Seq[CogniteId]], assetSubtreeIds: Option[Seq[CogniteId]], metadata: Option[Map[String, String]], source: Option[String], createdTime: Option[TimeRange], lastUpdatedTime: Option[TimeRange], root: Option[Boolean], externalIdPrefix: Option[String], dataSetIds: Option[Seq[CogniteId]], parentExternalIds: Option[Seq[String]], labels: Option[LabelContainsFilter])
final case class AssetsQuery(filter: Option[AssetsFilter], search: Option[AssetsSearch], limit: Int) extends SearchQuery[AssetsFilter, AssetsSearch]
final case class AssetsSearch(name: Option[String], description: Option[String])
class AuthSttpBackend[F[_], +P](delegate: SttpBackend[F, P], authProvider: AuthProvider[F]) extends SttpBackend[F, P]
final case class BoundingBox(max: Seq[Double], min: Seq[Double])
final case class Camera(target: Option[Seq[Double]], position: Option[Seq[Double]])
final case class Capability(actions: Seq[String], scope: Map[String, Map[String, Json]])
class Client(applicationName: String, val projectName: String, baseUrl: String, auth: Auth)(implicit sttpBackend: SttpBackend[Id, Any]) extends GenericClient[Id]
Companion
object
object Client
Companion
class
final case class CogniteExternalId(externalId: String) extends CogniteId
sealed trait CogniteId
final case class CogniteInternalId(id: Long) extends CogniteId
final case class ConfidenceRange(min: Option[Double], max: Option[Double])
final case class ContainsAll(containsAll: Seq[CogniteExternalId]) extends LabelContainsFilter
final case class ContainsAny(containsAny: Seq[CogniteExternalId]) extends LabelContainsFilter
final case class DataPointsByExternalId(externalId: String, datapoints: Seq[DataPoint])
final case class DataPointsByExternalIdResponse(id: Long, externalId: String, isString: Boolean, isStep: Boolean, unit: Option[String], datapoints: Seq[DataPoint])
final case class DataPointsByIdResponse(id: Long, externalId: Option[String], isString: Boolean, isStep: Boolean, unit: Option[String], datapoints: Seq[DataPoint])
final case class DataSet(id: Long, name: Option[String], writeProtected: Boolean, externalId: Option[String], description: Option[String], metadata: Option[Map[String, String]], createdTime: Instant, lastUpdatedTime: Instant) extends WithId[Long] with WithExternalId with WithCreatedTime with ToCreate[DataSetCreate] with ToUpdate[DataSetUpdate]
final case class DataSetCreate(externalId: Option[String], name: Option[String], description: Option[String], metadata: Option[Map[String, String]], writeProtected: Boolean) extends WithExternalId
final case class DataSetFilter(metadata: Option[Map[String, String]], createdTime: Option[TimeRange], lastUpdatedTime: Option[TimeRange], externalIdPrefix: Option[String], writeProtected: Option[Boolean])
final case class DataSetQuery(filter: Option[DataSetFilter], limit: Int)
final case class DataSetUpdate(externalId: Option[Setter[String]], name: Option[Setter[String]], description: Option[Setter[String]], metadata: Option[NonNullableSetter[Map[String, String]]], writeProtected: Option[NonNullableSetter[Boolean]]) extends WithSetExternalId
final case class DeleteRangeByExternalId(externalId: String, inclusiveBegin: Long, exclusiveEnd: Long) extends DeleteDataPointsRange
final case class DeleteRangeById(id: Long, inclusiveBegin: Long, exclusiveEnd: Long) extends DeleteDataPointsRange
final case class Event(id: Long, startTime: Option[Instant], endTime: Option[Instant], description: Option[String], `type`: Option[String], subtype: Option[String], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], source: Option[String], externalId: Option[String], createdTime: Instant, lastUpdatedTime: Instant, dataSetId: Option[Long]) extends WithId[Long] with WithExternalId with WithCreatedTime with ToCreate[EventCreate] with ToUpdate[EventUpdate]
final case class EventCreate(startTime: Option[Instant], endTime: Option[Instant], description: Option[String], `type`: Option[String], subtype: Option[String], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], source: Option[String], externalId: Option[String], dataSetId: Option[Long]) extends WithExternalId
final case class EventUpdate(startTime: Option[Setter[Instant]], endTime: Option[Setter[Instant]], description: Option[Setter[String]], `type`: Option[Setter[String]], subtype: Option[Setter[String]], metadata: Option[NonNullableSetter[Map[String, String]]], assetIds: Option[NonNullableSetter[Seq[Long]]], source: Option[Setter[String]], externalId: Option[Setter[String]], dataSetId: Option[Setter[Long]]) extends WithSetExternalId
final case class EventsFilter(startTime: Option[TimeRange], endTime: Option[TimeRange], activeAtTime: Option[TimeRange], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], rootAssetIds: Option[Seq[CogniteId]], source: Option[String], `type`: Option[String], subtype: Option[String], createdTime: Option[TimeRange], lastUpdatedTime: Option[TimeRange], externalIdPrefix: Option[String], dataSetIds: Option[Seq[CogniteId]])
final case class EventsQuery(filter: Option[EventsFilter], search: Option[EventsSearch], limit: Int) extends SearchQuery[EventsFilter, EventsSearch]
final case class EventsSearch(description: Option[String])
final case class File(id: Long, name: String, directory: Option[String], source: Option[String], externalId: Option[String], mimeType: Option[String], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], uploaded: Boolean, uploadedTime: Option[Instant], createdTime: Instant, lastUpdatedTime: Instant, dataSetId: Option[Long], sourceCreatedTime: Option[Instant], sourceModifiedTime: Option[Instant], securityCategories: Option[Seq[Long]], uploadUrl: Option[String]) extends WithId[Long] with WithExternalId with WithCreatedTime with ToCreate[FileCreate] with ToUpdate[FileUpdate]
final case class FileCreate(name: String, directory: Option[String], source: Option[String], externalId: Option[String], mimeType: Option[String], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], dataSetId: Option[Long], sourceCreatedTime: Option[Instant], sourceModifiedTime: Option[Instant], securityCategories: Option[Seq[Long]]) extends WithExternalId
sealed trait FileDownload
final case class FileDownloadExternalId(externalId: String) extends FileDownload
final case class FileDownloadId(id: Long) extends FileDownload
sealed trait FileDownloadLink
final case class FileDownloadLinkExternalId(externalId: String, downloadUrl: String) extends FileDownloadLink
final case class FileDownloadLinkId(id: Long, downloadUrl: String) extends FileDownloadLink
final case class FileUpdate(externalId: Option[Setter[String]], source: Option[Setter[String]], directory: Option[Setter[String]], mimeType: Option[Setter[String]], metadata: Option[NonNullableSetter[Map[String, String]]], assetIds: Option[NonNullableSetter[Seq[Long]]], sourceCreatedTime: Option[Setter[Instant]], sourceModifiedTime: Option[Setter[Instant]], securityCategories: Option[NonNullableSetter[Seq[Long]]], dataSetId: Option[Setter[Long]]) extends WithSetExternalId
final case class FilesFilter(name: Option[String], mimeType: Option[String], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], rootAssetIds: Option[Seq[CogniteId]], source: Option[String], createdTime: Option[TimeRange], lastUpdatedTime: Option[TimeRange], uploadedTime: Option[TimeRange], sourceCreatedTime: Option[TimeRange], sourceModifiedTime: Option[TimeRange], externalIdPrefix: Option[String], uploaded: Option[Boolean], dataSetIds: Option[Seq[CogniteId]])
final case class FilesQuery(filter: Option[FilesFilter], search: Option[FilesSearch], limit: Int) extends SearchQuery[FilesFilter, FilesSearch]
final case class FilesSearch(name: Option[String])
final case class Function(id: Option[Long], name: String, fileId: Long, owner: Option[String], description: Option[String], apiKey: Option[String], secrets: Option[Map[String, String]], createdTime: Option[Instant], status: Option[String], externalId: Option[String], error: Option[FunctionError]) extends ToCreate[FunctionCreate]
final case class FunctionCall(id: Option[Long], status: Option[String], startTime: Option[Long], endTime: Option[Long], scheduleId: Option[Long], functionId: Option[Long])
final case class FunctionCallFilter(scheduleId: Option[Long], status: Option[String], startTime: Option[Long], endTime: Option[Long])
final case class FunctionCallLogEntry(timestamp: Option[Long], message: Option[String])
final case class FunctionCallResponse(response: Option[Json], functionId: Option[Long], callId: Option[Long])
final case class FunctionCreate(name: String, fileId: Long, owner: Option[String], description: Option[String], apiKey: Option[String], secrets: Option[Map[String, String]], externalId: Option[String], error: Option[FunctionError]) extends WithExternalId
final case class FunctionError(message: Option[String], trace: Option[String])
final case class FunctionSchedule(id: Option[Long], name: String, functionExternalId: String, createdTime: Option[Long], description: Option[String], cronExpression: Option[String], data: Option[Json]) extends ToCreate[FunctionScheduleCreate]
final case class FunctionScheduleCreate(name: String, functionExternalId: String, description: Option[String], cronExpression: String, data: Option[Json])
class GenericClient[F[_]](applicationName: String, val projectName: String, baseUrl: String, authProvider: AuthProvider[F], apiVersion: Option[String], clientTag: Option[String])(implicit monad: Monad[F], sttpBackend: SttpBackend[F, Any])
Companion
object
Companion
class
final case class Group(name: String, sourceId: Option[String], capabilities: Seq[Map[String, Capability]], id: Long, isDeleted: Boolean, deletedTime: Option[Instant]) extends WithId[Long]
final case class Label(externalId: String, name: String, description: Option[String], createdTime: Instant) extends WithRequiredExternalId with WithCreatedTime with ToCreate[LabelCreate]
sealed trait LabelContainsFilter
final case class LabelCreate(externalId: String, name: String, description: Option[String]) extends WithRequiredExternalId
final case class LabelsFilter(name: Option[String], externalIdPrefix: Option[String])
final case class LabelsOnUpdate(add: Option[Seq[CogniteExternalId]], remove: Option[Seq[CogniteExternalId]])
final case class Project(name: String, urlName: String, defaultGroupId: Option[Long], authentication: Option[ProjectAuthentication])
final case class ProjectAuthentication(validDomains: Seq[String])
final case class Properties(properties: Map[String, Map[String, String]])
final case class QueryAggregatesResponse(id: Long, externalId: Option[String], isString: Boolean, isStep: Boolean, unit: Option[String], datapoints: Seq[AggregateDataPoint])
final case class QueryRangeByExternalId(externalId: String, start: String, end: String, limit: Option[Int], granularity: Option[String], aggregates: Option[Seq[String]])
final case class QueryRangeById(id: Long, start: String, end: String, limit: Option[Int], granularity: Option[String], aggregates: Option[Seq[String]])
final case class RawDatabase(name: String) extends WithId[String] with ToCreate[RawDatabase]
final case class RawRow(key: String, columns: Map[String, Json], lastUpdatedTime: Option[Instant]) extends ToCreate[RawRow]
final case class RawRowFilter(minLastUpdatedTime: Option[Instant], maxLastUpdatedTime: Option[Instant], columns: Option[Seq[String]])
final case class RawRowKey(key: String)
final case class RawTable(name: String) extends WithId[String] with ToCreate[RawTable]
final case class Relationship(externalId: String, sourceExternalId: String, sourceType: String, targetExternalId: String, targetType: String, startTime: Option[Instant], endTime: Option[Instant], confidence: Option[Double], dataSetId: Option[Long], labels: Option[Seq[CogniteExternalId]], createdTime: Instant, lastUpdatedTime: Instant) extends WithRequiredExternalId with WithCreatedTime with ToCreate[RelationshipCreate]
final case class RelationshipCreate(externalId: String, sourceExternalId: String, sourceType: String, targetExternalId: String, targetType: String, startTime: Option[Instant], endTime: Option[Instant], confidence: Option[Double], dataSetId: Option[Long], labels: Option[Seq[CogniteExternalId]]) extends WithRequiredExternalId
final case class RelationshipsFilter(sourceExternalIds: Option[Seq[String]], sourceTypes: Option[Seq[String]], targetExternalIds: Option[Seq[String]], targetTypes: Option[Seq[String]], dataSetIds: Option[Seq[CogniteId]], startTime: Option[TimeRange], endTime: Option[TimeRange], confidence: Option[ConfidenceRange], lastUpdatedTime: Option[TimeRange], createdTime: Option[TimeRange], activeAtTime: Option[TimeRange], labels: Option[LabelContainsFilter])
final case class RequestSession[F[_]](applicationName: String, baseUrl: Uri, baseSttpBackend: SttpBackend[F, _], auth: AuthProvider[F], clientTag: Option[String])(implicit evidence$1: Monad[F])
final case class SecurityCategory(name: String, id: Long) extends WithId[Long]
final case class Sequence(id: Long, name: Option[String], description: Option[String], assetId: Option[Long], externalId: Option[String], metadata: Option[Map[String, String]], columns: NonEmptyList[SequenceColumn], createdTime: Instant, lastUpdatedTime: Instant, dataSetId: Option[Long]) extends WithId[Long] with WithExternalId with WithCreatedTime with ToCreate[SequenceCreate] with ToUpdate[SequenceUpdate]
final case class SequenceColumn(name: Option[String], externalId: Option[String], description: Option[String], valueType: String, metadata: Option[Map[String, String]], createdTime: Instant, lastUpdatedTime: Instant) extends ToCreate[SequenceColumnCreate]
final case class SequenceColumnCreate(name: Option[String], externalId: String, description: Option[String], valueType: String, metadata: Option[Map[String, String]])
final case class SequenceColumnSignature(externalId: String, name: Option[String], valueType: String)
final case class SequenceCreate(name: Option[String], description: Option[String], assetId: Option[Long], externalId: Option[String], metadata: Option[Map[String, String]], columns: NonEmptyList[SequenceColumnCreate], dataSetId: Option[Long]) extends WithExternalId
final case class SequenceFilter(name: Option[String], externalIdPrefix: Option[String], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], rootAssetIds: Option[Seq[Long]], createdTime: Option[TimeRange], lastUpdatedTime: Option[TimeRange], dataSetIds: Option[Seq[CogniteId]])
final case class SequenceQuery(filter: Option[SequenceFilter], search: Option[SequenceSearch], limit: Int) extends SearchQuery[SequenceFilter, SequenceSearch]
final case class SequenceRow(rowNumber: Long, values: Seq[Json])
final case class SequenceRowsDeleteByExternalId(externalId: String, rows: Seq[Long])
final case class SequenceRowsDeleteById(id: Long, rows: Seq[Long])
final case class SequenceRowsInsertByExternalId(externalId: String, columns: Seq[String], rows: Seq[SequenceRow])
final case class SequenceRowsInsertById(id: Long, columns: Seq[String], rows: Seq[SequenceRow])
sealed trait SequenceRowsQuery
final case class SequenceRowsQueryByExternalId(externalId: String, start: Option[Long], end: Option[Long], limit: Option[Int], cursor: Option[String], columns: Option[Seq[String]]) extends SequenceRowsQuery
final case class SequenceRowsQueryById(id: Long, start: Option[Long], end: Option[Long], limit: Option[Int], cursor: Option[String], columns: Option[Seq[String]]) extends SequenceRowsQuery
final case class SequenceRowsResponse(id: Long, externalId: Option[String], columns: Seq[SequenceColumnSignature], rows: Seq[SequenceRow], nextCursor: Option[String]) extends ResponseWithCursor
final case class SequenceSearch(name: Option[String], description: Option[String], query: Option[String])
final case class SequenceUpdate(name: Option[Setter[String]], description: Option[Setter[String]], assetId: Option[Setter[Long]], externalId: Option[Setter[String]], metadata: Option[NonNullableSetter[Map[String, String]]], dataSetId: Option[Setter[Long]]) extends WithSetExternalId
final case class ServiceAccount(name: String, groups: Seq[Long], id: Long, isDeleted: Boolean, deletedTime: Option[Instant]) extends WithId[Long]
final case class StringDataPointsByExternalId(externalId: String, datapoints: Seq[StringDataPoint])
final case class StringDataPointsByExternalIdResponse(id: Long, externalId: String, isString: Boolean, unit: Option[String], datapoints: Seq[StringDataPoint])
final case class StringDataPointsByIdResponse(id: Long, externalId: Option[String], isString: Boolean, unit: Option[String], datapoints: Seq[StringDataPoint])
final case class ThreeDAssetMapping(nodeId: Long, assetId: Long, treeIndex: Option[Long], subtreeSize: Option[Long])
final case class ThreeDAssetMappingCreate(nodeId: Long, assetId: Long)
final case class ThreeDModel(name: String, id: Long, createdTime: Instant, metadata: Option[Map[String, String]]) extends WithId[Long] with ToCreate[ThreeDModelCreate] with ToUpdate[ThreeDModelUpdate]
final case class ThreeDModelCreate(name: String, metadata: Option[Map[String, String]])
final case class ThreeDModelUpdate(id: Long, name: Option[NonNullableSetter[String]], metadata: Option[NonNullableSetter[Map[String, String]]]) extends WithId[Long]
final case class ThreeDNode(id: Long, treeIndex: Long, parentId: Option[Long], depth: Long, name: String, subtreeSize: Long, properties: Option[Map[String, Map[String, String]]], boundingBox: Option[BoundingBox])
final case class ThreeDNodeFilter(limit: Int, depth: Int, nodeId: Long, properties: Properties)
final case class ThreeDRevision(id: Long, fileId: Long, published: Boolean, rotation: Option[Seq[Double]], camera: Option[Camera], status: String, metadata: Option[Map[String, String]], thumbnailThreedFileId: Option[Long], thumbnailURL: Option[String], assetMappingCount: Long, createdTime: Instant) extends WithId[Long] with ToCreate[ThreeDRevisionCreate] with ToUpdate[ThreeDRevisionUpdate]
final case class ThreeDRevisionCreate(published: Boolean, rotation: Option[Seq[Double]], metadata: Option[Map[String, String]], camera: Option[Camera], fileId: Long)
final case class ThreeDRevisionUpdate(id: Long, published: Option[NonNullableSetter[Boolean]], rotation: Option[NonNullableSetter[Seq[Double]]], camera: Option[NonNullableSetter[Camera]], metadata: Option[NonNullableSetter[Map[String, String]]]) extends WithId[Long]
final case class TimeRange(min: Option[Instant], max: Option[Instant])
final case class TimeSeries(name: Option[String], isString: Boolean, metadata: Option[Map[String, String]], unit: Option[String], assetId: Option[Long], isStep: Boolean, description: Option[String], securityCategories: Option[Seq[Long]], id: Long, externalId: Option[String], createdTime: Instant, lastUpdatedTime: Instant, dataSetId: Option[Long]) extends WithId[Long] with WithExternalId with WithCreatedTime with ToCreate[TimeSeriesCreate] with ToUpdate[TimeSeriesUpdate]
final case class TimeSeriesCreate(externalId: Option[String], name: Option[String], isString: Boolean, metadata: Option[Map[String, String]], unit: Option[String], assetId: Option[Long], isStep: Boolean, description: Option[String], securityCategories: Option[Seq[Long]], dataSetId: Option[Long]) extends WithExternalId
final case class TimeSeriesFilter(name: Option[String], unit: Option[String], isString: Option[Boolean], isStep: Option[Boolean], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], rootAssetIds: Option[Seq[CogniteId]], externalIdPrefix: Option[String], createdTime: Option[TimeRange], lastUpdatedTime: Option[TimeRange], dataSetIds: Option[Seq[CogniteId]])
final case class TimeSeriesQuery(filter: Option[TimeSeriesSearchFilter], search: Option[TimeSeriesSearch], limit: Int) extends SearchQuery[TimeSeriesSearchFilter, TimeSeriesSearch]
final case class TimeSeriesSearch(name: Option[String], description: Option[String], query: Option[String])
final case class TimeSeriesSearchFilter(name: Option[String], unit: Option[String], isString: Option[Boolean], isStep: Option[Boolean], metadata: Option[Map[String, String]], assetIds: Option[Seq[Long]], externalIdPrefix: Option[String], createdTime: Option[TimeRange], lastUpdatedTime: Option[TimeRange], dataSetIds: Option[Seq[CogniteId]])
final case class TimeSeriesUpdate(name: Option[Setter[String]], externalId: Option[Setter[String]], metadata: Option[NonNullableSetter[Map[String, String]]], unit: Option[Setter[String]], assetId: Option[Setter[Long]], description: Option[Setter[String]], securityCategories: Option[NonNullableSetter[Seq[Long]]], dataSetId: Option[Setter[Long]]) extends WithSetExternalId

Implicits

Implicits

implicit val sttpBackend: SttpBackend[Id, Any]