libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory
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.CloudDirectory.Types.TypedLinkFacet

Description

 
Synopsis

Documentation

data TypedLinkFacet Source #

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

See: newTypedLinkFacet smart constructor.

Constructors

TypedLinkFacet' 

Fields

  • name :: Text

    The unique name of the typed link facet.

  • attributes :: [TypedLinkAttributeDefinition]

    A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

  • identityAttributeOrder :: [Text]

    The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

Instances

Instances details
Eq TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

Read TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

Show TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

Generic TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

Associated Types

type Rep TypedLinkFacet :: Type -> Type #

NFData TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

Methods

rnf :: TypedLinkFacet -> () #

Hashable TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

ToJSON TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

type Rep TypedLinkFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.Types.TypedLinkFacet

type Rep TypedLinkFacet = D1 ('MetaData "TypedLinkFacet" "Amazonka.CloudDirectory.Types.TypedLinkFacet" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "TypedLinkFacet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TypedLinkAttributeDefinition]) :*: S1 ('MetaSel ('Just "identityAttributeOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newTypedLinkFacet Source #

Create a value of TypedLinkFacet 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:TypedLinkFacet', typedLinkFacet_name - The unique name of the typed link facet.

$sel:attributes:TypedLinkFacet', typedLinkFacet_attributes - A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

$sel:identityAttributeOrder:TypedLinkFacet', typedLinkFacet_identityAttributeOrder - The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

typedLinkFacet_name :: Lens' TypedLinkFacet Text Source #

The unique name of the typed link facet.

typedLinkFacet_attributes :: Lens' TypedLinkFacet [TypedLinkAttributeDefinition] Source #

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

typedLinkFacet_identityAttributeOrder :: Lens' TypedLinkFacet [Text] Source #

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.