Package software.amazon.awssdk.services.iotsitewise.model

Interface DescribeTimeSeriesResponse.Builder

    • Method Detail

      • assetId

        DescribeTimeSeriesResponse.Builder assetId​(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.

      • propertyId

        DescribeTimeSeriesResponse.Builder propertyId​(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.

      • alias

        DescribeTimeSeriesResponse.Builder alias​(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.

      • timeSeriesId

        DescribeTimeSeriesResponse.Builder timeSeriesId​(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.

      • dataType

        DescribeTimeSeriesResponse.Builder dataType​(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, PropertyDataType

      • dataType

        DescribeTimeSeriesResponse.Builder dataType​(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, PropertyDataType

      • dataTypeSpec

        DescribeTimeSeriesResponse.Builder dataTypeSpec​(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.

      • timeSeriesCreationDate

        DescribeTimeSeriesResponse.Builder timeSeriesCreationDate​(Instant 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

        DescribeTimeSeriesResponse.Builder timeSeriesLastUpdateDate​(Instant 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

        DescribeTimeSeriesResponse.Builder timeSeriesArn​(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.