/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the iotsitewise-2019-12-02.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.IoTSiteWise.Model
{
///
/// Contains information for an asset property historical value entry that is associated
/// with the BatchGetAssetPropertyValueHistory
/// API.
///
///
///
/// 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.
///
///
///
public partial class BatchGetAssetPropertyValueHistoryEntry
{
private string _assetId;
private DateTime? _endDate;
private string _entryId;
private string _propertyAlias;
private string _propertyId;
private List _qualities = new List();
private DateTime? _startDate;
private TimeOrdering _timeOrdering;
///
/// Gets and sets the property AssetId.
///
/// The ID of the asset in which the asset property was created.
///
///
[AWSProperty(Min=36, Max=36)]
public string AssetId
{
get { return this._assetId; }
set { this._assetId = value; }
}
// Check to see if AssetId property is set
internal bool IsSetAssetId()
{
return this._assetId != null;
}
///
/// Gets and sets the property EndDate.
///
/// The inclusive end of the range from which to query historical data, expressed in seconds
/// in Unix epoch time.
///
///
public DateTime EndDate
{
get { return this._endDate.GetValueOrDefault(); }
set { this._endDate = value; }
}
// Check to see if EndDate property is set
internal bool IsSetEndDate()
{
return this._endDate.HasValue;
}
///
/// Gets and sets the property EntryId.
///
/// The ID of the entry.
///
///
[AWSProperty(Required=true, Min=1, Max=64)]
public string EntryId
{
get { return this._entryId; }
set { this._entryId = value; }
}
// Check to see if EntryId property is set
internal bool IsSetEntryId()
{
return this._entryId != null;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Min=1, Max=2048)]
public string PropertyAlias
{
get { return this._propertyAlias; }
set { this._propertyAlias = value; }
}
// Check to see if PropertyAlias property is set
internal bool IsSetPropertyAlias()
{
return this._propertyAlias != null;
}
///
/// Gets and sets the property PropertyId.
///
/// The ID of the asset property.
///
///
[AWSProperty(Min=36, Max=36)]
public string PropertyId
{
get { return this._propertyId; }
set { this._propertyId = value; }
}
// Check to see if PropertyId property is set
internal bool IsSetPropertyId()
{
return this._propertyId != null;
}
///
/// Gets and sets the property Qualities.
///
/// The quality by which to filter asset data.
///
///
[AWSProperty(Min=1, Max=1)]
public List Qualities
{
get { return this._qualities; }
set { this._qualities = value; }
}
// Check to see if Qualities property is set
internal bool IsSetQualities()
{
return this._qualities != null && this._qualities.Count > 0;
}
///
/// Gets and sets the property StartDate.
///
/// The exclusive start of the range from which to query historical data, expressed in
/// seconds in Unix epoch time.
///
///
public DateTime StartDate
{
get { return this._startDate.GetValueOrDefault(); }
set { this._startDate = value; }
}
// Check to see if StartDate property is set
internal bool IsSetStartDate()
{
return this._startDate.HasValue;
}
///
/// Gets and sets the property TimeOrdering.
///
/// The chronological sorting order of the requested information.
///
///
///
/// Default: ASCENDING
///
///
public TimeOrdering TimeOrdering
{
get { return this._timeOrdering; }
set { this._timeOrdering = value; }
}
// Check to see if TimeOrdering property is set
internal bool IsSetTimeOrdering()
{
return this._timeOrdering != null;
}
}
}