com.cognite.sdk.scala.v1.fdm.instances.NodeOrEdgeCreate.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.fdm.instances

import com.cognite.sdk.scala.v1.fdm.common.DirectRelationReference
import com.cognite.sdk.scala.v1.fdm.instances.InstanceType._
import io.circe.Encoder
import io.circe.syntax.EncoderOps

sealed abstract class NodeOrEdgeCreate extends Product with Serializable {
  val space: String
  val externalId: String
}

object NodeOrEdgeCreate {

  final case class NodeWrite(
      space: String,
      externalId: String,
      sources: Option[Seq[EdgeOrNodeData]],
      `type`: Option[DirectRelationReference]
  ) extends NodeOrEdgeCreate {
    val instanceType: InstanceType = Node
  }

  final case class EdgeWrite(
      // This is to represent the node that is behind every edge. The value of `type`.externalId can be anything.
      // This is exposed to discourage unnecessary edge creation.
      // Therefore we have to exposing it to the end user, although it can be auto populated.
      // More info: https://cognitedata.slack.com/archives/C031G8Y19HP/p1670333909605369
      `type`: DirectRelationReference,
      space: String,
      externalId: String,
      startNode: DirectRelationReference,
      endNode: DirectRelationReference,
      sources: Option[Seq[EdgeOrNodeData]]
  ) extends NodeOrEdgeCreate {
    val instanceType: InstanceType = Edge
  }

  import com.cognite.sdk.scala.v1.resources.fdm.instances.Instances._

  implicit val nodeWriteEncoder: Encoder[NodeWrite] =
    Encoder.forProduct5("instanceType", "type", "space", "externalId", "sources")((e: NodeWrite) =>
      (e.instanceType, e.`type`, e.space, e.externalId, e.sources)
    )

  implicit val edgeWriteEncoder: Encoder[EdgeWrite] =
    Encoder.forProduct7(
      "instanceType",
      "type",
      "space",
      "externalId",
      "startNode",
      "endNode",
      "sources"
    )((e: EdgeWrite) =>
      (e.instanceType, e.`type`, e.space, e.externalId, e.startNode, e.endNode, e.sources)
    )

  implicit val instanceTypeWriteItemEncoder: Encoder[NodeOrEdgeCreate] =
    Encoder.instance[NodeOrEdgeCreate] {
      case e: NodeWrite => e.asJson
      case e: EdgeWrite => e.asJson
    }

}