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)
Safe Haskell	None

Amazonka.XRay.Types.Segment

Description

Synopsis

data Segment = Segment' {
- document :: Maybe Text
- id :: Maybe Text
}
newSegment :: Segment
segment_document :: Lens' Segment (Maybe Text)
segment_id :: Lens' Segment (Maybe Text)

Documentation

data Segment Source #

A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.

For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.

See: newSegment smart constructor.

Constructors

Segment'
Fields document :: Maybe Text The segment document. id :: Maybe Text The segment's ID.

Instances

Instances details

Eq Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment Methods (==) :: Segment -> Segment -> Bool # (/=) :: Segment -> Segment -> Bool #
Read Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment Methods readsPrec :: Int -> ReadS Segment # readList :: ReadS [Segment] # readPrec :: ReadPrec Segment # readListPrec :: ReadPrec [Segment] #
Show Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment Methods showsPrec :: Int -> Segment -> ShowS # show :: Segment -> String # showList :: [Segment] -> ShowS #
Generic Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment Associated Types type Rep Segment :: Type -> Type # Methods from :: Segment -> Rep Segment x # to :: Rep Segment x -> Segment #
NFData Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment Methods rnf :: Segment -> () #
Hashable Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment Methods hashWithSalt :: Int -> Segment -> Int # hash :: Segment -> Int #
FromJSON Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment Methods parseJSON :: Value -> Parser Segment # parseJSONList :: Value -> Parser [Segment] #
type Rep Segment Source #
Instance details Defined in Amazonka.XRay.Types.Segment type Rep Segment = D1 ('MetaData "Segment" "Amazonka.XRay.Types.Segment" "libZSservicesZSamazonka-xrayZSamazonka-xray" 'False) (C1 ('MetaCons "Segment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSegment :: Segment Source #

Create a value of Segment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:document:Segment', segment_document - The segment document.

$sel:id:Segment', segment_id - The segment's ID.

segment_document :: Lens' Segment (Maybe Text) Source #

The segment document.

segment_id :: Lens' Segment (Maybe Text) Source #

The segment's ID.