Interface GetAssetPropertyValueHistoryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetAssetPropertyValueHistoryRequest.Builder,GetAssetPropertyValueHistoryRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<GetAssetPropertyValueHistoryRequest.Builder,GetAssetPropertyValueHistoryRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetAssetPropertyValueHistoryRequest
public static interface GetAssetPropertyValueHistoryRequest.Builder extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<GetAssetPropertyValueHistoryRequest.Builder,GetAssetPropertyValueHistoryRequest>

  • Method Details

    • assetId

      GetAssetPropertyValueHistoryRequest.Builder assetId(String assetId)

      The ID of the asset, in UUID format.

      Parameters:
      assetId - The ID of the asset, in UUID format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propertyId

      GetAssetPropertyValueHistoryRequest.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.

    • propertyAlias

      GetAssetPropertyValueHistoryRequest.Builder propertyAlias(String propertyAlias)

      The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

      Parameters:
      propertyAlias - The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startDate

      GetAssetPropertyValueHistoryRequest.Builder startDate(Instant startDate)

      The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

      Parameters:
      startDate - The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endDate

      GetAssetPropertyValueHistoryRequest.Builder endDate(Instant endDate)

      The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

      Parameters:
      endDate - The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualitiesWithStrings

      GetAssetPropertyValueHistoryRequest.Builder qualitiesWithStrings(Collection<String> qualities)

      The quality by which to filter asset data.

      Parameters:
      qualities - The quality by which to filter asset data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualitiesWithStrings

      GetAssetPropertyValueHistoryRequest.Builder qualitiesWithStrings(String... qualities)

      The quality by which to filter asset data.

      Parameters:
      qualities - The quality by which to filter asset data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualities

      GetAssetPropertyValueHistoryRequest.Builder qualities(Collection<Quality> qualities)

      The quality by which to filter asset data.

      Parameters:
      qualities - The quality by which to filter asset data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualities

      GetAssetPropertyValueHistoryRequest.Builder qualities(Quality... qualities)

      The quality by which to filter asset data.

      Parameters:
      qualities - The quality by which to filter asset data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeOrdering

      GetAssetPropertyValueHistoryRequest.Builder timeOrdering(String timeOrdering)

      The chronological sorting order of the requested information.

      Default: ASCENDING

      Parameters:
      timeOrdering - The chronological sorting order of the requested information.

      Default: ASCENDING

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeOrdering

      GetAssetPropertyValueHistoryRequest.Builder timeOrdering(TimeOrdering timeOrdering)

      The chronological sorting order of the requested information.

      Default: ASCENDING

      Parameters:
      timeOrdering - The chronological sorting order of the requested information.

      Default: ASCENDING

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      GetAssetPropertyValueHistoryRequest.Builder nextToken(String nextToken)

      The token to be used for the next set of paginated results.

      Parameters:
      nextToken - The token to be used for the next set of paginated results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetAssetPropertyValueHistoryRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

      • The size of the result set is equal to 4 MB.

      • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.

      Parameters:
      maxResults - The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

      • The size of the result set is equal to 4 MB.

      • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetAssetPropertyValueHistoryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetAssetPropertyValueHistoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.