{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE DerivingStrategies #-}

module Hercules.API.State.StateLockAcquireRequest where

import Data.OpenApi qualified as O3
import Hercules.API.Prelude

data StateLockAcquireRequest = StateLockAcquireRequest
  { -- | A description of the activity that the lock is for. This may appear in
    -- logs when other clients are blocked.
    StateLockAcquireRequest -> Text
description :: Text,
    -- | @True@ to request an exclusive lock. Non-exclusive locks are only mutually exclusive with exclusive locks.
    StateLockAcquireRequest -> Bool
exclusive :: Bool,
    -- | For recursive locking. Set this to the value of environment variable
    -- HERCULES_CI_LOCK_LEASE_ID when present.
    StateLockAcquireRequest -> Maybe (Id "StateLockLease")
parent :: Maybe (Id "StateLockLease"),
    -- | Generate a random key to make sure that a retry can be successful.
    StateLockAcquireRequest -> Maybe (Id "IdempotencyKey")
idempotencyKey :: Maybe (Id "IdempotencyKey")
  }
  deriving ((forall x.
 StateLockAcquireRequest -> Rep StateLockAcquireRequest x)
-> (forall x.
    Rep StateLockAcquireRequest x -> StateLockAcquireRequest)
-> Generic StateLockAcquireRequest
forall x. Rep StateLockAcquireRequest x -> StateLockAcquireRequest
forall x. StateLockAcquireRequest -> Rep StateLockAcquireRequest x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. StateLockAcquireRequest -> Rep StateLockAcquireRequest x
from :: forall x. StateLockAcquireRequest -> Rep StateLockAcquireRequest x
$cto :: forall x. Rep StateLockAcquireRequest x -> StateLockAcquireRequest
to :: forall x. Rep StateLockAcquireRequest x -> StateLockAcquireRequest
Generic, Int -> StateLockAcquireRequest -> ShowS
[StateLockAcquireRequest] -> ShowS
StateLockAcquireRequest -> String
(Int -> StateLockAcquireRequest -> ShowS)
-> (StateLockAcquireRequest -> String)
-> ([StateLockAcquireRequest] -> ShowS)
-> Show StateLockAcquireRequest
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> StateLockAcquireRequest -> ShowS
showsPrec :: Int -> StateLockAcquireRequest -> ShowS
$cshow :: StateLockAcquireRequest -> String
show :: StateLockAcquireRequest -> String
$cshowList :: [StateLockAcquireRequest] -> ShowS
showList :: [StateLockAcquireRequest] -> ShowS
Show, StateLockAcquireRequest -> StateLockAcquireRequest -> Bool
(StateLockAcquireRequest -> StateLockAcquireRequest -> Bool)
-> (StateLockAcquireRequest -> StateLockAcquireRequest -> Bool)
-> Eq StateLockAcquireRequest
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: StateLockAcquireRequest -> StateLockAcquireRequest -> Bool
== :: StateLockAcquireRequest -> StateLockAcquireRequest -> Bool
$c/= :: StateLockAcquireRequest -> StateLockAcquireRequest -> Bool
/= :: StateLockAcquireRequest -> StateLockAcquireRequest -> Bool
Eq)
  deriving anyclass (StateLockAcquireRequest -> ()
(StateLockAcquireRequest -> ()) -> NFData StateLockAcquireRequest
forall a. (a -> ()) -> NFData a
$crnf :: StateLockAcquireRequest -> ()
rnf :: StateLockAcquireRequest -> ()
NFData, [StateLockAcquireRequest] -> Value
[StateLockAcquireRequest] -> Encoding
StateLockAcquireRequest -> Value
StateLockAcquireRequest -> Encoding
(StateLockAcquireRequest -> Value)
-> (StateLockAcquireRequest -> Encoding)
-> ([StateLockAcquireRequest] -> Value)
-> ([StateLockAcquireRequest] -> Encoding)
-> ToJSON StateLockAcquireRequest
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> ToJSON a
$ctoJSON :: StateLockAcquireRequest -> Value
toJSON :: StateLockAcquireRequest -> Value
$ctoEncoding :: StateLockAcquireRequest -> Encoding
toEncoding :: StateLockAcquireRequest -> Encoding
$ctoJSONList :: [StateLockAcquireRequest] -> Value
toJSONList :: [StateLockAcquireRequest] -> Value
$ctoEncodingList :: [StateLockAcquireRequest] -> Encoding
toEncodingList :: [StateLockAcquireRequest] -> Encoding
ToJSON, Value -> Parser [StateLockAcquireRequest]
Value -> Parser StateLockAcquireRequest
(Value -> Parser StateLockAcquireRequest)
-> (Value -> Parser [StateLockAcquireRequest])
-> FromJSON StateLockAcquireRequest
forall a.
(Value -> Parser a) -> (Value -> Parser [a]) -> FromJSON a
$cparseJSON :: Value -> Parser StateLockAcquireRequest
parseJSON :: Value -> Parser StateLockAcquireRequest
$cparseJSONList :: Value -> Parser [StateLockAcquireRequest]
parseJSONList :: Value -> Parser [StateLockAcquireRequest]
FromJSON, Proxy StateLockAcquireRequest
-> Declare (Definitions Schema) NamedSchema
(Proxy StateLockAcquireRequest
 -> Declare (Definitions Schema) NamedSchema)
-> ToSchema StateLockAcquireRequest
forall a.
(Proxy a -> Declare (Definitions Schema) NamedSchema) -> ToSchema a
$cdeclareNamedSchema :: Proxy StateLockAcquireRequest
-> Declare (Definitions Schema) NamedSchema
declareNamedSchema :: Proxy StateLockAcquireRequest
-> Declare (Definitions Schema) NamedSchema
ToSchema, Typeable StateLockAcquireRequest
Typeable StateLockAcquireRequest
-> (Proxy StateLockAcquireRequest
    -> Declare (Definitions Schema) NamedSchema)
-> ToSchema StateLockAcquireRequest
Proxy StateLockAcquireRequest
-> Declare (Definitions Schema) NamedSchema
forall a.
Typeable a
-> (Proxy a -> Declare (Definitions Schema) NamedSchema)
-> ToSchema a
$cdeclareNamedSchema :: Proxy StateLockAcquireRequest
-> Declare (Definitions Schema) NamedSchema
declareNamedSchema :: Proxy StateLockAcquireRequest
-> Declare (Definitions Schema) NamedSchema
O3.ToSchema)