/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.iotsitewise.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetAssetPropertyValueHistoryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The ID of the asset. *

*/ private String assetId; /** *

* The ID of the asset property. *

*/ private String propertyId; /** *

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

*/ private String propertyAlias; /** *

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

*/ private java.util.Date startDate; /** *

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

*/ private java.util.Date endDate; /** *

* The quality by which to filter asset data. *

*/ private java.util.List qualities; /** *

* The chronological sorting order of the requested information. *

*

* Default: ASCENDING *

*/ private String timeOrdering; /** *

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

*/ private String nextToken; /** *

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

* */ private Integer maxResults; /** *

* The ID of the asset. *

* * @param assetId * The ID of the asset. */ public void setAssetId(String assetId) { this.assetId = assetId; } /** *

* The ID of the asset. *

* * @return The ID of the asset. */ public String getAssetId() { return this.assetId; } /** *

* The ID of the asset. *

* * @param assetId * The ID of the asset. * @return Returns a reference to this object so that method calls can be chained together. */ public GetAssetPropertyValueHistoryRequest withAssetId(String assetId) { setAssetId(assetId); return this; } /** *

* The ID of the asset property. *

* * @param propertyId * The ID of the asset property. */ public void setPropertyId(String propertyId) { this.propertyId = propertyId; } /** *

* The ID of the asset property. *

* * @return The ID of the asset property. */ public String getPropertyId() { return this.propertyId; } /** *

* The ID of the asset property. *

* * @param propertyId * The ID of the asset property. * @return Returns a reference to this object so that method calls can be chained together. */ public GetAssetPropertyValueHistoryRequest withPropertyId(String propertyId) { setPropertyId(propertyId); return this; } /** *

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

* * @param 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. */ public void setPropertyAlias(String propertyAlias) { this.propertyAlias = 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. *

* * @return 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. */ public String getPropertyAlias() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GetAssetPropertyValueHistoryRequest withPropertyAlias(String propertyAlias) { setPropertyAlias(propertyAlias); return this; } /** *

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

* * @param startDate * The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch * time. */ public void setStartDate(java.util.Date startDate) { this.startDate = startDate; } /** *

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

* * @return The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch * time. */ public java.util.Date getStartDate() { return this.startDate; } /** *

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

* * @param startDate * The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch * time. * @return Returns a reference to this object so that method calls can be chained together. */ public GetAssetPropertyValueHistoryRequest withStartDate(java.util.Date startDate) { setStartDate(startDate); return this; } /** *

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

* * @param endDate * The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch * time. */ public void setEndDate(java.util.Date endDate) { this.endDate = endDate; } /** *

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

* * @return The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch * time. */ public java.util.Date getEndDate() { return this.endDate; } /** *

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

* * @param endDate * The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch * time. * @return Returns a reference to this object so that method calls can be chained together. */ public GetAssetPropertyValueHistoryRequest withEndDate(java.util.Date endDate) { setEndDate(endDate); return this; } /** *

* The quality by which to filter asset data. *

* * @return The quality by which to filter asset data. * @see Quality */ public java.util.List getQualities() { return qualities; } /** *

* The quality by which to filter asset data. *

* * @param qualities * The quality by which to filter asset data. * @see Quality */ public void setQualities(java.util.Collection qualities) { if (qualities == null) { this.qualities = null; return; } this.qualities = new java.util.ArrayList(qualities); } /** *

* The quality by which to filter asset data. *

*

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

* * @param qualities * The quality by which to filter asset data. * @return Returns a reference to this object so that method calls can be chained together. * @see Quality */ public GetAssetPropertyValueHistoryRequest withQualities(String... qualities) { if (this.qualities == null) { setQualities(new java.util.ArrayList(qualities.length)); } for (String ele : qualities) { this.qualities.add(ele); } return this; } /** *

* The quality by which to filter asset data. *

* * @param qualities * The quality by which to filter asset data. * @return Returns a reference to this object so that method calls can be chained together. * @see Quality */ public GetAssetPropertyValueHistoryRequest withQualities(java.util.Collection qualities) { setQualities(qualities); return this; } /** *

* The quality by which to filter asset data. *

* * @param qualities * The quality by which to filter asset data. * @return Returns a reference to this object so that method calls can be chained together. * @see Quality */ public GetAssetPropertyValueHistoryRequest withQualities(Quality... qualities) { java.util.ArrayList qualitiesCopy = new java.util.ArrayList(qualities.length); for (Quality value : qualities) { qualitiesCopy.add(value.toString()); } if (getQualities() == null) { setQualities(qualitiesCopy); } else { getQualities().addAll(qualitiesCopy); } return this; } /** *

* The chronological sorting order of the requested information. *

*

* Default: ASCENDING *

* * @param timeOrdering * The chronological sorting order of the requested information.

*

* Default: ASCENDING * @see TimeOrdering */ public void setTimeOrdering(String timeOrdering) { this.timeOrdering = timeOrdering; } /** *

* The chronological sorting order of the requested information. *

*

* Default: ASCENDING *

* * @return The chronological sorting order of the requested information.

*

* Default: ASCENDING * @see TimeOrdering */ public String getTimeOrdering() { return this.timeOrdering; } /** *

* The chronological sorting order of the requested information. *

*

* Default: ASCENDING *

* * @param timeOrdering * The chronological sorting order of the requested information.

*

* Default: ASCENDING * @return Returns a reference to this object so that method calls can be chained together. * @see TimeOrdering */ public GetAssetPropertyValueHistoryRequest withTimeOrdering(String timeOrdering) { setTimeOrdering(timeOrdering); return this; } /** *

* The chronological sorting order of the requested information. *

*

* Default: ASCENDING *

* * @param timeOrdering * The chronological sorting order of the requested information.

*

* Default: ASCENDING * @return Returns a reference to this object so that method calls can be chained together. * @see TimeOrdering */ public GetAssetPropertyValueHistoryRequest withTimeOrdering(TimeOrdering timeOrdering) { this.timeOrdering = timeOrdering.toString(); return this; } /** *

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

* * @param nextToken * The token to be used for the next set of paginated results. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

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

* * @return The token to be used for the next set of paginated results. */ public String getNextToken() { return this.nextToken; } /** *

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

* * @param nextToken * The token to be used for the next set of paginated results. * @return Returns a reference to this object so that method calls can be chained together. */ public GetAssetPropertyValueHistoryRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** *

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

    *
    • *
* * @param 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. *

    *
    • */ public void setMaxResults(Integer maxResults) { this.maxResults = 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. *

      *
      • *
    * * @return 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. *

      *
      • */ public Integer getMaxResults() { return this.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. *

        *
        • *
      * * @param 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. *

        *
        • * @return Returns a reference to this object so that method calls can be chained together. */ public GetAssetPropertyValueHistoryRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAssetId() != null) sb.append("AssetId: ").append(getAssetId()).append(","); if (getPropertyId() != null) sb.append("PropertyId: ").append(getPropertyId()).append(","); if (getPropertyAlias() != null) sb.append("PropertyAlias: ").append(getPropertyAlias()).append(","); if (getStartDate() != null) sb.append("StartDate: ").append(getStartDate()).append(","); if (getEndDate() != null) sb.append("EndDate: ").append(getEndDate()).append(","); if (getQualities() != null) sb.append("Qualities: ").append(getQualities()).append(","); if (getTimeOrdering() != null) sb.append("TimeOrdering: ").append(getTimeOrdering()).append(","); if (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetAssetPropertyValueHistoryRequest == false) return false; GetAssetPropertyValueHistoryRequest other = (GetAssetPropertyValueHistoryRequest) obj; if (other.getAssetId() == null ^ this.getAssetId() == null) return false; if (other.getAssetId() != null && other.getAssetId().equals(this.getAssetId()) == false) return false; if (other.getPropertyId() == null ^ this.getPropertyId() == null) return false; if (other.getPropertyId() != null && other.getPropertyId().equals(this.getPropertyId()) == false) return false; if (other.getPropertyAlias() == null ^ this.getPropertyAlias() == null) return false; if (other.getPropertyAlias() != null && other.getPropertyAlias().equals(this.getPropertyAlias()) == false) return false; if (other.getStartDate() == null ^ this.getStartDate() == null) return false; if (other.getStartDate() != null && other.getStartDate().equals(this.getStartDate()) == false) return false; if (other.getEndDate() == null ^ this.getEndDate() == null) return false; if (other.getEndDate() != null && other.getEndDate().equals(this.getEndDate()) == false) return false; if (other.getQualities() == null ^ this.getQualities() == null) return false; if (other.getQualities() != null && other.getQualities().equals(this.getQualities()) == false) return false; if (other.getTimeOrdering() == null ^ this.getTimeOrdering() == null) return false; if (other.getTimeOrdering() != null && other.getTimeOrdering().equals(this.getTimeOrdering()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAssetId() == null) ? 0 : getAssetId().hashCode()); hashCode = prime * hashCode + ((getPropertyId() == null) ? 0 : getPropertyId().hashCode()); hashCode = prime * hashCode + ((getPropertyAlias() == null) ? 0 : getPropertyAlias().hashCode()); hashCode = prime * hashCode + ((getStartDate() == null) ? 0 : getStartDate().hashCode()); hashCode = prime * hashCode + ((getEndDate() == null) ? 0 : getEndDate().hashCode()); hashCode = prime * hashCode + ((getQualities() == null) ? 0 : getQualities().hashCode()); hashCode = prime * hashCode + ((getTimeOrdering() == null) ? 0 : getTimeOrdering().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); return hashCode; } @Override public GetAssetPropertyValueHistoryRequest clone() { return (GetAssetPropertyValueHistoryRequest) super.clone(); } }