nakadi-client-0.7.0.0: Client library for the Nakadi Event Broker

Copyright(c) Moritz Clasmeier 2017
LicenseBSD3
Maintainermtesseract@silverratio.net
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Network.Nakadi.Types.Problem

Description

This module provides the Nakadi Problem Type.

Synopsis

Documentation

data Problem Source #

Type for RFC7807 Problem objects.

Constructors

Problem 

Fields

  • problemType :: Maybe URI

    (string) - A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".

  • problemTitle :: Text

    (string) - A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).

  • problemStatus :: Maybe Status

    "status" (number) - The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

  • problemDetail :: Maybe Text

    (string) - A human-readable explanation specific to this occurrence of the problem.

  • problemInstance :: Maybe URI

    (string) - A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  • problemCustom :: HashMap Text Value
     
Instances
Eq Problem Source # 
Instance details

Defined in Network.Nakadi.Internal.Types.Problem

Methods

(==) :: Problem -> Problem -> Bool #

(/=) :: Problem -> Problem -> Bool #

Show Problem Source # 
Instance details

Defined in Network.Nakadi.Internal.Types.Problem

Generic Problem Source # 
Instance details

Defined in Network.Nakadi.Internal.Types.Problem

Associated Types

type Rep Problem :: Type -> Type #

Methods

from :: Problem -> Rep Problem x #

to :: Rep Problem x -> Problem #

ToJSON Problem Source # 
Instance details

Defined in Network.Nakadi.Internal.Types.Problem

FromJSON Problem Source # 
Instance details

Defined in Network.Nakadi.Internal.Types.Problem

type Rep Problem Source # 
Instance details

Defined in Network.Nakadi.Internal.Types.Problem