libZSservicesZSamazonka-appflowZSamazonka-appflow
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppFlow.Types.ConnectorEntity

Description

 
Synopsis

Documentation

data ConnectorEntity Source #

The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.

See: newConnectorEntity smart constructor.

Constructors

ConnectorEntity' 

Fields

  • hasNestedEntities :: Maybe Bool

    Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.

  • label :: Maybe Text

    The label applied to the connector entity.

  • name :: Text

    The name of the connector entity.

Instances

Instances details
Eq ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

Read ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

Show ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

Generic ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

Associated Types

type Rep ConnectorEntity :: Type -> Type #

NFData ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

Methods

rnf :: ConnectorEntity -> () #

Hashable ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

FromJSON ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

type Rep ConnectorEntity Source # 
Instance details

Defined in Amazonka.AppFlow.Types.ConnectorEntity

type Rep ConnectorEntity = D1 ('MetaData "ConnectorEntity" "Amazonka.AppFlow.Types.ConnectorEntity" "libZSservicesZSamazonka-appflowZSamazonka-appflow" 'False) (C1 ('MetaCons "ConnectorEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hasNestedEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newConnectorEntity Source #

Create a value of ConnectorEntity 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:hasNestedEntities:ConnectorEntity', connectorEntity_hasNestedEntities - Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.

$sel:label:ConnectorEntity', connectorEntity_label - The label applied to the connector entity.

$sel:name:ConnectorEntity', connectorEntity_name - The name of the connector entity.

connectorEntity_hasNestedEntities :: Lens' ConnectorEntity (Maybe Bool) Source #

Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.

connectorEntity_label :: Lens' ConnectorEntity (Maybe Text) Source #

The label applied to the connector entity.

connectorEntity_name :: Lens' ConnectorEntity Text Source #

The name of the connector entity.