/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace IoTSiteWise { namespace Model { /** *

Contains a summary of a time series (data stream).

See Also:

* AWS * API Reference

*/ class TimeSeriesSummary { public: AWS_IOTSITEWISE_API TimeSeriesSummary(); AWS_IOTSITEWISE_API TimeSeriesSummary(Aws::Utils::Json::JsonView jsonValue); AWS_IOTSITEWISE_API TimeSeriesSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_IOTSITEWISE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The ID of the asset in which the asset property was created.

*/ inline const Aws::String& GetAssetId() const{ return m_assetId; } /** *

The ID of the asset in which the asset property was created.

*/ inline bool AssetIdHasBeenSet() const { return m_assetIdHasBeenSet; } /** *

The ID of the asset in which the asset property was created.

*/ inline void SetAssetId(const Aws::String& value) { m_assetIdHasBeenSet = true; m_assetId = value; } /** *

The ID of the asset in which the asset property was created.

*/ inline void SetAssetId(Aws::String&& value) { m_assetIdHasBeenSet = true; m_assetId = std::move(value); } /** *

The ID of the asset in which the asset property was created.

*/ inline void SetAssetId(const char* value) { m_assetIdHasBeenSet = true; m_assetId.assign(value); } /** *

The ID of the asset in which the asset property was created.

*/ inline TimeSeriesSummary& WithAssetId(const Aws::String& value) { SetAssetId(value); return *this;} /** *

The ID of the asset in which the asset property was created.

*/ inline TimeSeriesSummary& WithAssetId(Aws::String&& value) { SetAssetId(std::move(value)); return *this;} /** *

The ID of the asset in which the asset property was created.

*/ inline TimeSeriesSummary& WithAssetId(const char* value) { SetAssetId(value); return *this;} /** *

The ID of the asset property.

*/ inline const Aws::String& GetPropertyId() const{ return m_propertyId; } /** *

The ID of the asset property.

*/ inline bool PropertyIdHasBeenSet() const { return m_propertyIdHasBeenSet; } /** *

The ID of the asset property.

*/ inline void SetPropertyId(const Aws::String& value) { m_propertyIdHasBeenSet = true; m_propertyId = value; } /** *

The ID of the asset property.

*/ inline void SetPropertyId(Aws::String&& value) { m_propertyIdHasBeenSet = true; m_propertyId = std::move(value); } /** *

The ID of the asset property.

*/ inline void SetPropertyId(const char* value) { m_propertyIdHasBeenSet = true; m_propertyId.assign(value); } /** *

The ID of the asset property.

*/ inline TimeSeriesSummary& WithPropertyId(const Aws::String& value) { SetPropertyId(value); return *this;} /** *

The ID of the asset property.

*/ inline TimeSeriesSummary& WithPropertyId(Aws::String&& value) { SetPropertyId(std::move(value)); return *this;} /** *

The ID of the asset property.

*/ inline TimeSeriesSummary& WithPropertyId(const char* value) { SetPropertyId(value); return *this;} /** *

The alias that identifies the time series.

*/ inline const Aws::String& GetAlias() const{ return m_alias; } /** *

The alias that identifies the time series.

*/ inline bool AliasHasBeenSet() const { return m_aliasHasBeenSet; } /** *

The alias that identifies the time series.

*/ inline void SetAlias(const Aws::String& value) { m_aliasHasBeenSet = true; m_alias = value; } /** *

The alias that identifies the time series.

*/ inline void SetAlias(Aws::String&& value) { m_aliasHasBeenSet = true; m_alias = std::move(value); } /** *

The alias that identifies the time series.

*/ inline void SetAlias(const char* value) { m_aliasHasBeenSet = true; m_alias.assign(value); } /** *

The alias that identifies the time series.

*/ inline TimeSeriesSummary& WithAlias(const Aws::String& value) { SetAlias(value); return *this;} /** *

The alias that identifies the time series.

*/ inline TimeSeriesSummary& WithAlias(Aws::String&& value) { SetAlias(std::move(value)); return *this;} /** *

The alias that identifies the time series.

*/ inline TimeSeriesSummary& WithAlias(const char* value) { SetAlias(value); return *this;} /** *

The ID of the time series.

*/ inline const Aws::String& GetTimeSeriesId() const{ return m_timeSeriesId; } /** *

The ID of the time series.

*/ inline bool TimeSeriesIdHasBeenSet() const { return m_timeSeriesIdHasBeenSet; } /** *

The ID of the time series.

*/ inline void SetTimeSeriesId(const Aws::String& value) { m_timeSeriesIdHasBeenSet = true; m_timeSeriesId = value; } /** *

The ID of the time series.

*/ inline void SetTimeSeriesId(Aws::String&& value) { m_timeSeriesIdHasBeenSet = true; m_timeSeriesId = std::move(value); } /** *

The ID of the time series.

*/ inline void SetTimeSeriesId(const char* value) { m_timeSeriesIdHasBeenSet = true; m_timeSeriesId.assign(value); } /** *

The ID of the time series.

*/ inline TimeSeriesSummary& WithTimeSeriesId(const Aws::String& value) { SetTimeSeriesId(value); return *this;} /** *

The ID of the time series.

*/ inline TimeSeriesSummary& WithTimeSeriesId(Aws::String&& value) { SetTimeSeriesId(std::move(value)); return *this;} /** *

The ID of the time series.

*/ inline TimeSeriesSummary& WithTimeSeriesId(const char* value) { SetTimeSeriesId(value); return *this;} /** *

The data type of the time series.

If you specify STRUCT, * you must also specify dataTypeSpec to identify the type of the * structure for this time series.

*/ inline const PropertyDataType& GetDataType() const{ return m_dataType; } /** *

The data type of the time series.

If you specify STRUCT, * you must also specify dataTypeSpec to identify the type of the * structure for this time series.

*/ inline bool DataTypeHasBeenSet() const { return m_dataTypeHasBeenSet; } /** *

The data type of the time series.

If you specify STRUCT, * you must also specify dataTypeSpec to identify the type of the * structure for this time series.

*/ inline void SetDataType(const PropertyDataType& value) { m_dataTypeHasBeenSet = true; m_dataType = value; } /** *

The data type of the time series.

If you specify STRUCT, * you must also specify dataTypeSpec to identify the type of the * structure for this time series.

*/ inline void SetDataType(PropertyDataType&& value) { m_dataTypeHasBeenSet = true; m_dataType = std::move(value); } /** *

The data type of the time series.

If you specify STRUCT, * you must also specify dataTypeSpec to identify the type of the * structure for this time series.

*/ inline TimeSeriesSummary& WithDataType(const PropertyDataType& value) { SetDataType(value); return *this;} /** *

The data type of the time series.

If you specify STRUCT, * you must also specify dataTypeSpec to identify the type of the * structure for this time series.

*/ inline TimeSeriesSummary& WithDataType(PropertyDataType&& value) { SetDataType(std::move(value)); return *this;} /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline const Aws::String& GetDataTypeSpec() const{ return m_dataTypeSpec; } /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline bool DataTypeSpecHasBeenSet() const { return m_dataTypeSpecHasBeenSet; } /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline void SetDataTypeSpec(const Aws::String& value) { m_dataTypeSpecHasBeenSet = true; m_dataTypeSpec = value; } /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline void SetDataTypeSpec(Aws::String&& value) { m_dataTypeSpecHasBeenSet = true; m_dataTypeSpec = std::move(value); } /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline void SetDataTypeSpec(const char* value) { m_dataTypeSpecHasBeenSet = true; m_dataTypeSpec.assign(value); } /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline TimeSeriesSummary& WithDataTypeSpec(const Aws::String& value) { SetDataTypeSpec(value); return *this;} /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline TimeSeriesSummary& WithDataTypeSpec(Aws::String&& value) { SetDataTypeSpec(std::move(value)); return *this;} /** *

The data type of the structure for this time series. This parameter is * required for time series that have the STRUCT data type.

The * options for this parameter depend on the type of the composite model in which * you created the asset property that is associated with your time series. Use * AWS/ALARM_STATE for alarm state in alarm composite models.

*/ inline TimeSeriesSummary& WithDataTypeSpec(const char* value) { SetDataTypeSpec(value); return *this;} /** *

The date that the time series was created, in Unix epoch time.

*/ inline const Aws::Utils::DateTime& GetTimeSeriesCreationDate() const{ return m_timeSeriesCreationDate; } /** *

The date that the time series was created, in Unix epoch time.

*/ inline bool TimeSeriesCreationDateHasBeenSet() const { return m_timeSeriesCreationDateHasBeenSet; } /** *

The date that the time series was created, in Unix epoch time.

*/ inline void SetTimeSeriesCreationDate(const Aws::Utils::DateTime& value) { m_timeSeriesCreationDateHasBeenSet = true; m_timeSeriesCreationDate = value; } /** *

The date that the time series was created, in Unix epoch time.

*/ inline void SetTimeSeriesCreationDate(Aws::Utils::DateTime&& value) { m_timeSeriesCreationDateHasBeenSet = true; m_timeSeriesCreationDate = std::move(value); } /** *

The date that the time series was created, in Unix epoch time.

*/ inline TimeSeriesSummary& WithTimeSeriesCreationDate(const Aws::Utils::DateTime& value) { SetTimeSeriesCreationDate(value); return *this;} /** *

The date that the time series was created, in Unix epoch time.

*/ inline TimeSeriesSummary& WithTimeSeriesCreationDate(Aws::Utils::DateTime&& value) { SetTimeSeriesCreationDate(std::move(value)); return *this;} /** *

The date that the time series was last updated, in Unix epoch time.

*/ inline const Aws::Utils::DateTime& GetTimeSeriesLastUpdateDate() const{ return m_timeSeriesLastUpdateDate; } /** *

The date that the time series was last updated, in Unix epoch time.

*/ inline bool TimeSeriesLastUpdateDateHasBeenSet() const { return m_timeSeriesLastUpdateDateHasBeenSet; } /** *

The date that the time series was last updated, in Unix epoch time.

*/ inline void SetTimeSeriesLastUpdateDate(const Aws::Utils::DateTime& value) { m_timeSeriesLastUpdateDateHasBeenSet = true; m_timeSeriesLastUpdateDate = value; } /** *

The date that the time series was last updated, in Unix epoch time.

*/ inline void SetTimeSeriesLastUpdateDate(Aws::Utils::DateTime&& value) { m_timeSeriesLastUpdateDateHasBeenSet = true; m_timeSeriesLastUpdateDate = std::move(value); } /** *

The date that the time series was last updated, in Unix epoch time.

*/ inline TimeSeriesSummary& WithTimeSeriesLastUpdateDate(const Aws::Utils::DateTime& value) { SetTimeSeriesLastUpdateDate(value); return *this;} /** *

The date that the time series was last updated, in Unix epoch time.

*/ inline TimeSeriesSummary& WithTimeSeriesLastUpdateDate(Aws::Utils::DateTime&& value) { SetTimeSeriesLastUpdateDate(std::move(value)); return *this;} /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline const Aws::String& GetTimeSeriesArn() const{ return m_timeSeriesArn; } /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline bool TimeSeriesArnHasBeenSet() const { return m_timeSeriesArnHasBeenSet; } /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline void SetTimeSeriesArn(const Aws::String& value) { m_timeSeriesArnHasBeenSet = true; m_timeSeriesArn = value; } /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline void SetTimeSeriesArn(Aws::String&& value) { m_timeSeriesArnHasBeenSet = true; m_timeSeriesArn = std::move(value); } /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline void SetTimeSeriesArn(const char* value) { m_timeSeriesArnHasBeenSet = true; m_timeSeriesArn.assign(value); } /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline TimeSeriesSummary& WithTimeSeriesArn(const Aws::String& value) { SetTimeSeriesArn(value); return *this;} /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline TimeSeriesSummary& WithTimeSeriesArn(Aws::String&& value) { SetTimeSeriesArn(std::move(value)); return *this;} /** *

The ARN * of the time series, which has the following format.

* arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} *

*/ inline TimeSeriesSummary& WithTimeSeriesArn(const char* value) { SetTimeSeriesArn(value); return *this;} private: Aws::String m_assetId; bool m_assetIdHasBeenSet = false; Aws::String m_propertyId; bool m_propertyIdHasBeenSet = false; Aws::String m_alias; bool m_aliasHasBeenSet = false; Aws::String m_timeSeriesId; bool m_timeSeriesIdHasBeenSet = false; PropertyDataType m_dataType; bool m_dataTypeHasBeenSet = false; Aws::String m_dataTypeSpec; bool m_dataTypeSpecHasBeenSet = false; Aws::Utils::DateTime m_timeSeriesCreationDate; bool m_timeSeriesCreationDateHasBeenSet = false; Aws::Utils::DateTime m_timeSeriesLastUpdateDate; bool m_timeSeriesLastUpdateDateHasBeenSet = false; Aws::String m_timeSeriesArn; bool m_timeSeriesArnHasBeenSet = false; }; } // namespace Model } // namespace IoTSiteWise } // namespace Aws