ChildShard.hs

{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Kinesis.Types.ChildShard
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Kinesis.Types.ChildShard where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kinesis.Types.HashKeyRange
import qualified Amazonka.Prelude as Prelude

-- | Output parameter of the GetRecords API. The existing child shard of the
-- current shard.
--
-- /See:/ 'newChildShard' smart constructor.
data ChildShard = ChildShard'
  { -- | The shard ID of the existing child shard of the current shard.
    shardId :: Prelude.Text,
    -- | The current shard that is the parent of the existing child shard.
    parentShards :: [Prelude.Text],
    hashKeyRange :: HashKeyRange
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ChildShard' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'shardId', 'childShard_shardId' - The shard ID of the existing child shard of the current shard.
--
-- 'parentShards', 'childShard_parentShards' - The current shard that is the parent of the existing child shard.
--
-- 'hashKeyRange', 'childShard_hashKeyRange' - Undocumented member.
newChildShard ::
  -- | 'shardId'
  Prelude.Text ->
  -- | 'hashKeyRange'
  HashKeyRange ->
  ChildShard
newChildShard pShardId_ pHashKeyRange_ =
  ChildShard'
    { shardId = pShardId_,
      parentShards = Prelude.mempty,
      hashKeyRange = pHashKeyRange_
    }

-- | The shard ID of the existing child shard of the current shard.
childShard_shardId :: Lens.Lens' ChildShard Prelude.Text
childShard_shardId = Lens.lens (\ChildShard' {shardId} -> shardId) (\s@ChildShard' {} a -> s {shardId = a} :: ChildShard)

-- | The current shard that is the parent of the existing child shard.
childShard_parentShards :: Lens.Lens' ChildShard [Prelude.Text]
childShard_parentShards = Lens.lens (\ChildShard' {parentShards} -> parentShards) (\s@ChildShard' {} a -> s {parentShards = a} :: ChildShard) Prelude.. Lens.coerced

-- | Undocumented member.
childShard_hashKeyRange :: Lens.Lens' ChildShard HashKeyRange
childShard_hashKeyRange = Lens.lens (\ChildShard' {hashKeyRange} -> hashKeyRange) (\s@ChildShard' {} a -> s {hashKeyRange = a} :: ChildShard)

instance Data.FromJSON ChildShard where
  parseJSON =
    Data.withObject
      "ChildShard"
      ( \x ->
          ChildShard'
            Prelude.<$> (x Data..: "ShardId")
            Prelude.<*> (x Data..:? "ParentShards" Data..!= Prelude.mempty)
            Prelude.<*> (x Data..: "HashKeyRange")
      )

instance Prelude.Hashable ChildShard where
  hashWithSalt _salt ChildShard' {..} =
    _salt
      `Prelude.hashWithSalt` shardId
      `Prelude.hashWithSalt` parentShards
      `Prelude.hashWithSalt` hashKeyRange

instance Prelude.NFData ChildShard where
  rnf ChildShard' {..} =
    Prelude.rnf shardId
      `Prelude.seq` Prelude.rnf parentShards
      `Prelude.seq` Prelude.rnf hashKeyRange