smithy4s.com.amazonaws.kinesis.PutRecordsResultEntry.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

/** Represents the result of an individual record from a PutRecords request.
  *             A record that is successfully added to a stream includes SequenceNumber and
  *                 ShardId in the result. A record that fails to be added to the stream
  *             includes ErrorCode and ErrorMessage in the result.
  * @param SequenceNumber
  *   The sequence number for an individual record result.
  * @param ShardId
  *   The shard ID for an individual record result.
  * @param ErrorCode
  *   The error code for an individual record result. ErrorCodes can be either
  *                   ProvisionedThroughputExceededException or
  *               InternalFailure.
  * @param ErrorMessage
  *   The error message for an individual record result. An ErrorCode value of
  *                   ProvisionedThroughputExceededException has an error message that
  *               includes the account ID, stream name, and shard ID. An ErrorCode value of
  *                   InternalFailure has the error message "Internal Service
  *                   Failure".
  */
final case class PutRecordsResultEntry(sequenceNumber: Option[SequenceNumber] = None, shardId: Option[ShardId] = None, errorCode: Option[ErrorCode] = None, errorMessage: Option[ErrorMessage] = None)

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

  val hints: Hints = Hints(
    smithy.api.Documentation("Represents the result of an individual record from a PutRecords request.\n            A record that is successfully added to a stream includes SequenceNumber and\n                ShardId in the result. A record that fails to be added to the stream\n            includes ErrorCode and ErrorMessage in the result."),
  ).lazily

  // constructor using the original order from the spec
  private def make(sequenceNumber: Option[SequenceNumber], shardId: Option[ShardId], errorCode: Option[ErrorCode], errorMessage: Option[ErrorMessage]): PutRecordsResultEntry = PutRecordsResultEntry(sequenceNumber, shardId, errorCode, errorMessage)

  implicit val schema: Schema[PutRecordsResultEntry] = struct(
    SequenceNumber.schema.optional[PutRecordsResultEntry]("SequenceNumber", _.sequenceNumber).addHints(smithy.api.Documentation("The sequence number for an individual record result.")),
    ShardId.schema.optional[PutRecordsResultEntry]("ShardId", _.shardId).addHints(smithy.api.Documentation("The shard ID for an individual record result.")),
    ErrorCode.schema.optional[PutRecordsResultEntry]("ErrorCode", _.errorCode).addHints(smithy.api.Documentation("The error code for an individual record result. ErrorCodes can be either\n                ProvisionedThroughputExceededException or\n            InternalFailure.")),
    ErrorMessage.schema.optional[PutRecordsResultEntry]("ErrorMessage", _.errorMessage).addHints(smithy.api.Documentation("The error message for an individual record result. An ErrorCode value of\n                ProvisionedThroughputExceededException has an error message that\n            includes the account ID, stream name, and shard ID. An ErrorCode value of\n                InternalFailure has the error message \"Internal Service\n                Failure\".")),
  )(make).withId(id).addHints(hints)
}