smithy4s.com.amazonaws.kinesis.IncreaseStreamRetentionPeriodInput.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 input for IncreaseStreamRetentionPeriod.
  * @param StreamName
  *   The name of the stream to modify.
  * @param RetentionPeriodHours
  *   The new retention period of the stream, in hours. Must be more than the current
  *               retention period.
  * @param StreamARN
  *   The ARN of the stream.
  */
final case class IncreaseStreamRetentionPeriodInput(retentionPeriodHours: RetentionPeriodHours, streamName: Option[StreamName] = None, streamARN: Option[StreamARN] = None)

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

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

  // constructor using the original order from the spec
  private def make(streamName: Option[StreamName], retentionPeriodHours: RetentionPeriodHours, streamARN: Option[StreamARN]): IncreaseStreamRetentionPeriodInput = IncreaseStreamRetentionPeriodInput(retentionPeriodHours, streamName, streamARN)

  implicit val schema: Schema[IncreaseStreamRetentionPeriodInput] = struct(
    StreamName.schema.optional[IncreaseStreamRetentionPeriodInput]("StreamName", _.streamName).addHints(smithy.api.Documentation("The name of the stream to modify.")),
    RetentionPeriodHours.schema.required[IncreaseStreamRetentionPeriodInput]("RetentionPeriodHours", _.retentionPeriodHours).addHints(smithy.api.Documentation("The new retention period of the stream, in hours. Must be more than the current\n            retention period.")),
    StreamARN.schema.optional[IncreaseStreamRetentionPeriodInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.")),
  )(make).withId(id).addHints(hints)
}