« blib/lib/Paws/IoTSiteWise/AssetPropertyValue.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/AssetStatus.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTSiteWise::AssetRelationshipSummary; | ||
| 3 | use Moose; | ||
| 4 | has HierarchyInfo => (is => 'ro', isa => 'Paws::IoTSiteWise::AssetHierarchyInfo', request_name => 'hierarchyInfo', traits => ['NameInRequest']); | ||
| 5 | has RelationshipType => (is => 'ro', isa => 'Str', request_name => 'relationshipType', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::IoTSiteWise::AssetRelationshipSummary | ||
| 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::IoTSiteWise::AssetRelationshipSummary object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { HierarchyInfo => $value, ..., RelationshipType => $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::IoTSiteWise::AssetRelationshipSummary object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->HierarchyInfo | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Contains information about assets that are related to one another. | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 HierarchyInfo => L<Paws::IoTSiteWise::AssetHierarchyInfo> | ||
| 43 | |||
| 44 | The assets that are related through an asset hierarchy. | ||
| 45 | |||
| 46 | This object is present if the C<relationshipType> is C<HIERARCHY>. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> RelationshipType => Str | ||
| 50 | |||
| 51 | The relationship type of the assets in this relationship. This value is | ||
| 52 | one of the following: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<HIERARCHY> E<ndash> The assets are related through an asset | ||
| 59 | hierarchy. If you specify this relationship type, this asset | ||
| 60 | relationship includes the C<hierarchyInfo> object. | ||
| 61 | |||
| 62 | =back | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTSiteWise> | ||
| 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 |