Amazonka.M2.Types.PrimaryKey

Documentation

data PrimaryKey

The primary key for a KSDS data set.

See: newPrimaryKey smart constructor.

Constructors

PrimaryKey'

Fields

• name :: Maybe Text

  A name for the Primary Key.

• length :: Int

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

• offset :: Int

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

Instances

FromJSON PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Methods

parseJSON :: Value -> Parser PrimaryKey

parseJSONList :: Value -> Parser [PrimaryKey]

ToJSON PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Methods

toJSON :: PrimaryKey -> Value

toEncoding :: PrimaryKey -> Encoding

toJSONList :: [PrimaryKey] -> Value

toEncodingList :: [PrimaryKey] -> Encoding

Generic PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Associated Types

type Rep PrimaryKey :: Type -> Type

Methods

from :: PrimaryKey -> Rep PrimaryKey x

to :: Rep PrimaryKey x -> PrimaryKey

Read PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Methods

readsPrec :: Int -> ReadS PrimaryKey

readList :: ReadS [PrimaryKey]

readPrec :: ReadPrec PrimaryKey

readListPrec :: ReadPrec [PrimaryKey]

Show PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Methods

showsPrec :: Int -> PrimaryKey -> ShowS

show :: PrimaryKey -> String

showList :: [PrimaryKey] -> ShowS

NFData PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Methods

rnf :: PrimaryKey -> ()

Eq PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Methods

(==) :: PrimaryKey -> PrimaryKey -> Bool

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

Hashable PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

Methods

hashWithSalt :: Int -> PrimaryKey -> Int

hash :: PrimaryKey -> Int

type Rep PrimaryKey

Defined in Amazonka.M2.Types.PrimaryKey

type Rep PrimaryKey = D1 ('MetaData "PrimaryKey" "Amazonka.M2.Types.PrimaryKey" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "PrimaryKey'" 'PrefixI 'True) (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))))

newPrimaryKey

Arguments

:: Int

$sel:length:PrimaryKey'

-> Int

$sel:offset:PrimaryKey'

-> PrimaryKey

Create a value of PrimaryKey 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:name:PrimaryKey', primaryKey_name - A name for the Primary Key.

$sel:length:PrimaryKey', primaryKey_length - A strictly positive integer value representing the length of the primary key.

$sel:offset:PrimaryKey', primaryKey_offset - A positive integer value representing the offset to mark the start of the primary key in the record byte array.

primaryKey_name :: Lens' PrimaryKey (Maybe Text)

A name for the Primary Key.

primaryKey_length :: Lens' PrimaryKey Int

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

primaryKey_offset :: Lens' PrimaryKey Int

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