• Home
• io.github.etspaceman
• kinesis4cats-smithy4s-client_3
• 0.0.32
• source code
• GetRecordsInput.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package com.amazonaws.kinesis

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

/** 
Represents the input for GetRecords.
  * @param ShardIterator
  *   
The position in the shard from which you want to start sequentially reading data
  *               records. A shard iterator specifies this position using the sequence number of a data
  *               record in the shard.
  * @param Limit
  *   
The maximum number of records to return. Specify a value of up to 10,000. If you
  *               specify a value that is greater than 10,000, GetRecords throws
  *                   InvalidArgumentException. The default value is 10,000.
  * @param StreamARN
  *   
The ARN of the stream.
  */
final case class GetRecordsInput(shardIterator: ShardIterator, limit: Option[GetRecordsInputLimit] = None, streamARN: Option[StreamARN] = None)

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

  val hints: Hints = Hints(
    smithy.api.Documentation("
Represents the input for GetRecords.
"),
    smithy.api.Input(),
  ).lazily

  // constructor using the original order from the spec
  private def make(shardIterator: ShardIterator, limit: Option[GetRecordsInputLimit], streamARN: Option[StreamARN]): GetRecordsInput = GetRecordsInput(shardIterator, limit, streamARN)

  implicit val schema: Schema[GetRecordsInput] = struct(
    ShardIterator.schema.required[GetRecordsInput]("ShardIterator", _.shardIterator).addHints(smithy.api.Documentation("
The position in the shard from which you want to start sequentially reading data\n            records. A shard iterator specifies this position using the sequence number of a data\n            record in the shard.
")),
    GetRecordsInputLimit.schema.optional[GetRecordsInput]("Limit", _.limit).addHints(smithy.api.Documentation("
The maximum number of records to return. Specify a value of up to 10,000. If you\n            specify a value that is greater than 10,000, GetRecords throws\n                InvalidArgumentException. The default value is 10,000.
")),
    StreamARN.schema.optional[GetRecordsInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("
The ARN of the stream.
")),
  )(make).withId(id).addHints(hints)
}