Interface DescribeTimeSeriesResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeTimeSeriesResponse.Builder,DescribeTimeSeriesResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<DescribeTimeSeriesResponse.Builder,DescribeTimeSeriesResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeTimeSeriesResponse

public static interface DescribeTimeSeriesResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribeTimeSeriesResponse.Builder,DescribeTimeSeriesResponse>
  • 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

      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

      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:
    • 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:
    • 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.