Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudDirectory.Types.ObjectReference

Description

Synopsis

data ObjectReference = ObjectReference' {
- selector :: Maybe Text
}
newObjectReference :: ObjectReference
objectReference_selector :: Lens' ObjectReference (Maybe Text)

Documentation

data ObjectReference Source #

The reference that identifies an object.

See: newObjectReference smart constructor.

Constructors

ObjectReference'

Fields

selector :: Maybe Text
A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:
- $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call

Instances

Instances details

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

newObjectReference :: ObjectReference Source #

Create a value of ObjectReference 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:selector:ObjectReference', objectReference_selector - A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

$ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
/some/path - Identifies the object based on path
#SomeBatchReference - Identifies the object in a batch call

objectReference_selector :: Lens' ObjectReference (Maybe Text) Source #

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

$ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
/some/path - Identifies the object based on path
#SomeBatchReference - Identifies the object in a batch call