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

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

-- |
-- Module      : Amazonka.GameLift.StartMatchBackfill
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Finds new players to fill open slots in currently running game sessions.
-- The backfill match process is essentially identical to the process of
-- forming new matches. Backfill requests use the same matchmaker that was
-- used to make the original match, and they provide matchmaking data for
-- all players currently in the game session. FlexMatch uses this
-- information to select new players so that backfilled match continues to
-- meet the original match requirements.
--
-- When using FlexMatch with GameLift managed hosting, you can request a
-- backfill match from a client service by calling this operation with a
-- GameSession identifier. You also have the option of making backfill
-- requests directly from your game server. In response to a request,
-- FlexMatch creates player sessions for the new players, updates the
-- @GameSession@ resource, and sends updated matchmaking data to the game
-- server. You can request a backfill match at any point after a game
-- session is started. Each game session can have only one active backfill
-- request at a time; a subsequent request automatically replaces the
-- earlier request.
--
-- When using FlexMatch as a standalone component, request a backfill match
-- by calling this operation without a game session identifier. As with
-- newly formed matches, matchmaking results are returned in a matchmaking
-- event so that your game can update the game session that is being
-- backfilled.
--
-- To request a backfill match, specify a unique ticket ID, the original
-- matchmaking configuration, and matchmaking data for all current players
-- in the game session being backfilled. Optionally, specify the
-- @GameSession@ ARN. If successful, a match backfill ticket is created and
-- returned with status set to QUEUED. Track the status of backfill tickets
-- using the same method for tracking tickets for new matches.
--
-- __Learn more__
--
-- <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html Backfill existing games with FlexMatch>
--
-- <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html Matchmaking events>
-- (reference)
--
-- <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html How GameLift FlexMatch works>
--
-- __Related actions__
--
-- StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch |
-- StartMatchBackfill |
-- <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets All APIs by task>
module Amazonka.GameLift.StartMatchBackfill
  ( -- * Creating a Request
    StartMatchBackfill (..),
    newStartMatchBackfill,

    -- * Request Lenses
    startMatchBackfill_ticketId,
    startMatchBackfill_gameSessionArn,
    startMatchBackfill_configurationName,
    startMatchBackfill_players,

    -- * Destructuring the Response
    StartMatchBackfillResponse (..),
    newStartMatchBackfillResponse,

    -- * Response Lenses
    startMatchBackfillResponse_matchmakingTicket,
    startMatchBackfillResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.GameLift.Types
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Represents the input for a request operation.
--
-- /See:/ 'newStartMatchBackfill' smart constructor.
data StartMatchBackfill = StartMatchBackfill'
  { -- | A unique identifier for a matchmaking ticket. If no ticket ID is
    -- specified here, Amazon GameLift will generate one in the form of a UUID.
    -- Use this identifier to track the match backfill ticket status and
    -- retrieve match results.
    StartMatchBackfill -> Maybe Text
ticketId :: Prelude.Maybe Prelude.Text,
    -- | A unique identifier for the game session. Use the game session ID. When
    -- using FlexMatch as a standalone matchmaking solution, this parameter is
    -- not needed.
    StartMatchBackfill -> Maybe Text
gameSessionArn :: Prelude.Maybe Prelude.Text,
    -- | Name of the matchmaker to use for this request. You can use either the
    -- configuration name or ARN value. The ARN of the matchmaker that was used
    -- with the original game session is listed in the GameSession object,
    -- @MatchmakerData@ property.
    StartMatchBackfill -> Text
configurationName :: Prelude.Text,
    -- | Match information on all players that are currently assigned to the game
    -- session. This information is used by the matchmaker to find new players
    -- and add them to the existing game.
    --
    -- -   PlayerID, PlayerAttributes, Team -- This information is maintained
    --     in the GameSession object, @MatchmakerData@ property, for all
    --     players who are currently assigned to the game session. The
    --     matchmaker data is in JSON syntax, formatted as a string. For more
    --     details, see
    --     <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data Match Data>.
    --
    -- -   LatencyInMs -- If the matchmaker uses player latency, include a
    --     latency value, in milliseconds, for the Region that the game session
    --     is currently in. Do not include latency values for any other Region.
    StartMatchBackfill -> [Player]
players :: [Player]
  }
  deriving (StartMatchBackfill -> StartMatchBackfill -> Bool
(StartMatchBackfill -> StartMatchBackfill -> Bool)
-> (StartMatchBackfill -> StartMatchBackfill -> Bool)
-> Eq StartMatchBackfill
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartMatchBackfill -> StartMatchBackfill -> Bool
$c/= :: StartMatchBackfill -> StartMatchBackfill -> Bool
== :: StartMatchBackfill -> StartMatchBackfill -> Bool
$c== :: StartMatchBackfill -> StartMatchBackfill -> Bool
Prelude.Eq, ReadPrec [StartMatchBackfill]
ReadPrec StartMatchBackfill
Int -> ReadS StartMatchBackfill
ReadS [StartMatchBackfill]
(Int -> ReadS StartMatchBackfill)
-> ReadS [StartMatchBackfill]
-> ReadPrec StartMatchBackfill
-> ReadPrec [StartMatchBackfill]
-> Read StartMatchBackfill
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartMatchBackfill]
$creadListPrec :: ReadPrec [StartMatchBackfill]
readPrec :: ReadPrec StartMatchBackfill
$creadPrec :: ReadPrec StartMatchBackfill
readList :: ReadS [StartMatchBackfill]
$creadList :: ReadS [StartMatchBackfill]
readsPrec :: Int -> ReadS StartMatchBackfill
$creadsPrec :: Int -> ReadS StartMatchBackfill
Prelude.Read, Int -> StartMatchBackfill -> ShowS
[StartMatchBackfill] -> ShowS
StartMatchBackfill -> String
(Int -> StartMatchBackfill -> ShowS)
-> (StartMatchBackfill -> String)
-> ([StartMatchBackfill] -> ShowS)
-> Show StartMatchBackfill
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartMatchBackfill] -> ShowS
$cshowList :: [StartMatchBackfill] -> ShowS
show :: StartMatchBackfill -> String
$cshow :: StartMatchBackfill -> String
showsPrec :: Int -> StartMatchBackfill -> ShowS
$cshowsPrec :: Int -> StartMatchBackfill -> ShowS
Prelude.Show, (forall x. StartMatchBackfill -> Rep StartMatchBackfill x)
-> (forall x. Rep StartMatchBackfill x -> StartMatchBackfill)
-> Generic StartMatchBackfill
forall x. Rep StartMatchBackfill x -> StartMatchBackfill
forall x. StartMatchBackfill -> Rep StartMatchBackfill x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StartMatchBackfill x -> StartMatchBackfill
$cfrom :: forall x. StartMatchBackfill -> Rep StartMatchBackfill x
Prelude.Generic)

-- |
-- Create a value of 'StartMatchBackfill' 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:
--
-- 'ticketId', 'startMatchBackfill_ticketId' - A unique identifier for a matchmaking ticket. If no ticket ID is
-- specified here, Amazon GameLift will generate one in the form of a UUID.
-- Use this identifier to track the match backfill ticket status and
-- retrieve match results.
--
-- 'gameSessionArn', 'startMatchBackfill_gameSessionArn' - A unique identifier for the game session. Use the game session ID. When
-- using FlexMatch as a standalone matchmaking solution, this parameter is
-- not needed.
--
-- 'configurationName', 'startMatchBackfill_configurationName' - Name of the matchmaker to use for this request. You can use either the
-- configuration name or ARN value. The ARN of the matchmaker that was used
-- with the original game session is listed in the GameSession object,
-- @MatchmakerData@ property.
--
-- 'players', 'startMatchBackfill_players' - Match information on all players that are currently assigned to the game
-- session. This information is used by the matchmaker to find new players
-- and add them to the existing game.
--
-- -   PlayerID, PlayerAttributes, Team -- This information is maintained
--     in the GameSession object, @MatchmakerData@ property, for all
--     players who are currently assigned to the game session. The
--     matchmaker data is in JSON syntax, formatted as a string. For more
--     details, see
--     <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data Match Data>.
--
-- -   LatencyInMs -- If the matchmaker uses player latency, include a
--     latency value, in milliseconds, for the Region that the game session
--     is currently in. Do not include latency values for any other Region.
newStartMatchBackfill ::
  -- | 'configurationName'
  Prelude.Text ->
  StartMatchBackfill
newStartMatchBackfill :: Text -> StartMatchBackfill
newStartMatchBackfill Text
pConfigurationName_ =
  StartMatchBackfill' :: Maybe Text -> Maybe Text -> Text -> [Player] -> StartMatchBackfill
StartMatchBackfill'
    { $sel:ticketId:StartMatchBackfill' :: Maybe Text
ticketId = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:gameSessionArn:StartMatchBackfill' :: Maybe Text
gameSessionArn = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:configurationName:StartMatchBackfill' :: Text
configurationName = Text
pConfigurationName_,
      $sel:players:StartMatchBackfill' :: [Player]
players = [Player]
forall a. Monoid a => a
Prelude.mempty
    }

-- | A unique identifier for a matchmaking ticket. If no ticket ID is
-- specified here, Amazon GameLift will generate one in the form of a UUID.
-- Use this identifier to track the match backfill ticket status and
-- retrieve match results.
startMatchBackfill_ticketId :: Lens.Lens' StartMatchBackfill (Prelude.Maybe Prelude.Text)
startMatchBackfill_ticketId :: (Maybe Text -> f (Maybe Text))
-> StartMatchBackfill -> f StartMatchBackfill
startMatchBackfill_ticketId = (StartMatchBackfill -> Maybe Text)
-> (StartMatchBackfill -> Maybe Text -> StartMatchBackfill)
-> Lens
     StartMatchBackfill StartMatchBackfill (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartMatchBackfill' {Maybe Text
ticketId :: Maybe Text
$sel:ticketId:StartMatchBackfill' :: StartMatchBackfill -> Maybe Text
ticketId} -> Maybe Text
ticketId) (\s :: StartMatchBackfill
s@StartMatchBackfill' {} Maybe Text
a -> StartMatchBackfill
s {$sel:ticketId:StartMatchBackfill' :: Maybe Text
ticketId = Maybe Text
a} :: StartMatchBackfill)

-- | A unique identifier for the game session. Use the game session ID. When
-- using FlexMatch as a standalone matchmaking solution, this parameter is
-- not needed.
startMatchBackfill_gameSessionArn :: Lens.Lens' StartMatchBackfill (Prelude.Maybe Prelude.Text)
startMatchBackfill_gameSessionArn :: (Maybe Text -> f (Maybe Text))
-> StartMatchBackfill -> f StartMatchBackfill
startMatchBackfill_gameSessionArn = (StartMatchBackfill -> Maybe Text)
-> (StartMatchBackfill -> Maybe Text -> StartMatchBackfill)
-> Lens
     StartMatchBackfill StartMatchBackfill (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartMatchBackfill' {Maybe Text
gameSessionArn :: Maybe Text
$sel:gameSessionArn:StartMatchBackfill' :: StartMatchBackfill -> Maybe Text
gameSessionArn} -> Maybe Text
gameSessionArn) (\s :: StartMatchBackfill
s@StartMatchBackfill' {} Maybe Text
a -> StartMatchBackfill
s {$sel:gameSessionArn:StartMatchBackfill' :: Maybe Text
gameSessionArn = Maybe Text
a} :: StartMatchBackfill)

-- | Name of the matchmaker to use for this request. You can use either the
-- configuration name or ARN value. The ARN of the matchmaker that was used
-- with the original game session is listed in the GameSession object,
-- @MatchmakerData@ property.
startMatchBackfill_configurationName :: Lens.Lens' StartMatchBackfill Prelude.Text
startMatchBackfill_configurationName :: (Text -> f Text) -> StartMatchBackfill -> f StartMatchBackfill
startMatchBackfill_configurationName = (StartMatchBackfill -> Text)
-> (StartMatchBackfill -> Text -> StartMatchBackfill)
-> Lens StartMatchBackfill StartMatchBackfill Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartMatchBackfill' {Text
configurationName :: Text
$sel:configurationName:StartMatchBackfill' :: StartMatchBackfill -> Text
configurationName} -> Text
configurationName) (\s :: StartMatchBackfill
s@StartMatchBackfill' {} Text
a -> StartMatchBackfill
s {$sel:configurationName:StartMatchBackfill' :: Text
configurationName = Text
a} :: StartMatchBackfill)

-- | Match information on all players that are currently assigned to the game
-- session. This information is used by the matchmaker to find new players
-- and add them to the existing game.
--
-- -   PlayerID, PlayerAttributes, Team -- This information is maintained
--     in the GameSession object, @MatchmakerData@ property, for all
--     players who are currently assigned to the game session. The
--     matchmaker data is in JSON syntax, formatted as a string. For more
--     details, see
--     <https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data Match Data>.
--
-- -   LatencyInMs -- If the matchmaker uses player latency, include a
--     latency value, in milliseconds, for the Region that the game session
--     is currently in. Do not include latency values for any other Region.
startMatchBackfill_players :: Lens.Lens' StartMatchBackfill [Player]
startMatchBackfill_players :: ([Player] -> f [Player])
-> StartMatchBackfill -> f StartMatchBackfill
startMatchBackfill_players = (StartMatchBackfill -> [Player])
-> (StartMatchBackfill -> [Player] -> StartMatchBackfill)
-> Lens StartMatchBackfill StartMatchBackfill [Player] [Player]
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartMatchBackfill' {[Player]
players :: [Player]
$sel:players:StartMatchBackfill' :: StartMatchBackfill -> [Player]
players} -> [Player]
players) (\s :: StartMatchBackfill
s@StartMatchBackfill' {} [Player]
a -> StartMatchBackfill
s {$sel:players:StartMatchBackfill' :: [Player]
players = [Player]
a} :: StartMatchBackfill) (([Player] -> f [Player])
 -> StartMatchBackfill -> f StartMatchBackfill)
-> (([Player] -> f [Player]) -> [Player] -> f [Player])
-> ([Player] -> f [Player])
-> StartMatchBackfill
-> f StartMatchBackfill
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. ([Player] -> f [Player]) -> [Player] -> f [Player]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest StartMatchBackfill where
  type
    AWSResponse StartMatchBackfill =
      StartMatchBackfillResponse
  request :: StartMatchBackfill -> Request StartMatchBackfill
request = Service -> StartMatchBackfill -> Request StartMatchBackfill
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy StartMatchBackfill
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse StartMatchBackfill)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse StartMatchBackfill))
-> Logger
-> Service
-> Proxy StartMatchBackfill
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse StartMatchBackfill)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe MatchmakingTicket -> Int -> StartMatchBackfillResponse
StartMatchBackfillResponse'
            (Maybe MatchmakingTicket -> Int -> StartMatchBackfillResponse)
-> Either String (Maybe MatchmakingTicket)
-> Either String (Int -> StartMatchBackfillResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe MatchmakingTicket)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"MatchmakingTicket")
            Either String (Int -> StartMatchBackfillResponse)
-> Either String Int -> Either String StartMatchBackfillResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable StartMatchBackfill

instance Prelude.NFData StartMatchBackfill

instance Core.ToHeaders StartMatchBackfill where
  toHeaders :: StartMatchBackfill -> ResponseHeaders
toHeaders =
    ResponseHeaders -> StartMatchBackfill -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const
      ( [ResponseHeaders] -> ResponseHeaders
forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"GameLift.StartMatchBackfill" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Core.ToJSON StartMatchBackfill where
  toJSON :: StartMatchBackfill -> Value
toJSON StartMatchBackfill' {[Player]
Maybe Text
Text
players :: [Player]
configurationName :: Text
gameSessionArn :: Maybe Text
ticketId :: Maybe Text
$sel:players:StartMatchBackfill' :: StartMatchBackfill -> [Player]
$sel:configurationName:StartMatchBackfill' :: StartMatchBackfill -> Text
$sel:gameSessionArn:StartMatchBackfill' :: StartMatchBackfill -> Maybe Text
$sel:ticketId:StartMatchBackfill' :: StartMatchBackfill -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"TicketId" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
ticketId,
            (Text
"GameSessionArn" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
gameSessionArn,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"ConfigurationName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
configurationName),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Players" Text -> [Player] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= [Player]
players)
          ]
      )

instance Core.ToPath StartMatchBackfill where
  toPath :: StartMatchBackfill -> ByteString
toPath = ByteString -> StartMatchBackfill -> ByteString
forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Core.ToQuery StartMatchBackfill where
  toQuery :: StartMatchBackfill -> QueryString
toQuery = QueryString -> StartMatchBackfill -> QueryString
forall a b. a -> b -> a
Prelude.const QueryString
forall a. Monoid a => a
Prelude.mempty

-- | Represents the returned data in response to a request operation.
--
-- /See:/ 'newStartMatchBackfillResponse' smart constructor.
data StartMatchBackfillResponse = StartMatchBackfillResponse'
  { -- | Ticket representing the backfill matchmaking request. This object
    -- includes the information in the request, ticket status, and match
    -- results as generated during the matchmaking process.
    StartMatchBackfillResponse -> Maybe MatchmakingTicket
matchmakingTicket :: Prelude.Maybe MatchmakingTicket,
    -- | The response's http status code.
    StartMatchBackfillResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (StartMatchBackfillResponse -> StartMatchBackfillResponse -> Bool
(StartMatchBackfillResponse -> StartMatchBackfillResponse -> Bool)
-> (StartMatchBackfillResponse
    -> StartMatchBackfillResponse -> Bool)
-> Eq StartMatchBackfillResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartMatchBackfillResponse -> StartMatchBackfillResponse -> Bool
$c/= :: StartMatchBackfillResponse -> StartMatchBackfillResponse -> Bool
== :: StartMatchBackfillResponse -> StartMatchBackfillResponse -> Bool
$c== :: StartMatchBackfillResponse -> StartMatchBackfillResponse -> Bool
Prelude.Eq, ReadPrec [StartMatchBackfillResponse]
ReadPrec StartMatchBackfillResponse
Int -> ReadS StartMatchBackfillResponse
ReadS [StartMatchBackfillResponse]
(Int -> ReadS StartMatchBackfillResponse)
-> ReadS [StartMatchBackfillResponse]
-> ReadPrec StartMatchBackfillResponse
-> ReadPrec [StartMatchBackfillResponse]
-> Read StartMatchBackfillResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartMatchBackfillResponse]
$creadListPrec :: ReadPrec [StartMatchBackfillResponse]
readPrec :: ReadPrec StartMatchBackfillResponse
$creadPrec :: ReadPrec StartMatchBackfillResponse
readList :: ReadS [StartMatchBackfillResponse]
$creadList :: ReadS [StartMatchBackfillResponse]
readsPrec :: Int -> ReadS StartMatchBackfillResponse
$creadsPrec :: Int -> ReadS StartMatchBackfillResponse
Prelude.Read, Int -> StartMatchBackfillResponse -> ShowS
[StartMatchBackfillResponse] -> ShowS
StartMatchBackfillResponse -> String
(Int -> StartMatchBackfillResponse -> ShowS)
-> (StartMatchBackfillResponse -> String)
-> ([StartMatchBackfillResponse] -> ShowS)
-> Show StartMatchBackfillResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartMatchBackfillResponse] -> ShowS
$cshowList :: [StartMatchBackfillResponse] -> ShowS
show :: StartMatchBackfillResponse -> String
$cshow :: StartMatchBackfillResponse -> String
showsPrec :: Int -> StartMatchBackfillResponse -> ShowS
$cshowsPrec :: Int -> StartMatchBackfillResponse -> ShowS
Prelude.Show, (forall x.
 StartMatchBackfillResponse -> Rep StartMatchBackfillResponse x)
-> (forall x.
    Rep StartMatchBackfillResponse x -> StartMatchBackfillResponse)
-> Generic StartMatchBackfillResponse
forall x.
Rep StartMatchBackfillResponse x -> StartMatchBackfillResponse
forall x.
StartMatchBackfillResponse -> Rep StartMatchBackfillResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep StartMatchBackfillResponse x -> StartMatchBackfillResponse
$cfrom :: forall x.
StartMatchBackfillResponse -> Rep StartMatchBackfillResponse x
Prelude.Generic)

-- |
-- Create a value of 'StartMatchBackfillResponse' 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:
--
-- 'matchmakingTicket', 'startMatchBackfillResponse_matchmakingTicket' - Ticket representing the backfill matchmaking request. This object
-- includes the information in the request, ticket status, and match
-- results as generated during the matchmaking process.
--
-- 'httpStatus', 'startMatchBackfillResponse_httpStatus' - The response's http status code.
newStartMatchBackfillResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  StartMatchBackfillResponse
newStartMatchBackfillResponse :: Int -> StartMatchBackfillResponse
newStartMatchBackfillResponse Int
pHttpStatus_ =
  StartMatchBackfillResponse' :: Maybe MatchmakingTicket -> Int -> StartMatchBackfillResponse
StartMatchBackfillResponse'
    { $sel:matchmakingTicket:StartMatchBackfillResponse' :: Maybe MatchmakingTicket
matchmakingTicket =
        Maybe MatchmakingTicket
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:StartMatchBackfillResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Ticket representing the backfill matchmaking request. This object
-- includes the information in the request, ticket status, and match
-- results as generated during the matchmaking process.
startMatchBackfillResponse_matchmakingTicket :: Lens.Lens' StartMatchBackfillResponse (Prelude.Maybe MatchmakingTicket)
startMatchBackfillResponse_matchmakingTicket :: (Maybe MatchmakingTicket -> f (Maybe MatchmakingTicket))
-> StartMatchBackfillResponse -> f StartMatchBackfillResponse
startMatchBackfillResponse_matchmakingTicket = (StartMatchBackfillResponse -> Maybe MatchmakingTicket)
-> (StartMatchBackfillResponse
    -> Maybe MatchmakingTicket -> StartMatchBackfillResponse)
-> Lens
     StartMatchBackfillResponse
     StartMatchBackfillResponse
     (Maybe MatchmakingTicket)
     (Maybe MatchmakingTicket)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartMatchBackfillResponse' {Maybe MatchmakingTicket
matchmakingTicket :: Maybe MatchmakingTicket
$sel:matchmakingTicket:StartMatchBackfillResponse' :: StartMatchBackfillResponse -> Maybe MatchmakingTicket
matchmakingTicket} -> Maybe MatchmakingTicket
matchmakingTicket) (\s :: StartMatchBackfillResponse
s@StartMatchBackfillResponse' {} Maybe MatchmakingTicket
a -> StartMatchBackfillResponse
s {$sel:matchmakingTicket:StartMatchBackfillResponse' :: Maybe MatchmakingTicket
matchmakingTicket = Maybe MatchmakingTicket
a} :: StartMatchBackfillResponse)

-- | The response's http status code.
startMatchBackfillResponse_httpStatus :: Lens.Lens' StartMatchBackfillResponse Prelude.Int
startMatchBackfillResponse_httpStatus :: (Int -> f Int)
-> StartMatchBackfillResponse -> f StartMatchBackfillResponse
startMatchBackfillResponse_httpStatus = (StartMatchBackfillResponse -> Int)
-> (StartMatchBackfillResponse
    -> Int -> StartMatchBackfillResponse)
-> Lens
     StartMatchBackfillResponse StartMatchBackfillResponse Int Int
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartMatchBackfillResponse' {Int
httpStatus :: Int
$sel:httpStatus:StartMatchBackfillResponse' :: StartMatchBackfillResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: StartMatchBackfillResponse
s@StartMatchBackfillResponse' {} Int
a -> StartMatchBackfillResponse
s {$sel:httpStatus:StartMatchBackfillResponse' :: Int
httpStatus = Int
a} :: StartMatchBackfillResponse)

instance Prelude.NFData StartMatchBackfillResponse