Hercules.API.State.StateLockAcquireRequest

Documentation

data StateLockAcquireRequest

Constructors

StateLockAcquireRequest

Fields

• description :: Text

  A description of the activity that the lock is for. This may appear in logs when other clients are blocked.

• exclusive :: Bool

  True to request an exclusive lock. Non-exclusive locks are only mutually exclusive with exclusive locks.

• parent :: Maybe (Id "StateLockLease")

  For recursive locking. Set this to the value of environment variable HERCULES_CI_LOCK_LEASE_ID when present.

• idempotencyKey :: Maybe (Id "IdempotencyKey")

  Generate a random key to make sure that a retry can be successful.

Instances

FromJSON StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

Methods

parseJSON :: Value -> Parser StateLockAcquireRequest

parseJSONList :: Value -> Parser [StateLockAcquireRequest]

ToJSON StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

Methods

toJSON :: StateLockAcquireRequest -> Value

toEncoding :: StateLockAcquireRequest -> Encoding

toJSONList :: [StateLockAcquireRequest] -> Value

toEncodingList :: [StateLockAcquireRequest] -> Encoding

Generic StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

Associated Types

type Rep StateLockAcquireRequest :: Type -> Type

Methods

from :: StateLockAcquireRequest -> Rep StateLockAcquireRequest x

to :: Rep StateLockAcquireRequest x -> StateLockAcquireRequest

Show StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

Methods

showsPrec :: Int -> StateLockAcquireRequest -> ShowS

show :: StateLockAcquireRequest -> String

showList :: [StateLockAcquireRequest] -> ShowS

NFData StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

Methods

rnf :: StateLockAcquireRequest -> ()

Eq StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

Methods

(==) :: StateLockAcquireRequest -> StateLockAcquireRequest -> Bool

(/=) :: StateLockAcquireRequest -> StateLockAcquireRequest -> Bool

ToSchema StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

Methods

declareNamedSchema :: Proxy StateLockAcquireRequest -> Declare (Definitions Schema) NamedSchema

type Rep StateLockAcquireRequest

Defined in Hercules.API.State.StateLockAcquireRequest

type Rep StateLockAcquireRequest = D1 ('MetaData "StateLockAcquireRequest" "Hercules.API.State.StateLockAcquireRequest" "hercules-ci-api-0.8.0.0-inplace" 'False) (C1 ('MetaCons "StateLockAcquireRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "exclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "parent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Id "StateLockLease"))) :*: S1 ('MetaSel ('Just "idempotencyKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Id "IdempotencyKey"))))))