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.CloudDirectory.Types.BatchCreateIndex

Description

Documentation

data BatchCreateIndex Source #

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

See: newBatchCreateIndex smart constructor.

Constructors

BatchCreateIndex'

Fields

batchReferenceName :: Maybe Text
The batch reference name. See Transaction Support for more information.
linkName :: Maybe Text
The name of the link between the parent object and the index object.
parentReference :: Maybe ObjectReference
A reference to the parent object that contains the index object.
orderedIndexedAttributeList :: [AttributeKey]
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
isUnique :: Bool
Indicates whether the attribute that is being indexed has unique values or not.

Instances

Instances details

ToJSON BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex Methods toJSON :: BatchCreateIndex -> Value # toEncoding :: BatchCreateIndex -> Encoding # toJSONList :: [BatchCreateIndex] -> Value # toEncodingList :: [BatchCreateIndex] -> Encoding #
Generic BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex Associated Types type Rep BatchCreateIndex :: Type -> Type # Methods from :: BatchCreateIndex -> Rep BatchCreateIndex x # to :: Rep BatchCreateIndex x -> BatchCreateIndex #
Read BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex Methods readsPrec :: Int -> ReadS BatchCreateIndex # readList :: ReadS [BatchCreateIndex] # readPrec :: ReadPrec BatchCreateIndex # readListPrec :: ReadPrec [BatchCreateIndex] #
Show BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex Methods showsPrec :: Int -> BatchCreateIndex -> ShowS # show :: BatchCreateIndex -> String # showList :: [BatchCreateIndex] -> ShowS #
NFData BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex Methods rnf :: BatchCreateIndex -> () #
Eq BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex Methods (==) :: BatchCreateIndex -> BatchCreateIndex -> Bool # (/=) :: BatchCreateIndex -> BatchCreateIndex -> Bool #
Hashable BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex Methods hashWithSalt :: Int -> BatchCreateIndex -> Int # hash :: BatchCreateIndex -> Int #
type Rep BatchCreateIndex Source #
Instance details Defined in Amazonka.CloudDirectory.Types.BatchCreateIndex type Rep BatchCreateIndex = D1 ('MetaData "BatchCreateIndex" "Amazonka.CloudDirectory.Types.BatchCreateIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "BatchCreateIndex'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchReferenceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "linkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "parentReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectReference)) :: (S1 ('MetaSel ('Just "orderedIndexedAttributeList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AttributeKey]) :: S1 ('MetaSel ('Just "isUnique") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newBatchCreateIndex Source #

Arguments

:: Bool	`$sel:isUnique:BatchCreateIndex'`
-> BatchCreateIndex

Create a value of BatchCreateIndex 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:batchReferenceName:BatchCreateIndex', batchCreateIndex_batchReferenceName - The batch reference name. See Transaction Support for more information.

$sel:linkName:BatchCreateIndex', batchCreateIndex_linkName - The name of the link between the parent object and the index object.

$sel:parentReference:BatchCreateIndex', batchCreateIndex_parentReference - A reference to the parent object that contains the index object.

$sel:orderedIndexedAttributeList:BatchCreateIndex', batchCreateIndex_orderedIndexedAttributeList - Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

$sel:isUnique:BatchCreateIndex', batchCreateIndex_isUnique - Indicates whether the attribute that is being indexed has unique values or not.

batchCreateIndex_batchReferenceName :: Lens' BatchCreateIndex (Maybe Text) Source #

The batch reference name. See Transaction Support for more information.

batchCreateIndex_linkName :: Lens' BatchCreateIndex (Maybe Text) Source #

The name of the link between the parent object and the index object.

batchCreateIndex_parentReference :: Lens' BatchCreateIndex (Maybe ObjectReference) Source #

A reference to the parent object that contains the index object.

batchCreateIndex_orderedIndexedAttributeList :: Lens' BatchCreateIndex [AttributeKey] Source #

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

batchCreateIndex_isUnique :: Lens' BatchCreateIndex Bool Source #

Indicates whether the attribute that is being indexed has unique values or not.