« blib/lib/Paws/IoTSiteWise/GetAssetPropertyValueResponse.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/GetInterpolatedAssetPropertyValuesResponse.pm »
| 1 | |||
| 2 | package Paws::IoTSiteWise::GetInterpolatedAssetPropertyValues; | ||
| 3 | use Moose; | ||
| 4 | has AssetId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'assetId'); | ||
| 5 | has EndTimeInSeconds => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'endTimeInSeconds', required => 1); | ||
| 6 | has EndTimeOffsetInNanos => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'endTimeOffsetInNanos'); | ||
| 7 | has IntervalInSeconds => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'intervalInSeconds', required => 1); | ||
| 8 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 9 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 10 | has PropertyAlias => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'propertyAlias'); | ||
| 11 | has PropertyId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'propertyId'); | ||
| 12 | has Quality => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'quality', required => 1); | ||
| 13 | has StartTimeInSeconds => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'startTimeInSeconds', required => 1); | ||
| 14 | has StartTimeOffsetInNanos => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'startTimeOffsetInNanos'); | ||
| 15 | has Type => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'type', required => 1); | ||
| 16 | |||
| 17 | use MooseX::ClassAttribute; | ||
| 18 | |||
| 19 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetInterpolatedAssetPropertyValues'); | ||
| 20 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/properties/interpolated'); | ||
| 21 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 22 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTSiteWise::GetInterpolatedAssetPropertyValuesResponse'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::IoTSiteWise::GetInterpolatedAssetPropertyValues - Arguments for method GetInterpolatedAssetPropertyValues on L<Paws::IoTSiteWise> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method GetInterpolatedAssetPropertyValues on the | ||
| 34 | L<AWS IoT SiteWise|Paws::IoTSiteWise> service. Use the attributes of this class | ||
| 35 | as arguments to method GetInterpolatedAssetPropertyValues. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetInterpolatedAssetPropertyValues. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $iotsitewise = Paws->service('IoTSiteWise'); | ||
| 42 | my $GetInterpolatedAssetPropertyValuesResponse = | ||
| 43 | $iotsitewise->GetInterpolatedAssetPropertyValues( | ||
| 44 | EndTimeInSeconds => 1, | ||
| 45 | IntervalInSeconds => 1, | ||
| 46 | Quality => 'GOOD', | ||
| 47 | StartTimeInSeconds => 1, | ||
| 48 | Type => 'MyInterpolationType', | ||
| 49 | AssetId => 'MyID', # OPTIONAL | ||
| 50 | EndTimeOffsetInNanos => 1, # OPTIONAL | ||
| 51 | MaxResults => 1, # OPTIONAL | ||
| 52 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 53 | PropertyAlias => 'MyAssetPropertyAlias', # OPTIONAL | ||
| 54 | PropertyId => 'MyID', # OPTIONAL | ||
| 55 | StartTimeOffsetInNanos => 1, # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $InterpolatedAssetPropertyValues = | ||
| 60 | $GetInterpolatedAssetPropertyValuesResponse | ||
| 61 | ->InterpolatedAssetPropertyValues; | ||
| 62 | my $NextToken = $GetInterpolatedAssetPropertyValuesResponse->NextToken; | ||
| 63 | |||
| 64 | # Returns a L<Paws::IoTSiteWise::GetInterpolatedAssetPropertyValuesResponse> object. | ||
| 65 | |||
| 66 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotsitewise/GetInterpolatedAssetPropertyValues> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AssetId => Str | ||
| 73 | |||
| 74 | The ID of the asset. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> EndTimeInSeconds => Int | ||
| 79 | |||
| 80 | The inclusive end of the range from which to interpolate data, | ||
| 81 | expressed in seconds in Unix epoch time. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 EndTimeOffsetInNanos => Int | ||
| 86 | |||
| 87 | The nanosecond offset converted from C<endTimeInSeconds>. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> IntervalInSeconds => Int | ||
| 92 | |||
| 93 | The time interval in seconds over which to interpolate data. Each | ||
| 94 | interval starts when the previous one ends. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 MaxResults => Int | ||
| 99 | |||
| 100 | The maximum number of results to be returned per paginated request. If | ||
| 101 | not specified, the default value is 10. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 NextToken => Str | ||
| 106 | |||
| 107 | The token to be used for the next set of paginated results. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 PropertyAlias => Str | ||
| 112 | |||
| 113 | The property alias that identifies the property, such as an OPC-UA | ||
| 114 | server data stream path (for example, | ||
| 115 | C</company/windfarm/3/turbine/7/temperature>). For more information, | ||
| 116 | see Mapping industrial data streams to asset properties | ||
| 117 | (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) | ||
| 118 | in the I<AWS IoT SiteWise User Guide>. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 PropertyId => Str | ||
| 123 | |||
| 124 | The ID of the asset property. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 B<REQUIRED> Quality => Str | ||
| 129 | |||
| 130 | The quality of the asset property value. You can use this parameter as | ||
| 131 | a filter to choose only the asset property values that have a specific | ||
| 132 | quality. | ||
| 133 | |||
| 134 | Valid values are: C<"GOOD">, C<"BAD">, C<"UNCERTAIN"> | ||
| 135 | |||
| 136 | =head2 B<REQUIRED> StartTimeInSeconds => Int | ||
| 137 | |||
| 138 | The exclusive start of the range from which to interpolate data, | ||
| 139 | expressed in seconds in Unix epoch time. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 StartTimeOffsetInNanos => Int | ||
| 144 | |||
| 145 | The nanosecond offset converted from C<startTimeInSeconds>. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 B<REQUIRED> Type => Str | ||
| 150 | |||
| 151 | The interpolation type. | ||
| 152 | |||
| 153 | Valid values: C<LINEAR_INTERPOLATION> | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head1 SEE ALSO | ||
| 159 | |||
| 160 | This class forms part of L<Paws>, documenting arguments for method GetInterpolatedAssetPropertyValues in L<Paws::IoTSiteWise> | ||
| 161 | |||
| 162 | =head1 BUGS and CONTRIBUTIONS | ||
| 163 | |||
| 164 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 165 | |||
| 166 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 167 | |||
| 168 | =cut | ||
| 169 |