Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.M2.Types.AlternateKey

Description

Synopsis

data AlternateKey = AlternateKey' {
- allowDuplicates :: Maybe Bool
- name :: Maybe Text
- length :: Int
- offset :: Int
}
newAlternateKey :: Int -> Int -> AlternateKey
alternateKey_allowDuplicates :: Lens' AlternateKey (Maybe Bool)
alternateKey_name :: Lens' AlternateKey (Maybe Text)
alternateKey_length :: Lens' AlternateKey Int
alternateKey_offset :: Lens' AlternateKey Int

Documentation

data AlternateKey Source #

Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.

See: newAlternateKey smart constructor.

Constructors

AlternateKey'

Fields

allowDuplicates :: Maybe Bool
Indicates whether the alternate key values are supposed to be unique for the given data set.
name :: Maybe Text
The name of the alternate key.
length :: Int
A strictly positive integer value representing the length of the alternate key.
offset :: Int
A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

Instances

Instances details

FromJSON AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Methods parseJSON :: Value -> Parser AlternateKey # parseJSONList :: Value -> Parser [AlternateKey] #
ToJSON AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Methods toJSON :: AlternateKey -> Value # toEncoding :: AlternateKey -> Encoding # toJSONList :: [AlternateKey] -> Value # toEncodingList :: [AlternateKey] -> Encoding #
Generic AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Associated Types type Rep AlternateKey :: Type -> Type # Methods from :: AlternateKey -> Rep AlternateKey x # to :: Rep AlternateKey x -> AlternateKey #
Read AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Methods readsPrec :: Int -> ReadS AlternateKey # readList :: ReadS [AlternateKey] # readPrec :: ReadPrec AlternateKey # readListPrec :: ReadPrec [AlternateKey] #
Show AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Methods showsPrec :: Int -> AlternateKey -> ShowS # show :: AlternateKey -> String # showList :: [AlternateKey] -> ShowS #
NFData AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Methods rnf :: AlternateKey -> () #
Eq AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Methods (==) :: AlternateKey -> AlternateKey -> Bool # (/=) :: AlternateKey -> AlternateKey -> Bool #
Hashable AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey Methods hashWithSalt :: Int -> AlternateKey -> Int # hash :: AlternateKey -> Int #
type Rep AlternateKey Source #
Instance details Defined in Amazonka.M2.Types.AlternateKey type Rep AlternateKey = D1 ('MetaData "AlternateKey" "Amazonka.M2.Types.AlternateKey" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "AlternateKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowDuplicates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "length") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAlternateKey Source #

Arguments

:: Int	`$sel:length:AlternateKey'`
-> Int	`$sel:offset:AlternateKey'`
-> AlternateKey

Create a value of AlternateKey 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:allowDuplicates:AlternateKey', alternateKey_allowDuplicates - Indicates whether the alternate key values are supposed to be unique for the given data set.

$sel:name:AlternateKey', alternateKey_name - The name of the alternate key.

$sel:length:AlternateKey', alternateKey_length - A strictly positive integer value representing the length of the alternate key.

$sel:offset:AlternateKey', alternateKey_offset - A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

alternateKey_allowDuplicates :: Lens' AlternateKey (Maybe Bool) Source #

Indicates whether the alternate key values are supposed to be unique for the given data set.

alternateKey_name :: Lens' AlternateKey (Maybe Text) Source #

The name of the alternate key.

alternateKey_length :: Lens' AlternateKey Int Source #

A strictly positive integer value representing the length of the alternate key.

alternateKey_offset :: Lens' AlternateKey Int Source #

A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.