software.amazon.awssdk.services.iotsitewise.model

Class TimeSeriesSummary

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.TimeSeriesSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TimeSeriesSummary.Builder,TimeSeriesSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class TimeSeriesSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TimeSeriesSummary.Builder,TimeSeriesSummary>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TimeSeriesSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	alias() The alias that identifies the time series.
String	assetId() The ID of the asset in which the asset property was created.
static TimeSeriesSummary.Builder	builder()
PropertyDataType	dataType() The data type of the time series.
String	dataTypeAsString() The data type of the time series.
String	dataTypeSpec() The data type of the structure for this time series.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	propertyId() The ID of the asset property.
List<SdkField<?>>	sdkFields()
static Class<? extends TimeSeriesSummary.Builder>	serializableBuilderClass()
String	timeSeriesArn() The ARN of the time series, which has the following format.
Instant	timeSeriesCreationDate() The date that the time series was created, in Unix epoch time.
String	timeSeriesId() The ID of the time series.
Instant	timeSeriesLastUpdateDate() The date that the time series was last updated, in Unix epoch time.
TimeSeriesSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

assetId

public final String 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

public final String propertyId()

The ID of the asset property.

Returns:

The ID of the asset property.

alias

public final String alias()

The alias that identifies the time series.

Returns:

The alias that identifies the time series.

timeSeriesId

public final String timeSeriesId()

The ID of the time series.

Returns:

The ID of the time series.

dataType

public final PropertyDataType 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.

If the service returns an enum value that is not available in the current SDK version, dataType will return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

Returns:

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.

See Also:

PropertyDataType

dataTypeAsString

public final String dataTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, dataType will return PropertyDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

Returns:

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.

See Also:

PropertyDataType

dataTypeSpec

public final String 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

public final Instant 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

public final Instant 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

public final String 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

public TimeSeriesSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimeSeriesSummary.Builder,TimeSeriesSummary>

builder

public static TimeSeriesSummary.Builder builder()

serializableBuilderClass

public static Class<? extends TimeSeriesSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo