com.amazonaws.services.iotsitewise.model

Class GetAssetPropertyValueHistoryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotsitewise.model.GetAssetPropertyValueHistoryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetAssetPropertyValueHistoryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetAssetPropertyValueHistoryRequest()

Method Summary

Modifier and Type	Method and Description
GetAssetPropertyValueHistoryRequest	clone()
boolean	equals(Object obj)
String	getAssetId() The ID of the asset, in UUID format.
Date	getEndDate() The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
Integer	getMaxResults() The maximum number of results to return for each paginated request.
String	getNextToken() The token to be used for the next set of paginated results.
String	getPropertyAlias() The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature).
String	getPropertyId() The ID of the asset property, in UUID format.
List<String>	getQualities() The quality by which to filter asset data.
Date	getStartDate() The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
String	getTimeOrdering() The chronological sorting order of the requested information.
int	hashCode()
void	setAssetId(String assetId) The ID of the asset, in UUID format.
void	setEndDate(Date endDate) The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
void	setMaxResults(Integer maxResults) The maximum number of results to return for each paginated request.
void	setNextToken(String nextToken) The token to be used for the next set of paginated results.
void	setPropertyAlias(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).
void	setPropertyId(String propertyId) The ID of the asset property, in UUID format.
void	setQualities(Collection<String> qualities) The quality by which to filter asset data.
void	setStartDate(Date startDate) The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
void	setTimeOrdering(String timeOrdering) The chronological sorting order of the requested information.
String	toString() Returns a string representation of this object.
GetAssetPropertyValueHistoryRequest	withAssetId(String assetId) The ID of the asset, in UUID format.
GetAssetPropertyValueHistoryRequest	withEndDate(Date endDate) The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
GetAssetPropertyValueHistoryRequest	withMaxResults(Integer maxResults) The maximum number of results to return for each paginated request.
GetAssetPropertyValueHistoryRequest	withNextToken(String nextToken) The token to be used for the next set of paginated results.
GetAssetPropertyValueHistoryRequest	withPropertyAlias(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	withPropertyId(String propertyId) The ID of the asset property, in UUID format.
GetAssetPropertyValueHistoryRequest	withQualities(Collection<String> qualities) The quality by which to filter asset data.
GetAssetPropertyValueHistoryRequest	withQualities(Quality... qualities) The quality by which to filter asset data.
GetAssetPropertyValueHistoryRequest	withQualities(String... qualities) The quality by which to filter asset data.
GetAssetPropertyValueHistoryRequest	withStartDate(Date startDate) The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
GetAssetPropertyValueHistoryRequest	withTimeOrdering(String timeOrdering) The chronological sorting order of the requested information.
GetAssetPropertyValueHistoryRequest	withTimeOrdering(TimeOrdering timeOrdering) The chronological sorting order of the requested information.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetAssetPropertyValueHistoryRequest

public GetAssetPropertyValueHistoryRequest()

Method Detail

setAssetId

public void setAssetId(String assetId)

The ID of the asset, in UUID format.

Parameters:

assetId - The ID of the asset, in UUID format.

getAssetId

public String getAssetId()

The ID of the asset, in UUID format.

Returns:

The ID of the asset, in UUID format.

withAssetId

public GetAssetPropertyValueHistoryRequest withAssetId(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.

setPropertyId

public void setPropertyId(String propertyId)

The ID of the asset property, in UUID format.

Parameters:

propertyId - The ID of the asset property, in UUID format.

getPropertyId

public String getPropertyId()

The ID of the asset property, in UUID format.

Returns:

The ID of the asset property, in UUID format.

withPropertyId

public GetAssetPropertyValueHistoryRequest withPropertyId(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.

setPropertyAlias

public void setPropertyAlias(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.

getPropertyAlias

public String getPropertyAlias()

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:

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.

withPropertyAlias

public GetAssetPropertyValueHistoryRequest withPropertyAlias(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.

setStartDate

public void setStartDate(Date 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.

getStartDate

public Date getStartDate()

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

Returns:

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

withStartDate

public GetAssetPropertyValueHistoryRequest withStartDate(Date 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.

setEndDate

public void setEndDate(Date 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.

getEndDate

public Date getEndDate()

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

Returns:

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

withEndDate

public GetAssetPropertyValueHistoryRequest withEndDate(Date 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.

getQualities

public List<String> getQualities()

The quality by which to filter asset data.

Returns:

The quality by which to filter asset data.

See Also:

Quality

setQualities

public void setQualities(Collection<String> qualities)

The quality by which to filter asset data.

Parameters:

qualities - The quality by which to filter asset data.

See Also:

Quality

withQualities

public GetAssetPropertyValueHistoryRequest withQualities(String... qualities)

The quality by which to filter asset data.

NOTE: This method appends the values to the existing list (if any). Use setQualities(java.util.Collection) or withQualities(java.util.Collection) if you want to override the existing values.

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.

See Also:

Quality

withQualities

public GetAssetPropertyValueHistoryRequest withQualities(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.

See Also:

Quality

withQualities

public GetAssetPropertyValueHistoryRequest withQualities(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.

See Also:

Quality

setTimeOrdering

public void setTimeOrdering(String timeOrdering)

The chronological sorting order of the requested information.

Default: ASCENDING

Parameters:

timeOrdering - The chronological sorting order of the requested information.

Default: ASCENDING

See Also:

TimeOrdering

getTimeOrdering

public String getTimeOrdering()

The chronological sorting order of the requested information.

Default: ASCENDING

Returns:

The chronological sorting order of the requested information.

Default: ASCENDING

See Also:

TimeOrdering

withTimeOrdering

public GetAssetPropertyValueHistoryRequest withTimeOrdering(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

withTimeOrdering

public GetAssetPropertyValueHistoryRequest withTimeOrdering(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

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public GetAssetPropertyValueHistoryRequest withNextToken(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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:

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.

withMaxResults

public GetAssetPropertyValueHistoryRequest withMaxResults(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetAssetPropertyValueHistoryRequest clone()

Overrides:

clone in class AmazonWebServiceRequest