smithy4s.com.amazonaws.kinesis.ListStreamsOutput.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 output for ListStreams.
  * @param StreamNames
  *   The names of the streams that are associated with the Amazon Web Services account
  *               making the ListStreams request.
  * @param HasMoreStreams
  *   If set to true, there are more streams available to list.
  * @param NextToken
  *   
  * @param StreamSummaries
  *   
  */
final case class ListStreamsOutput(streamNames: List[StreamName], hasMoreStreams: BooleanObject, nextToken: Option[NextToken] = None, streamSummaries: Option[List[StreamSummary]] = None)

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

  val hints: Hints = Hints(
    smithy.api.Documentation("Represents the output for ListStreams."),
    smithy.api.Output(),
  ).lazily

  // constructor using the original order from the spec
  private def make(streamNames: List[StreamName], hasMoreStreams: BooleanObject, nextToken: Option[NextToken], streamSummaries: Option[List[StreamSummary]]): ListStreamsOutput = ListStreamsOutput(streamNames, hasMoreStreams, nextToken, streamSummaries)

  implicit val schema: Schema[ListStreamsOutput] = struct(
    StreamNameList.underlyingSchema.required[ListStreamsOutput]("StreamNames", _.streamNames).addHints(smithy.api.Documentation("The names of the streams that are associated with the Amazon Web Services account\n            making the ListStreams request.")),
    BooleanObject.schema.required[ListStreamsOutput]("HasMoreStreams", _.hasMoreStreams).addHints(smithy.api.Documentation("If set to true, there are more streams available to list.")),
    NextToken.schema.optional[ListStreamsOutput]("NextToken", _.nextToken).addHints(smithy.api.Documentation("")),
    StreamSummaryList.underlyingSchema.optional[ListStreamsOutput]("StreamSummaries", _.streamSummaries).addHints(smithy.api.Documentation("")),
  )(make).withId(id).addHints(hints)
}