Edge.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.XRay.Types.Edge
-- 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.XRay.Types.Edge where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import Amazonka.XRay.Types.Alias
import Amazonka.XRay.Types.EdgeStatistics
import Amazonka.XRay.Types.HistogramEntry

-- | Information about a connection between two services. An edge can be a
-- synchronous connection, such as typical call between client and service,
-- or an asynchronous link, such as a Lambda function which retrieves an
-- event from an SNS queue.
--
-- /See:/ 'newEdge' smart constructor.
data Edge = Edge'
  { -- | Aliases for the edge.
    aliases :: Prelude.Maybe [Alias],
    -- | Describes an asynchronous connection, with a value of @link@.
    edgeType :: Prelude.Maybe Prelude.Text,
    -- | The end time of the last segment on the edge.
    endTime :: Prelude.Maybe Data.POSIX,
    -- | A histogram that maps the spread of event age when received by
    -- consumers. Age is calculated each time an event is received. Only
    -- populated when /EdgeType/ is @link@.
    receivedEventAgeHistogram :: Prelude.Maybe [HistogramEntry],
    -- | Identifier of the edge. Unique within a service map.
    referenceId :: Prelude.Maybe Prelude.Int,
    -- | A histogram that maps the spread of client response times on an edge.
    -- Only populated for synchronous edges.
    responseTimeHistogram :: Prelude.Maybe [HistogramEntry],
    -- | The start time of the first segment on the edge.
    startTime :: Prelude.Maybe Data.POSIX,
    -- | Response statistics for segments on the edge.
    summaryStatistics :: Prelude.Maybe EdgeStatistics
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'Edge' 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:
--
-- 'aliases', 'edge_aliases' - Aliases for the edge.
--
-- 'edgeType', 'edge_edgeType' - Describes an asynchronous connection, with a value of @link@.
--
-- 'endTime', 'edge_endTime' - The end time of the last segment on the edge.
--
-- 'receivedEventAgeHistogram', 'edge_receivedEventAgeHistogram' - A histogram that maps the spread of event age when received by
-- consumers. Age is calculated each time an event is received. Only
-- populated when /EdgeType/ is @link@.
--
-- 'referenceId', 'edge_referenceId' - Identifier of the edge. Unique within a service map.
--
-- 'responseTimeHistogram', 'edge_responseTimeHistogram' - A histogram that maps the spread of client response times on an edge.
-- Only populated for synchronous edges.
--
-- 'startTime', 'edge_startTime' - The start time of the first segment on the edge.
--
-- 'summaryStatistics', 'edge_summaryStatistics' - Response statistics for segments on the edge.
newEdge ::
  Edge
newEdge =
  Edge'
    { aliases = Prelude.Nothing,
      edgeType = Prelude.Nothing,
      endTime = Prelude.Nothing,
      receivedEventAgeHistogram = Prelude.Nothing,
      referenceId = Prelude.Nothing,
      responseTimeHistogram = Prelude.Nothing,
      startTime = Prelude.Nothing,
      summaryStatistics = Prelude.Nothing
    }

-- | Aliases for the edge.
edge_aliases :: Lens.Lens' Edge (Prelude.Maybe [Alias])
edge_aliases = Lens.lens (\Edge' {aliases} -> aliases) (\s@Edge' {} a -> s {aliases = a} :: Edge) Prelude.. Lens.mapping Lens.coerced

-- | Describes an asynchronous connection, with a value of @link@.
edge_edgeType :: Lens.Lens' Edge (Prelude.Maybe Prelude.Text)
edge_edgeType = Lens.lens (\Edge' {edgeType} -> edgeType) (\s@Edge' {} a -> s {edgeType = a} :: Edge)

-- | The end time of the last segment on the edge.
edge_endTime :: Lens.Lens' Edge (Prelude.Maybe Prelude.UTCTime)
edge_endTime = Lens.lens (\Edge' {endTime} -> endTime) (\s@Edge' {} a -> s {endTime = a} :: Edge) Prelude.. Lens.mapping Data._Time

-- | A histogram that maps the spread of event age when received by
-- consumers. Age is calculated each time an event is received. Only
-- populated when /EdgeType/ is @link@.
edge_receivedEventAgeHistogram :: Lens.Lens' Edge (Prelude.Maybe [HistogramEntry])
edge_receivedEventAgeHistogram = Lens.lens (\Edge' {receivedEventAgeHistogram} -> receivedEventAgeHistogram) (\s@Edge' {} a -> s {receivedEventAgeHistogram = a} :: Edge) Prelude.. Lens.mapping Lens.coerced

-- | Identifier of the edge. Unique within a service map.
edge_referenceId :: Lens.Lens' Edge (Prelude.Maybe Prelude.Int)
edge_referenceId = Lens.lens (\Edge' {referenceId} -> referenceId) (\s@Edge' {} a -> s {referenceId = a} :: Edge)

-- | A histogram that maps the spread of client response times on an edge.
-- Only populated for synchronous edges.
edge_responseTimeHistogram :: Lens.Lens' Edge (Prelude.Maybe [HistogramEntry])
edge_responseTimeHistogram = Lens.lens (\Edge' {responseTimeHistogram} -> responseTimeHistogram) (\s@Edge' {} a -> s {responseTimeHistogram = a} :: Edge) Prelude.. Lens.mapping Lens.coerced

-- | The start time of the first segment on the edge.
edge_startTime :: Lens.Lens' Edge (Prelude.Maybe Prelude.UTCTime)
edge_startTime = Lens.lens (\Edge' {startTime} -> startTime) (\s@Edge' {} a -> s {startTime = a} :: Edge) Prelude.. Lens.mapping Data._Time

-- | Response statistics for segments on the edge.
edge_summaryStatistics :: Lens.Lens' Edge (Prelude.Maybe EdgeStatistics)
edge_summaryStatistics = Lens.lens (\Edge' {summaryStatistics} -> summaryStatistics) (\s@Edge' {} a -> s {summaryStatistics = a} :: Edge)

instance Data.FromJSON Edge where
  parseJSON =
    Data.withObject
      "Edge"
      ( \x ->
          Edge'
            Prelude.<$> (x Data..:? "Aliases" Data..!= Prelude.mempty)
            Prelude.<*> (x Data..:? "EdgeType")
            Prelude.<*> (x Data..:? "EndTime")
            Prelude.<*> ( x
                            Data..:? "ReceivedEventAgeHistogram"
                            Data..!= Prelude.mempty
                        )
            Prelude.<*> (x Data..:? "ReferenceId")
            Prelude.<*> ( x
                            Data..:? "ResponseTimeHistogram"
                            Data..!= Prelude.mempty
                        )
            Prelude.<*> (x Data..:? "StartTime")
            Prelude.<*> (x Data..:? "SummaryStatistics")
      )

instance Prelude.Hashable Edge where
  hashWithSalt _salt Edge' {..} =
    _salt
      `Prelude.hashWithSalt` aliases
      `Prelude.hashWithSalt` edgeType
      `Prelude.hashWithSalt` endTime
      `Prelude.hashWithSalt` receivedEventAgeHistogram
      `Prelude.hashWithSalt` referenceId
      `Prelude.hashWithSalt` responseTimeHistogram
      `Prelude.hashWithSalt` startTime
      `Prelude.hashWithSalt` summaryStatistics

instance Prelude.NFData Edge where
  rnf Edge' {..} =
    Prelude.rnf aliases
      `Prelude.seq` Prelude.rnf edgeType
      `Prelude.seq` Prelude.rnf endTime
      `Prelude.seq` Prelude.rnf receivedEventAgeHistogram
      `Prelude.seq` Prelude.rnf referenceId
      `Prelude.seq` Prelude.rnf responseTimeHistogram
      `Prelude.seq` Prelude.rnf startTime
      `Prelude.seq` Prelude.rnf summaryStatistics