« blib/lib/Paws/IoTSiteWise/AssetModelSummary.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/AssetPropertyValue.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTSiteWise::AssetProperty; | ||
| 3 | use Moose; | ||
| 4 | has Alias => (is => 'ro', isa => 'Str', request_name => 'alias', traits => ['NameInRequest']); | ||
| 5 | has DataType => (is => 'ro', isa => 'Str', request_name => 'dataType', traits => ['NameInRequest'], required => 1); | ||
| 6 | has DataTypeSpec => (is => 'ro', isa => 'Str', request_name => 'dataTypeSpec', traits => ['NameInRequest']); | ||
| 7 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest'], required => 1); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 9 | has Notification => (is => 'ro', isa => 'Paws::IoTSiteWise::PropertyNotification', request_name => 'notification', traits => ['NameInRequest']); | ||
| 10 | has Unit => (is => 'ro', isa => 'Str', request_name => 'unit', traits => ['NameInRequest']); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::IoTSiteWise::AssetProperty | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::IoTSiteWise::AssetProperty object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { Alias => $value, ..., Unit => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTSiteWise::AssetProperty object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->Alias | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Contains asset property information. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Alias => Str | ||
| 48 | |||
| 49 | The property alias that identifies the property, such as an OPC-UA | ||
| 50 | server data stream path (for example, | ||
| 51 | C</company/windfarm/3/turbine/7/temperature>). For more information, | ||
| 52 | see Mapping industrial data streams to asset properties | ||
| 53 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) | ||
| 54 | in the I<AWS IoT SiteWise User Guide>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> DataType => Str | ||
| 58 | |||
| 59 | The data type of the asset property. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 DataTypeSpec => Str | ||
| 63 | |||
| 64 | The data type of the structure for this property. This parameter exists | ||
| 65 | on properties that have the C<STRUCT> data type. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> Id => Str | ||
| 69 | |||
| 70 | The ID of the asset property. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> Name => Str | ||
| 74 | |||
| 75 | The name of the property. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Notification => L<Paws::IoTSiteWise::PropertyNotification> | ||
| 79 | |||
| 80 | The asset property's notification topic and state. For more | ||
| 81 | information, see UpdateAssetProperty | ||
| 82 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). | ||
| 83 | |||
| 84 | |||
| 85 | =head2 Unit => Str | ||
| 86 | |||
| 87 | The unit (such as C<Newtons> or C<RPM>) of the asset property. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTSiteWise> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |