smithy4s.com.amazonaws.kinesis.PutRecordsInput.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kinesis4cats-smithy4s-client_3 Show documentation

Cats tooling for the Smithy4s Kinesis Client

The newest version!

package com.amazonaws.kinesis

import smithy4s.Hints
import smithy4s.Schema
import smithy4s.ShapeId
import smithy4s.ShapeTag
import smithy4s.schema.Schema.struct

/** A PutRecords request.
  * @param Records
  *   The records associated with the request.
  * @param StreamName
  *   The stream name associated with the request.
  * @param StreamARN
  *   The ARN of the stream.
  */
final case class PutRecordsInput(records: List[PutRecordsRequestEntry], streamName: Option[StreamName] = None, streamARN: Option[StreamARN] = None)

object PutRecordsInput extends ShapeTag.Companion[PutRecordsInput] {
  val id: ShapeId = ShapeId("com.amazonaws.kinesis", "PutRecordsInput")

  val hints: Hints = Hints(
    smithy.api.Documentation("A PutRecords request."),
    smithy.api.Input(),
  ).lazily

  // constructor using the original order from the spec
  private def make(records: List[PutRecordsRequestEntry], streamName: Option[StreamName], streamARN: Option[StreamARN]): PutRecordsInput = PutRecordsInput(records, streamName, streamARN)

  implicit val schema: Schema[PutRecordsInput] = struct(
    PutRecordsRequestEntryList.underlyingSchema.required[PutRecordsInput]("Records", _.records).addHints(smithy.api.Documentation("The records associated with the request.")),
    StreamName.schema.optional[PutRecordsInput]("StreamName", _.streamName).addHints(smithy.api.Documentation("The stream name associated with the request.")),
    StreamARN.schema.optional[PutRecordsInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.")),
  )(make).withId(id).addHints(hints)
}