software.amazon.awssdk.services.iotsitewise.model

Interface GetAssetPropertyAggregatesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetAssetPropertyAggregatesRequest.Builder,GetAssetPropertyAggregatesRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<GetAssetPropertyAggregatesRequest.Builder,GetAssetPropertyAggregatesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetAssetPropertyAggregatesRequest

public static interface GetAssetPropertyAggregatesRequest.Builder
extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<GetAssetPropertyAggregatesRequest.Builder,GetAssetPropertyAggregatesRequest>

Method Summary

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

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

assetId

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

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

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

aggregateTypesWithStrings

GetAssetPropertyAggregatesRequest.Builder aggregateTypesWithStrings(Collection<String> aggregateTypes)

The data aggregating function.

Parameters:

aggregateTypes - The data aggregating function.

Returns:

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

aggregateTypesWithStrings

GetAssetPropertyAggregatesRequest.Builder aggregateTypesWithStrings(String... aggregateTypes)

The data aggregating function.

Parameters:

aggregateTypes - The data aggregating function.

Returns:

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

aggregateTypes

GetAssetPropertyAggregatesRequest.Builder aggregateTypes(Collection<AggregateType> aggregateTypes)

The data aggregating function.

Parameters:

aggregateTypes - The data aggregating function.

Returns:

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

aggregateTypes

GetAssetPropertyAggregatesRequest.Builder aggregateTypes(AggregateType... aggregateTypes)

The data aggregating function.

Parameters:

aggregateTypes - The data aggregating function.

Returns:

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

resolution

GetAssetPropertyAggregatesRequest.Builder resolution(String resolution)

The time interval over which to aggregate data.

Parameters:

resolution - The time interval over which to aggregate data.

Returns:

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

qualitiesWithStrings

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

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

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

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

startDate

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

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

timeOrdering

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

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

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

GetAssetPropertyAggregatesRequest.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 1 MB.

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

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 1 MB.

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

Returns:

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

overrideConfiguration

GetAssetPropertyAggregatesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder