File Coverage

blib/lib/Paws/CloudDirectory/TypedLinkSpecifier.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::TypedLinkSpecifier;
2 1     1   312 use Moose;
  1         2  
  1         6  
3             has IdentityAttributeValues => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::AttributeNameAndValue]', required => 1);
4             has SourceObjectReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference', required => 1);
5             has TargetObjectReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference', required => 1);
6             has TypedLinkFacet => (is => 'ro', isa => 'Paws::CloudDirectory::TypedLinkSchemaAndFacetName', required => 1);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::CloudDirectory::TypedLinkSpecifier
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::CloudDirectory::TypedLinkSpecifier object:
25              
26             $service_obj->Method(Att1 => { IdentityAttributeValues => $value, ..., TypedLinkFacet => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudDirectory::TypedLinkSpecifier object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->IdentityAttributeValues
34              
35             =head1 DESCRIPTION
36              
37             Contains all the information that is used to uniquely identify a typed
38             link. The parameters discussed in this topic are used to uniquely
39             specify the typed link being operated on. The AttachTypedLink API
40             returns a typed link specifier while the DetachTypedLink API accepts
41             one as input. Similarly, the ListIncomingTypedLinks and
42             ListOutgoingTypedLinks API operations provide typed link specifiers as
43             output. You can also construct a typed link specifier from scratch.
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 B<REQUIRED> IdentityAttributeValues => ArrayRef[L<Paws::CloudDirectory::AttributeNameAndValue>]
49              
50             Identifies the attribute value to update.
51              
52              
53             =head2 B<REQUIRED> SourceObjectReference => L<Paws::CloudDirectory::ObjectReference>
54              
55             Identifies the source object that the typed link will attach to.
56              
57              
58             =head2 B<REQUIRED> TargetObjectReference => L<Paws::CloudDirectory::ObjectReference>
59              
60             Identifies the target object that the typed link will attach to.
61              
62              
63             =head2 B<REQUIRED> TypedLinkFacet => L<Paws::CloudDirectory::TypedLinkSchemaAndFacetName>
64              
65             Identifies the typed link facet that is associated with the typed link.
66              
67              
68              
69             =head1 SEE ALSO
70              
71             This class forms part of L<Paws>, describing an object used in L<Paws::CloudDirectory>
72              
73             =head1 BUGS and CONTRIBUTIONS
74              
75             The source code is located here: https://github.com/pplu/aws-sdk-perl
76              
77             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
78              
79             =cut
80