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