Amazonka.KeySpaces.Types.ClusteringKey

Documentation

data ClusteringKey

The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

See: newClusteringKey smart constructor.

Constructors

ClusteringKey'

Fields

• name :: Text

  The name(s) of the clustering column(s).

• orderBy :: SortOrder

  Sets the ascendant (ASC) or descendant (DESC) order modifier.

Instances

FromJSON ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Methods

parseJSON :: Value -> Parser ClusteringKey

parseJSONList :: Value -> Parser [ClusteringKey]

ToJSON ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Methods

toJSON :: ClusteringKey -> Value

toEncoding :: ClusteringKey -> Encoding

toJSONList :: [ClusteringKey] -> Value

toEncodingList :: [ClusteringKey] -> Encoding

Generic ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Associated Types

type Rep ClusteringKey :: Type -> Type

Methods

from :: ClusteringKey -> Rep ClusteringKey x

to :: Rep ClusteringKey x -> ClusteringKey

Read ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Methods

readsPrec :: Int -> ReadS ClusteringKey

readList :: ReadS [ClusteringKey]

readPrec :: ReadPrec ClusteringKey

readListPrec :: ReadPrec [ClusteringKey]

Show ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Methods

showsPrec :: Int -> ClusteringKey -> ShowS

show :: ClusteringKey -> String

showList :: [ClusteringKey] -> ShowS

NFData ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Methods

rnf :: ClusteringKey -> ()

Eq ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Methods

(==) :: ClusteringKey -> ClusteringKey -> Bool

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

Hashable ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

Methods

hashWithSalt :: Int -> ClusteringKey -> Int

hash :: ClusteringKey -> Int

type Rep ClusteringKey

Defined in Amazonka.KeySpaces.Types.ClusteringKey

type Rep ClusteringKey = D1 ('MetaData "ClusteringKey" "Amazonka.KeySpaces.Types.ClusteringKey" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "ClusteringKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "orderBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SortOrder)))

newClusteringKey

Arguments

:: Text

$sel:name:ClusteringKey'

-> SortOrder

$sel:orderBy:ClusteringKey'

-> ClusteringKey

Create a value of ClusteringKey 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:ClusteringKey', clusteringKey_name - The name(s) of the clustering column(s).

$sel:orderBy:ClusteringKey', clusteringKey_orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

clusteringKey_name :: Lens' ClusteringKey Text

The name(s) of the clustering column(s).

clusteringKey_orderBy :: Lens' ClusteringKey SortOrder

Sets the ascendant (ASC) or descendant (DESC) order modifier.