Class TimeSeriesSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TimeSeriesSummary.Builder,
TimeSeriesSummary>
Contains a summary of a time series (data stream).
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
alias()
The alias that identifies the time series.final String
assetId()
The ID of the asset in which the asset property was created.static TimeSeriesSummary.Builder
builder()
final PropertyDataType
dataType()
The data type of the time series.final String
The data type of the time series.final String
The data type of the structure for this time series.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The ID of the asset property, in UUID format.static Class
<? extends TimeSeriesSummary.Builder> final String
The ARN of the time series, which has the following format.final Instant
The date that the time series was created, in Unix epoch time.final String
The ID of the time series.final Instant
The date that the time series was last updated, in Unix epoch time.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
assetId
The ID of the asset in which the asset property was created.
- Returns:
- The ID of the asset in which the asset property was created.
-
propertyId
The ID of the asset property, in UUID format.
- Returns:
- The ID of the asset property, in UUID format.
-
alias
The alias that identifies the time series.
- Returns:
- The alias that identifies the time series.
-
timeSeriesId
The ID of the time series.
- Returns:
- The ID of the time series.
-
dataType
The data type of the time series.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this time series.If the service returns an enum value that is not available in the current SDK version,
dataType
will returnPropertyDataType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataTypeAsString()
.- Returns:
- The data type of the time series.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this time series. - See Also:
-
dataTypeAsString
The data type of the time series.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this time series.If the service returns an enum value that is not available in the current SDK version,
dataType
will returnPropertyDataType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdataTypeAsString()
.- Returns:
- The data type of the time series.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this time series. - See Also:
-
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.- Returns:
- 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.
-
timeSeriesCreationDate
The date that the time series was created, in Unix epoch time.
- Returns:
- The date that the time series was created, in Unix epoch time.
-
timeSeriesLastUpdateDate
The date that the time series was last updated, in Unix epoch time.
- Returns:
- The date that the time series was last updated, in Unix epoch time.
-
timeSeriesArn
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
- Returns:
- The ARN of the
time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TimeSeriesSummary.Builder,
TimeSeriesSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-