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