TimeSeriesSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotsitewise.model.TimeSeriesSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TimeSeriesSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains a summary of a time series (data stream).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TimeSeriesSummary()

Constructors
Constructor and Description
`TimeSeriesSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TimeSeriesSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAlias()` The alias that identifies the time series.
`String`	`getAssetId()` The ID of the asset in which the asset property was created.
`String`	`getDataType()` The data type of the time series.
`String`	`getDataTypeSpec()` The data type of the structure for this time series.
`String`	`getPropertyId()` The ID of the asset property, in UUID format.
`String`	`getTimeSeriesArn()` The ARN of the time series, which has the following format.
`Date`	`getTimeSeriesCreationDate()` The date that the time series was created, in Unix epoch time.
`String`	`getTimeSeriesId()` The ID of the time series.
`Date`	`getTimeSeriesLastUpdateDate()` The date that the time series was last updated, in Unix epoch time.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlias(String alias)` The alias that identifies the time series.
`void`	`setAssetId(String assetId)` The ID of the asset in which the asset property was created.
`void`	`setDataType(String dataType)` The data type of the time series.
`void`	`setDataTypeSpec(String dataTypeSpec)` The data type of the structure for this time series.
`void`	`setPropertyId(String propertyId)` The ID of the asset property, in UUID format.
`void`	`setTimeSeriesArn(String timeSeriesArn)` The ARN of the time series, which has the following format.
`void`	`setTimeSeriesCreationDate(Date timeSeriesCreationDate)` The date that the time series was created, in Unix epoch time.
`void`	`setTimeSeriesId(String timeSeriesId)` The ID of the time series.
`void`	`setTimeSeriesLastUpdateDate(Date timeSeriesLastUpdateDate)` The date that the time series was last updated, in Unix epoch time.
`String`	`toString()` Returns a string representation of this object.
`TimeSeriesSummary`	`withAlias(String alias)` The alias that identifies the time series.
`TimeSeriesSummary`	`withAssetId(String assetId)` The ID of the asset in which the asset property was created.
`TimeSeriesSummary`	`withDataType(PropertyDataType dataType)` The data type of the time series.
`TimeSeriesSummary`	`withDataType(String dataType)` The data type of the time series.
`TimeSeriesSummary`	`withDataTypeSpec(String dataTypeSpec)` The data type of the structure for this time series.
`TimeSeriesSummary`	`withPropertyId(String propertyId)` The ID of the asset property, in UUID format.
`TimeSeriesSummary`	`withTimeSeriesArn(String timeSeriesArn)` The ARN of the time series, which has the following format.
`TimeSeriesSummary`	`withTimeSeriesCreationDate(Date timeSeriesCreationDate)` The date that the time series was created, in Unix epoch time.
`TimeSeriesSummary`	`withTimeSeriesId(String timeSeriesId)` The ID of the time series.
`TimeSeriesSummary`	`withTimeSeriesLastUpdateDate(Date timeSeriesLastUpdateDate)` The date that the time series was last updated, in Unix epoch time.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TimeSeriesSummary
```
public TimeSeriesSummary()
```
- Method Detail
  - setAssetId
```
public void setAssetId(String assetId)
```
    The ID of the asset in which the asset property was created.
    
    Parameters:
    
    assetId - The ID of the asset in which the asset property was created.
  - getAssetId
```
public String getAssetId()
```
    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.
  - withAssetId
```
public TimeSeriesSummary withAssetId(String assetId)
```
    The ID of the asset in which the asset property was created.
    
    Parameters:
    
    assetId - The ID of the asset in which the asset property was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPropertyId
```
public void setPropertyId(String propertyId)
```
    The ID of the asset property, in UUID format.
    
    Parameters:
    
    propertyId - The ID of the asset property, in UUID format.
  - getPropertyId
```
public String getPropertyId()
```
    The ID of the asset property, in UUID format.
    
    Returns:
    
    The ID of the asset property, in UUID format.
  - withPropertyId
```
public TimeSeriesSummary withPropertyId(String propertyId)
```
    The ID of the asset property, in UUID format.
    
    Parameters:
    
    propertyId - The ID of the asset property, in UUID format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlias
```
public void setAlias(String alias)
```
    The alias that identifies the time series.
    
    Parameters:
    
    alias - The alias that identifies the time series.
  - getAlias
```
public String getAlias()
```
    The alias that identifies the time series.
    
    Returns:
    
    The alias that identifies the time series.
  - withAlias
```
public TimeSeriesSummary withAlias(String alias)
```
    The alias that identifies the time series.
    
    Parameters:
    
    alias - The alias that identifies the time series.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeSeriesId
```
public void setTimeSeriesId(String timeSeriesId)
```
    The ID of the time series.
    
    Parameters:
    
    timeSeriesId - The ID of the time series.
  - getTimeSeriesId
```
public String getTimeSeriesId()
```
    The ID of the time series.
    
    Returns:
    
    The ID of the time series.
  - withTimeSeriesId
```
public TimeSeriesSummary withTimeSeriesId(String timeSeriesId)
```
    The ID of the time series.
    
    Parameters:
    
    timeSeriesId - The ID of the time series.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataType
```
public void setDataType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    PropertyDataType
  - getDataType
```
public String getDataType()
```
    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.
    
    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
  - withDataType
```
public TimeSeriesSummary withDataType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyDataType
  - withDataType
```
public TimeSeriesSummary withDataType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropertyDataType
  - setDataTypeSpec
```
public void setDataTypeSpec(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.
    
    Parameters:
    
    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.
  - getDataTypeSpec
```
public String getDataTypeSpec()
```
    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.
  - withDataTypeSpec
```
public TimeSeriesSummary withDataTypeSpec(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeSeriesCreationDate
```
public void setTimeSeriesCreationDate(Date timeSeriesCreationDate)
```
    The date that the time series was created, in Unix epoch time.
    
    Parameters:
    
    timeSeriesCreationDate - The date that the time series was created, in Unix epoch time.
  - getTimeSeriesCreationDate
```
public Date getTimeSeriesCreationDate()
```
    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.
  - withTimeSeriesCreationDate
```
public TimeSeriesSummary withTimeSeriesCreationDate(Date timeSeriesCreationDate)
```
    The date that the time series was created, in Unix epoch time.
    
    Parameters:
    
    timeSeriesCreationDate - The date that the time series was created, in Unix epoch time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeSeriesLastUpdateDate
```
public void setTimeSeriesLastUpdateDate(Date timeSeriesLastUpdateDate)
```
    The date that the time series was last updated, in Unix epoch time.
    
    Parameters:
    
    timeSeriesLastUpdateDate - The date that the time series was last updated, in Unix epoch time.
  - getTimeSeriesLastUpdateDate
```
public Date getTimeSeriesLastUpdateDate()
```
    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.
  - withTimeSeriesLastUpdateDate
```
public TimeSeriesSummary withTimeSeriesLastUpdateDate(Date timeSeriesLastUpdateDate)
```
    The date that the time series was last updated, in Unix epoch time.
    
    Parameters:
    
    timeSeriesLastUpdateDate - The date that the time series was last updated, in Unix epoch time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeSeriesArn
```
public void setTimeSeriesArn(String timeSeriesArn)
```
    The ARN of the time series, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
    
    Parameters:
    
    timeSeriesArn - The ARN of the time series, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
  - getTimeSeriesArn
```
public String getTimeSeriesArn()
```
    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}
  - withTimeSeriesArn
```
public TimeSeriesSummary withTimeSeriesArn(String timeSeriesArn)
```
    The ARN of the time series, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
    
    Parameters:
    
    timeSeriesArn - The ARN of the time series, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TimeSeriesSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class TimeSeriesSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TimeSeriesSummary

Method Detail

setAssetId

getAssetId

withAssetId

setPropertyId

getPropertyId

withPropertyId

setAlias

getAlias

withAlias

setTimeSeriesId

getTimeSeriesId

withTimeSeriesId

setDataType

getDataType

withDataType

withDataType

setDataTypeSpec

getDataTypeSpec

withDataTypeSpec

setTimeSeriesCreationDate

getTimeSeriesCreationDate

withTimeSeriesCreationDate

setTimeSeriesLastUpdateDate

getTimeSeriesLastUpdateDate

withTimeSeriesLastUpdateDate

setTimeSeriesArn

getTimeSeriesArn

withTimeSeriesArn

toString

equals

hashCode

clone

marshall