Interface DescribeTimeSeriesResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeTimeSeriesResponse.Builder,
,DescribeTimeSeriesResponse> IoTSiteWiseResponse.Builder
,SdkBuilder<DescribeTimeSeriesResponse.Builder,
,DescribeTimeSeriesResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeTimeSeriesResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe alias that identifies the time series.The ID of the asset in which the asset property was created.The data type of the time series.dataType
(PropertyDataType dataType) The data type of the time series.dataTypeSpec
(String dataTypeSpec) The data type of the structure for this time series.propertyId
(String propertyId) The ID of the asset property, in UUID format.timeSeriesArn
(String timeSeriesArn) The ARN of the time series, which has the following format.timeSeriesCreationDate
(Instant timeSeriesCreationDate) The date that the time series was created, in Unix epoch time.timeSeriesId
(String timeSeriesId) The ID of the time series.timeSeriesLastUpdateDate
(Instant timeSeriesLastUpdateDate) The date that the time series was last updated, in Unix epoch time.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
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.
-
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.
-
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.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
dataTypeSpec
- The data type of the structure for this time series. This parameter is required for time series that have theSTRUCT
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.
-
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.
-
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.
-
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.
-