« blib/lib/Paws/IoTEvents/AssetPropertyTimestamp.pm
↑ Summary
blib/lib/Paws/IoTEvents/AssetPropertyVariant.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTEvents::AssetPropertyValue; | ||
| 3 | use Moose; | ||
| 4 | has Quality => (is => 'ro', isa => 'Str', request_name => 'quality', traits => ['NameInRequest']); | ||
| 5 | has Timestamp => (is => 'ro', isa => 'Paws::IoTEvents::AssetPropertyTimestamp', request_name => 'timestamp', traits => ['NameInRequest']); | ||
| 6 | has Value => (is => 'ro', isa => 'Paws::IoTEvents::AssetPropertyVariant', request_name => 'value', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::IoTEvents::AssetPropertyValue | ||
| 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::IoTEvents::AssetPropertyValue object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Quality => $value, ..., Value => $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::IoTEvents::AssetPropertyValue object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Quality | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A structure that contains value information. For more information, see | ||
| 39 | AssetPropertyValue | ||
| 40 | (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) | ||
| 41 | in the I<AWS IoT SiteWise API Reference>. | ||
| 42 | |||
| 43 | You must use expressions for all parameters in C<AssetPropertyValue>. | ||
| 44 | The expressions accept literals, operators, functions, references, and | ||
| 45 | substitution templates. | ||
| 46 | |||
| 47 | B<Examples> | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | For literal values, the expressions must contain single quotes. For | ||
| 54 | example, the value for the C<quality> parameter can be C<'GOOD'>. | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | For references, you must specify either variables or input values. For | ||
| 59 | example, the value for the C<quality> parameter can be | ||
| 60 | C<$input.TemperatureInput.sensorData.quality>. | ||
| 61 | |||
| 62 | =back | ||
| 63 | |||
| 64 | For more information, see Expressions | ||
| 65 | (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) | ||
| 66 | in the I<AWS IoT Events Developer Guide>. | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Quality => Str | ||
| 72 | |||
| 73 | The quality of the asset property value. The value must be C<'GOOD'>, | ||
| 74 | C<'BAD'>, or C<'UNCERTAIN'>. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Timestamp => L<Paws::IoTEvents::AssetPropertyTimestamp> | ||
| 78 | |||
| 79 | The timestamp associated with the asset property value. The default is | ||
| 80 | the current event time. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Value => L<Paws::IoTEvents::AssetPropertyVariant> | ||
| 84 | |||
| 85 | The value to send to an asset property. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTEvents> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |