/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.IoTSiteWise;
using Amazon.IoTSiteWise.Model;
namespace Amazon.PowerShell.Cmdlets.IOTSW
{
///
/// Gets aggregated values for an asset property. For more information, see Querying
/// aggregates in the IoT SiteWise User Guide.
///
///
///
/// To identify an asset property, you must specify one of the following:
/// -
/// The
assetId
and propertyId
of an asset property.
/// -
/// A
propertyAlias
, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature
).
/// To define an asset property's alias, see UpdateAssetProperty.
///
This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.
///
[Cmdlet("Get", "IOTSWAssetPropertyAggregate")]
[OutputType("Amazon.IoTSiteWise.Model.AggregatedValue")]
[AWSCmdlet("Calls the AWS IoT SiteWise GetAssetPropertyAggregates API operation.", Operation = new[] {"GetAssetPropertyAggregates"}, SelectReturnType = typeof(Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse))]
[AWSCmdletOutput("Amazon.IoTSiteWise.Model.AggregatedValue or Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse",
"This cmdlet returns a collection of Amazon.IoTSiteWise.Model.AggregatedValue objects.",
"The service call response (type Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetIOTSWAssetPropertyAggregateCmdlet : AmazonIoTSiteWiseClientCmdlet, IExecutor
{
#region Parameter AggregateType
///
///
/// The data aggregating function.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("AggregateTypes")]
public System.String[] AggregateType { get; set; }
#endregion
#region Parameter AssetId
///
///
/// The ID of the asset.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AssetId { get; set; }
#endregion
#region Parameter EndDate
///
///
/// The inclusive end of the range from which to query historical data, expressed in seconds
/// in Unix epoch time.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? EndDate { get; set; }
#endregion
#region Parameter PropertyAlias
///
///
/// The alias that identifies the property, such as an OPC-UA server data stream path
/// (for example, /company/windfarm/3/turbine/7/temperature
). For more information,
/// see Mapping
/// industrial data streams to asset properties in the IoT SiteWise User Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PropertyAlias { get; set; }
#endregion
#region Parameter PropertyId
///
///
/// The ID of the asset property.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PropertyId { get; set; }
#endregion
#region Parameter Quality
///
///
/// The quality by which to filter asset data.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Qualities")]
public System.String[] Quality { get; set; }
#endregion
#region Parameter Resolution
///
///
/// The time interval over which to aggregate data.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String Resolution { get; set; }
#endregion
#region Parameter StartDate
///
///
/// The exclusive start of the range from which to query historical data, expressed in
/// seconds in Unix epoch time.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.DateTime? StartDate { get; set; }
#endregion
#region Parameter TimeOrdering
///
///
/// The chronological sorting order of the requested information.Default: ASCENDING
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.IoTSiteWise.TimeOrdering")]
public Amazon.IoTSiteWise.TimeOrdering TimeOrdering { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of results to return for each paginated request. A result set is
/// returned in the two cases, whichever occurs first.- The size of the result set is equal to 1 MB.
- The number of data points in the result set is equal to the value of
maxResults
.
/// The maximum value of maxResults
is 250.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// The token to be used for the next set of paginated results.
///
///
///
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
///
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'AggregatedValues'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse).
/// Specifying the name of a property of type Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "AggregatedValues";
#endregion
#region Parameter NoAutoIteration
///
/// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple
/// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken
/// as the start point.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoAutoIteration { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
if (this.AggregateType != null)
{
context.AggregateType = new List(this.AggregateType);
}
#if MODULAR
if (this.AggregateType == null && ParameterWasBound(nameof(this.AggregateType)))
{
WriteWarning("You are passing $null as a value for parameter AggregateType which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.AssetId = this.AssetId;
context.EndDate = this.EndDate;
#if MODULAR
if (this.EndDate == null && ParameterWasBound(nameof(this.EndDate)))
{
WriteWarning("You are passing $null as a value for parameter EndDate which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.PropertyAlias = this.PropertyAlias;
context.PropertyId = this.PropertyId;
if (this.Quality != null)
{
context.Quality = new List(this.Quality);
}
context.Resolution = this.Resolution;
#if MODULAR
if (this.Resolution == null && ParameterWasBound(nameof(this.Resolution)))
{
WriteWarning("You are passing $null as a value for parameter Resolution which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.StartDate = this.StartDate;
#if MODULAR
if (this.StartDate == null && ParameterWasBound(nameof(this.StartDate)))
{
WriteWarning("You are passing $null as a value for parameter StartDate which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.TimeOrdering = this.TimeOrdering;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^");
// create request and set iteration invariants
var request = new Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesRequest();
if (cmdletContext.AggregateType != null)
{
request.AggregateTypes = cmdletContext.AggregateType;
}
if (cmdletContext.AssetId != null)
{
request.AssetId = cmdletContext.AssetId;
}
if (cmdletContext.EndDate != null)
{
request.EndDate = cmdletContext.EndDate.Value;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.PropertyAlias != null)
{
request.PropertyAlias = cmdletContext.PropertyAlias;
}
if (cmdletContext.PropertyId != null)
{
request.PropertyId = cmdletContext.PropertyId;
}
if (cmdletContext.Quality != null)
{
request.Qualities = cmdletContext.Quality;
}
if (cmdletContext.Resolution != null)
{
request.Resolution = cmdletContext.Resolution;
}
if (cmdletContext.StartDate != null)
{
request.StartDate = cmdletContext.StartDate.Value;
}
if (cmdletContext.TimeOrdering != null)
{
request.TimeOrdering = cmdletContext.TimeOrdering;
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.NextToken;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
_nextToken = response.NextToken;
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return null;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesResponse CallAWSServiceOperation(IAmazonIoTSiteWise client, Amazon.IoTSiteWise.Model.GetAssetPropertyAggregatesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT SiteWise", "GetAssetPropertyAggregates");
try
{
#if DESKTOP
return client.GetAssetPropertyAggregates(request);
#elif CORECLR
return client.GetAssetPropertyAggregatesAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public List AggregateType { get; set; }
public System.String AssetId { get; set; }
public System.DateTime? EndDate { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.String PropertyAlias { get; set; }
public System.String PropertyId { get; set; }
public List Quality { get; set; }
public System.String Resolution { get; set; }
public System.DateTime? StartDate { get; set; }
public Amazon.IoTSiteWise.TimeOrdering TimeOrdering { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.AggregatedValues;
}
}
}