File Coverage

blib/lib/Paws/CloudDirectory/TypedLinkFacet.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::TypedLinkFacet;
2 1     1   364 use Moose;
  1         2  
  1         5  
3             has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::TypedLinkAttributeDefinition]', required => 1);
4             has IdentityAttributeOrder => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
5             has Name => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::CloudDirectory::TypedLinkFacet
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::CloudDirectory::TypedLinkFacet object:
24              
25             $service_obj->Method(Att1 => { Attributes => $value, ..., Name => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudDirectory::TypedLinkFacet object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->Attributes
33              
34             =head1 DESCRIPTION
35              
36             Defines the typed links structure and its attributes. To create a typed
37             link facet, use the CreateTypedLinkFacet API.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> Attributes => ArrayRef[L<Paws::CloudDirectory::TypedLinkAttributeDefinition>]
43              
44             A set of key-value pairs associated with the typed link. Typed link
45             attributes are used when you have data values that are related to the
46             link itself, and not to one of the two objects being linked. Identity
47             attributes also serve to distinguish the link from others of the same
48             type between the same objects.
49              
50              
51             =head2 B<REQUIRED> IdentityAttributeOrder => ArrayRef[Str|Undef]
52              
53             The set of attributes that distinguish links made from this facet from
54             each other, in the order of significance. Listing typed links can
55             filter on the values of these attributes. See ListOutgoingTypedLinks
56             and ListIncomingTypedLinks for details.
57              
58              
59             =head2 B<REQUIRED> Name => Str
60              
61             The unique name of the typed link facet.
62              
63              
64              
65             =head1 SEE ALSO
66              
67             This class forms part of L<Paws>, describing an object used in L<Paws::CloudDirectory>
68              
69             =head1 BUGS and CONTRIBUTIONS
70              
71             The source code is located here: https://github.com/pplu/aws-sdk-perl
72              
73             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
74              
75             =cut
76