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

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 Summary

Modifier and Type	Method	Description
GetAssetPropertyValueHistoryRequest.Builder	assetId(String assetId)	The ID of the asset.
GetAssetPropertyValueHistoryRequest.Builder	endDate(Instant endDate)	The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
GetAssetPropertyValueHistoryRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return for each paginated request.
GetAssetPropertyValueHistoryRequest.Builder	nextToken(String nextToken)	The token to be used for the next set of paginated results.
GetAssetPropertyValueHistoryRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetAssetPropertyValueHistoryRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
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).
GetAssetPropertyValueHistoryRequest.Builder	propertyId(String propertyId)	The ID of the asset property.
GetAssetPropertyValueHistoryRequest.Builder	qualities(Collection<Quality> qualities)	The quality by which to filter asset data.
GetAssetPropertyValueHistoryRequest.Builder	qualities(Quality... qualities)	The quality by which to filter asset data.
GetAssetPropertyValueHistoryRequest.Builder	qualitiesWithStrings(String... qualities)	The quality by which to filter asset data.
GetAssetPropertyValueHistoryRequest.Builder	qualitiesWithStrings(Collection<String> qualities)	The quality by which to filter asset data.
GetAssetPropertyValueHistoryRequest.Builder	startDate(Instant startDate)	The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
GetAssetPropertyValueHistoryRequest.Builder	timeOrdering(String timeOrdering)	The chronological sorting order of the requested information.
GetAssetPropertyValueHistoryRequest.Builder	timeOrdering(TimeOrdering timeOrdering)	The chronological sorting order of the requested information.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

assetId

GetAssetPropertyValueHistoryRequest.Builder assetId(String assetId)

The ID of the asset.

Parameters:

assetId - The ID of the asset.

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.

Parameters:

propertyId - The ID of the asset property.

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, TimeOrdering

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:

TimeOrdering, TimeOrdering

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetAssetPropertyValueHistoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder