com.cognite.sdk.scala.v1.sequences.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cognite-sdk-scala_2.13 Show documentation
Scala SDK for Cognite Data Fusion.
The newest version!
// Copyright 2020 Cognite AS
// SPDX-License-Identifier: Apache-2.0

package com.cognite.sdk.scala.v1

import java.time.Instant

import cats.data.NonEmptyList
import com.cognite.sdk.scala.common.{
  NonNullableSetter,
  SdkException,
  SearchQuery,
  Setter,
  ToCreate,
  ToUpdate,
  WithCreatedTime,
  WithExternalId,
  WithId,
  WithSetExternalId
}

final case class SequenceColumn(
    name: Option[String] = None,
    // externalId must be optional until all data created using v0.6
    // of the API has been migrated and this field has been marked as
    // required in the official API docs.
    externalId: Option[String] = None,
    description: Option[String] = None,
    // TODO: Turn this into an enum.
    //       See https://github.com/circe/circe-derivation/issues/8
    //       and https://github.com/circe/circe-derivation/pull/91
    valueType: String = "STRING",
    metadata: Option[Map[String, String]] = None,
    createdTime: Instant = Instant.ofEpochMilli(0),
    lastUpdatedTime: Instant = Instant.ofEpochMilli(0)
) extends ToCreate[SequenceColumnCreate] {
  override def toCreate: SequenceColumnCreate =
    SequenceColumnCreate(
      name,
      // externalId is optional when reading, despite being required when
      // writing. This is due to it being optional in v0.6, and data from
      // there has not yet been migrated.
      // When it has, and externalId has been marked as required in the
      // official API docs, we should be able to remove this.
      externalId.getOrElse(
        throw new RuntimeException("Can't create sequence column without externalId")
      ),
      description,
      valueType,
      metadata
    )

  def toModify: SequenceColumnModify = SequenceColumnModify(
    description = Setter.fromOption(description),
    externalId = NonNullableSetter.fromOption(externalId),
    name = Setter.fromOption(name),
    metadata = NonNullableSetter.fromOption(metadata)
  )
}

final case class SequenceColumnCreate(
    name: Option[String] = None,
    externalId: String,
    description: Option[String] = None,
    // TODO: Turn this into an enum.
    //       See https://github.com/circe/circe-derivation/issues/8
    //       and https://github.com/circe/circe-derivation/pull/91
    valueType: String = "STRING",
    metadata: Option[Map[String, String]] = None
)

final case class Sequence(
    id: Long = 0,
    name: Option[String] = None,
    description: Option[String] = None,
    assetId: Option[Long] = None,
    externalId: Option[String] = None,
    metadata: Option[Map[String, String]] = None,
    columns: NonEmptyList[SequenceColumn],
    createdTime: Instant = Instant.ofEpochMilli(0),
    lastUpdatedTime: Instant = Instant.ofEpochMilli(0),
    dataSetId: Option[Long] = None
) extends WithId[Long]
    with WithExternalId
    with WithCreatedTime
    with ToCreate[SequenceCreate]
    with ToUpdate[SequenceUpdate] {
  override def toCreate: SequenceCreate =
    SequenceCreate(
      name,
      description,
      assetId,
      externalId,
      metadata,
      columns.map(_.toCreate),
      dataSetId
    )

  private def getColumnsUpdate = SequenceColumnsUpdate(modify =
    Some(
      columns
        .map(col =>
          SequenceColumnModifyUpdate(
            externalId = col.externalId
              .getOrElse(throw SdkException(s"Sequence columns must have an externalId")),
            update = col.toModify
          )
        )
        .toList
    )
  )

  override def toUpdate: SequenceUpdate =
    SequenceUpdate(
      Setter.fromOption(name),
      Setter.fromOption(description),
      Setter.fromOption(assetId),
      Setter.fromOption(externalId),
      NonNullableSetter.fromOption(metadata),
      Some(getColumnsUpdate),
      Setter.fromOption(dataSetId)
    )
}

final case class SequenceCreate(
    name: Option[String] = None,
    description: Option[String] = None,
    assetId: Option[Long] = None,
    externalId: Option[String] = None,
    metadata: Option[Map[String, String]] = None,
    columns: NonEmptyList[SequenceColumnCreate],
    dataSetId: Option[Long] = None
) extends WithExternalId

final case class SequenceColumnModify(
    description: Option[Setter[String]] = None,
    externalId: Option[NonNullableSetter[String]] = None,
    name: Option[Setter[String]] = None,
    metadata: Option[NonNullableSetter[Map[String, String]]] = None
)

final case class SequenceColumnModifyUpdate(
    externalId: String,
    update: SequenceColumnModify
)

final case class SequenceColumnsUpdate(
    modify: Option[Seq[SequenceColumnModifyUpdate]] = None,
    add: Option[Seq[SequenceColumnCreate]] = None,
    remove: Option[Seq[CogniteExternalId]] = None
)

final case class SequenceUpdate(
    name: Option[Setter[String]] = None,
    description: Option[Setter[String]] = None,
    assetId: Option[Setter[Long]] = None,
    externalId: Option[Setter[String]] = None,
    metadata: Option[NonNullableSetter[Map[String, String]]] = None,
    columns: Option[SequenceColumnsUpdate] = None,
    dataSetId: Option[Setter[Long]] = None
) extends WithSetExternalId

final case class SequenceFilter(
    name: Option[String] = None,
    externalIdPrefix: Option[String] = None,
    metadata: Option[Map[String, String]] = None,
    assetIds: Option[Seq[Long]] = None,
    rootAssetIds: Option[Seq[Long]] = None,
    createdTime: Option[TimeRange] = None,
    lastUpdatedTime: Option[TimeRange] = None,
    dataSetIds: Option[Seq[CogniteId]] = None
)

final case class SequenceSearch(
    name: Option[String] = None,
    description: Option[String] = None,
    query: Option[String] = None
)

final case class SequenceQuery(
    filter: Option[SequenceFilter] = None,
    search: Option[SequenceSearch] = None,
    limit: Int = 100
) extends SearchQuery[SequenceFilter, SequenceSearch]