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.AppFlow.Types.ConnectorEntityField

Description

Synopsis

data ConnectorEntityField = ConnectorEntityField' {
- customProperties :: Maybe (HashMap Text Text)
- defaultValue :: Maybe Text
- description :: Maybe Text
- destinationProperties :: Maybe DestinationFieldProperties
- isDeprecated :: Maybe Bool
- isPrimaryKey :: Maybe Bool
- label :: Maybe Text
- parentIdentifier :: Maybe Text
- sourceProperties :: Maybe SourceFieldProperties
- supportedFieldTypeDetails :: Maybe SupportedFieldTypeDetails
- identifier :: Text
}
newConnectorEntityField :: Text -> ConnectorEntityField
connectorEntityField_customProperties :: Lens' ConnectorEntityField (Maybe (HashMap Text Text))
connectorEntityField_defaultValue :: Lens' ConnectorEntityField (Maybe Text)
connectorEntityField_description :: Lens' ConnectorEntityField (Maybe Text)
connectorEntityField_destinationProperties :: Lens' ConnectorEntityField (Maybe DestinationFieldProperties)
connectorEntityField_isDeprecated :: Lens' ConnectorEntityField (Maybe Bool)
connectorEntityField_isPrimaryKey :: Lens' ConnectorEntityField (Maybe Bool)
connectorEntityField_label :: Lens' ConnectorEntityField (Maybe Text)
connectorEntityField_parentIdentifier :: Lens' ConnectorEntityField (Maybe Text)
connectorEntityField_sourceProperties :: Lens' ConnectorEntityField (Maybe SourceFieldProperties)
connectorEntityField_supportedFieldTypeDetails :: Lens' ConnectorEntityField (Maybe SupportedFieldTypeDetails)
connectorEntityField_identifier :: Lens' ConnectorEntityField Text

Documentation

data ConnectorEntityField Source #

Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.

See: newConnectorEntityField smart constructor.

Constructors

ConnectorEntityField'

Fields

customProperties :: Maybe (HashMap Text Text)
A map that has specific properties related to the ConnectorEntityField.
defaultValue :: Maybe Text
Default value that can be assigned to this field.
description :: Maybe Text
A description of the connector entity field.
destinationProperties :: Maybe DestinationFieldProperties
The properties applied to a field when the connector is being used as a destination.
isDeprecated :: Maybe Bool
Booelan value that indicates whether this field is deprecated or not.
isPrimaryKey :: Maybe Bool
Booelan value that indicates whether this field can be used as a primary key.
label :: Maybe Text
The label applied to a connector entity field.
parentIdentifier :: Maybe Text
The parent identifier of the connector field.
sourceProperties :: Maybe SourceFieldProperties
The properties that can be applied to a field when the connector is being used as a source.
supportedFieldTypeDetails :: Maybe SupportedFieldTypeDetails
Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.
identifier :: Text
The unique identifier of the connector field.

Instances

Instances details

FromJSON ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField Methods parseJSON :: Value -> Parser ConnectorEntityField # parseJSONList :: Value -> Parser [ConnectorEntityField] #
Generic ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField Associated Types type Rep ConnectorEntityField :: Type -> Type # Methods from :: ConnectorEntityField -> Rep ConnectorEntityField x # to :: Rep ConnectorEntityField x -> ConnectorEntityField #
Read ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField Methods readsPrec :: Int -> ReadS ConnectorEntityField # readList :: ReadS [ConnectorEntityField] # readPrec :: ReadPrec ConnectorEntityField # readListPrec :: ReadPrec [ConnectorEntityField] #
Show ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField Methods showsPrec :: Int -> ConnectorEntityField -> ShowS # show :: ConnectorEntityField -> String # showList :: [ConnectorEntityField] -> ShowS #
NFData ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField Methods rnf :: ConnectorEntityField -> () #
Eq ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField Methods (==) :: ConnectorEntityField -> ConnectorEntityField -> Bool # (/=) :: ConnectorEntityField -> ConnectorEntityField -> Bool #
Hashable ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField Methods hashWithSalt :: Int -> ConnectorEntityField -> Int # hash :: ConnectorEntityField -> Int #
type Rep ConnectorEntityField Source #
Instance details Defined in Amazonka.AppFlow.Types.ConnectorEntityField type Rep ConnectorEntityField = D1 ('MetaData "ConnectorEntityField" "Amazonka.AppFlow.Types.ConnectorEntityField" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "ConnectorEntityField'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "destinationProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DestinationFieldProperties)) :: S1 ('MetaSel ('Just "isDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "isPrimaryKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sourceProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceFieldProperties)) :: (S1 ('MetaSel ('Just "supportedFieldTypeDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SupportedFieldTypeDetails)) :: S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newConnectorEntityField Source #

Arguments

:: Text	`$sel:identifier:ConnectorEntityField'`
-> ConnectorEntityField

Create a value of ConnectorEntityField 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:customProperties:ConnectorEntityField', connectorEntityField_customProperties - A map that has specific properties related to the ConnectorEntityField.

$sel:defaultValue:ConnectorEntityField', connectorEntityField_defaultValue - Default value that can be assigned to this field.

$sel:description:ConnectorEntityField', connectorEntityField_description - A description of the connector entity field.

$sel:destinationProperties:ConnectorEntityField', connectorEntityField_destinationProperties - The properties applied to a field when the connector is being used as a destination.

$sel:isDeprecated:ConnectorEntityField', connectorEntityField_isDeprecated - Booelan value that indicates whether this field is deprecated or not.

$sel:isPrimaryKey:ConnectorEntityField', connectorEntityField_isPrimaryKey - Booelan value that indicates whether this field can be used as a primary key.

$sel:label:ConnectorEntityField', connectorEntityField_label - The label applied to a connector entity field.

$sel:parentIdentifier:ConnectorEntityField', connectorEntityField_parentIdentifier - The parent identifier of the connector field.

$sel:sourceProperties:ConnectorEntityField', connectorEntityField_sourceProperties - The properties that can be applied to a field when the connector is being used as a source.

$sel:supportedFieldTypeDetails:ConnectorEntityField', connectorEntityField_supportedFieldTypeDetails - Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.

$sel:identifier:ConnectorEntityField', connectorEntityField_identifier - The unique identifier of the connector field.

connectorEntityField_customProperties :: Lens' ConnectorEntityField (Maybe (HashMap Text Text)) Source #

A map that has specific properties related to the ConnectorEntityField.

connectorEntityField_defaultValue :: Lens' ConnectorEntityField (Maybe Text) Source #

Default value that can be assigned to this field.

connectorEntityField_description :: Lens' ConnectorEntityField (Maybe Text) Source #

A description of the connector entity field.

connectorEntityField_destinationProperties :: Lens' ConnectorEntityField (Maybe DestinationFieldProperties) Source #

The properties applied to a field when the connector is being used as a destination.

connectorEntityField_isDeprecated :: Lens' ConnectorEntityField (Maybe Bool) Source #

Booelan value that indicates whether this field is deprecated or not.

connectorEntityField_isPrimaryKey :: Lens' ConnectorEntityField (Maybe Bool) Source #

Booelan value that indicates whether this field can be used as a primary key.

connectorEntityField_label :: Lens' ConnectorEntityField (Maybe Text) Source #

The label applied to a connector entity field.

connectorEntityField_parentIdentifier :: Lens' ConnectorEntityField (Maybe Text) Source #

The parent identifier of the connector field.

connectorEntityField_sourceProperties :: Lens' ConnectorEntityField (Maybe SourceFieldProperties) Source #

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

connectorEntityField_supportedFieldTypeDetails :: Lens' ConnectorEntityField (Maybe SupportedFieldTypeDetails) Source #

Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.

connectorEntityField_identifier :: Lens' ConnectorEntityField Text Source #

The unique identifier of the connector field.