« blib/lib/Paws/IoTSiteWise/AssetModelProperty.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/AssetModelStatus.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTSiteWise::AssetModelPropertyDefinition; | ||
| 3 | use Moose; | ||
| 4 | has DataType => (is => 'ro', isa => 'Str', request_name => 'dataType', traits => ['NameInRequest'], required => 1); | ||
| 5 | has DataTypeSpec => (is => 'ro', isa => 'Str', request_name => 'dataTypeSpec', traits => ['NameInRequest']); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 7 | has Type => (is => 'ro', isa => 'Paws::IoTSiteWise::PropertyType', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 8 | has Unit => (is => 'ro', isa => 'Str', request_name => 'unit', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::IoTSiteWise::AssetModelPropertyDefinition | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::IoTSiteWise::AssetModelPropertyDefinition object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { DataType => $value, ..., Unit => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTSiteWise::AssetModelPropertyDefinition object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->DataType | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Contains an asset model property definition. This property definition | ||
| 41 | is applied to all assets created from the asset model. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> DataType => Str | ||
| 47 | |||
| 48 | The data type of the property definition. | ||
| 49 | |||
| 50 | If you specify C<STRUCT>, you must also specify C<dataTypeSpec> to | ||
| 51 | identify the type of the structure for this property. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 DataTypeSpec => Str | ||
| 55 | |||
| 56 | The data type of the structure for this property. This parameter is | ||
| 57 | required on properties that have the C<STRUCT> data type. | ||
| 58 | |||
| 59 | The options for this parameter depend on the type of the composite | ||
| 60 | model in which you define this property. Use C<AWS/ALARM_STATE> for | ||
| 61 | alarm state in alarm composite models. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Name => Str | ||
| 65 | |||
| 66 | The name of the property definition. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> Type => L<Paws::IoTSiteWise::PropertyType> | ||
| 70 | |||
| 71 | The property definition type (see C<PropertyType>). You can only | ||
| 72 | specify one type in a property definition. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 Unit => Str | ||
| 76 | |||
| 77 | The unit of the property definition, such as C<Newtons> or C<RPM>. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTSiteWise> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |