File Coverage

blib/lib/Paws/CloudDirectory/ObjectReference.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudDirectory::ObjectReference;
2 1     1   643 use Moose;
  1         4  
  1         12  
3             has Selector => (is => 'ro', isa => 'Str');
4             1;
5              
6             ### main pod documentation begin ###
7              
8             =head1 NAME
9              
10             Paws::CloudDirectory::ObjectReference
11              
12             =head1 USAGE
13              
14             This class represents one of two things:
15              
16             =head3 Arguments in a call to a service
17              
18             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
19             Each attribute should be used as a named argument in the calls that expect this type of object.
20              
21             As an example, if Att1 is expected to be a Paws::CloudDirectory::ObjectReference object:
22              
23             $service_obj->Method(Att1 => { Selector => $value, ..., Selector => $value });
24              
25             =head3 Results returned from an API call
26              
27             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudDirectory::ObjectReference object:
28              
29             $result = $service_obj->Method(...);
30             $result->Att1->Selector
31              
32             =head1 DESCRIPTION
33              
34             The reference that identifies an object.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 Selector => Str
40              
41             A path selector supports easy selection of an object by the
42             parent/child links leading to it from the directory root. Use the link
43             names from each parent/child link to construct the path. Path selectors
44             start with a slash (/) and link names are separated by slashes. For
45             more information about paths, see Accessing Objects. You can identify
46             an object in one of the following ways:
47              
48             =over
49              
50             =item *
51              
52             I<$ObjectIdentifier> - An object identifier is an opaque string
53             provided by Amazon Cloud Directory. When creating objects, the system
54             will provide you with the identifier of the created object. An
55             objectE<rsquo>s identifier is immutable and no two objects will ever
56             share the same object identifier
57              
58             =item *
59              
60             I</some/path> - Identifies the object based on path
61              
62             =item *
63              
64             I<#SomeBatchReference> - Identifies the object in a batch call
65              
66             =back
67              
68              
69              
70              
71             =head1 SEE ALSO
72              
73             This class forms part of L<Paws>, describing an object used in L<Paws::CloudDirectory>
74              
75             =head1 BUGS and CONTRIBUTIONS
76              
77             The source code is located here: https://github.com/pplu/aws-sdk-perl
78              
79             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
80              
81             =cut
82