Amazonka.AppFlow.Types.DestinationFieldProperties

Documentation

data DestinationFieldProperties

The properties that can be applied to a field when connector is being used as a destination.

See: newDestinationFieldProperties smart constructor.

Constructors

DestinationFieldProperties'

Fields

• isCreatable :: Maybe Bool

  Specifies if the destination field can be created by the current user.

• isDefaultedOnCreate :: Maybe Bool

  Specifies whether the field can use the default value during a Create operation.

• isNullable :: Maybe Bool

  Specifies if the destination field can have a null value.

• isUpdatable :: Maybe Bool

  Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

• isUpsertable :: Maybe Bool

  Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

• supportedWriteOperations :: Maybe [WriteOperationType]

  A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.

Instances

FromJSON DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

Methods

parseJSON :: Value -> Parser DestinationFieldProperties

parseJSONList :: Value -> Parser [DestinationFieldProperties]

Generic DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

Associated Types

type Rep DestinationFieldProperties :: Type -> Type

Methods

from :: DestinationFieldProperties -> Rep DestinationFieldProperties x

to :: Rep DestinationFieldProperties x -> DestinationFieldProperties

Read DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

Methods

readsPrec :: Int -> ReadS DestinationFieldProperties

readList :: ReadS [DestinationFieldProperties]

readPrec :: ReadPrec DestinationFieldProperties

readListPrec :: ReadPrec [DestinationFieldProperties]

Show DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

Methods

showsPrec :: Int -> DestinationFieldProperties -> ShowS

show :: DestinationFieldProperties -> String

showList :: [DestinationFieldProperties] -> ShowS

NFData DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

Methods

rnf :: DestinationFieldProperties -> ()

Eq DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

Methods

(==) :: DestinationFieldProperties -> DestinationFieldProperties -> Bool

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

Hashable DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

Methods

hashWithSalt :: Int -> DestinationFieldProperties -> Int

hash :: DestinationFieldProperties -> Int

type Rep DestinationFieldProperties

Defined in Amazonka.AppFlow.Types.DestinationFieldProperties

type Rep DestinationFieldProperties = D1 ('MetaData "DestinationFieldProperties" "Amazonka.AppFlow.Types.DestinationFieldProperties" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "DestinationFieldProperties'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isCreatable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "isDefaultedOnCreate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "isNullable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "isUpdatable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "isUpsertable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "supportedWriteOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WriteOperationType]))))))

newDestinationFieldProperties :: DestinationFieldProperties

Create a value of DestinationFieldProperties 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:isCreatable:DestinationFieldProperties', destinationFieldProperties_isCreatable - Specifies if the destination field can be created by the current user.

$sel:isDefaultedOnCreate:DestinationFieldProperties', destinationFieldProperties_isDefaultedOnCreate - Specifies whether the field can use the default value during a Create operation.

$sel:isNullable:DestinationFieldProperties', destinationFieldProperties_isNullable - Specifies if the destination field can have a null value.

$sel:isUpdatable:DestinationFieldProperties', destinationFieldProperties_isUpdatable - Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

$sel:isUpsertable:DestinationFieldProperties', destinationFieldProperties_isUpsertable - Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

$sel:supportedWriteOperations:DestinationFieldProperties', destinationFieldProperties_supportedWriteOperations - A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.

destinationFieldProperties_isCreatable :: Lens' DestinationFieldProperties (Maybe Bool)

Specifies if the destination field can be created by the current user.

destinationFieldProperties_isDefaultedOnCreate :: Lens' DestinationFieldProperties (Maybe Bool)

Specifies whether the field can use the default value during a Create operation.

destinationFieldProperties_isNullable :: Lens' DestinationFieldProperties (Maybe Bool)

Specifies if the destination field can have a null value.

destinationFieldProperties_isUpdatable :: Lens' DestinationFieldProperties (Maybe Bool)

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

destinationFieldProperties_isUpsertable :: Lens' DestinationFieldProperties (Maybe Bool)

Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

destinationFieldProperties_supportedWriteOperations :: Lens' DestinationFieldProperties (Maybe [WriteOperationType])

A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.