/* * 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.location.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 GetDevicePositionHistoryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The device whose position history you want to retrieve. *
*/ private String deviceId; /** *
* Specify the end time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be the time that the request is made.
*
* Requirement: *
*
* The time specified for EndTimeExclusive
must be after the time for StartTimeInclusive
.
*
* An optional limit for the number of device positions returned in a single call. *
*
* Default value: 100
*
* The pagination token specifying which page of results to return in the response. If no token is provided, the * default page is the first page. *
*
* Default value: null
*
* Specify the start time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours prior to the time that the request
* is made.
*
* Requirement: *
*
* The time specified for StartTimeInclusive
must be before EndTimeExclusive
.
*
* The tracker resource receiving the request for the device position history. *
*/ private String trackerName; /** ** The device whose position history you want to retrieve. *
* * @param deviceId * The device whose position history you want to retrieve. */ public void setDeviceId(String deviceId) { this.deviceId = deviceId; } /** ** The device whose position history you want to retrieve. *
* * @return The device whose position history you want to retrieve. */ public String getDeviceId() { return this.deviceId; } /** ** The device whose position history you want to retrieve. *
* * @param deviceId * The device whose position history you want to retrieve. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDevicePositionHistoryRequest withDeviceId(String deviceId) { setDeviceId(deviceId); return this; } /** *
* Specify the end time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be the time that the request is made.
*
* Requirement: *
*
* The time specified for EndTimeExclusive
must be after the time for StartTimeInclusive
.
*
YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be the time that the request is
* made.
* * Requirement: *
*
* The time specified for EndTimeExclusive
must be after the time for
* StartTimeInclusive
.
*
* Specify the end time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be the time that the request is made.
*
* Requirement: *
*
* The time specified for EndTimeExclusive
must be after the time for StartTimeInclusive
.
*
YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be the time that the request is
* made.
* * Requirement: *
*
* The time specified for EndTimeExclusive
must be after the time for
* StartTimeInclusive
.
*
* Specify the end time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be the time that the request is made.
*
* Requirement: *
*
* The time specified for EndTimeExclusive
must be after the time for StartTimeInclusive
.
*
YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be the time that the request is
* made.
* * Requirement: *
*
* The time specified for EndTimeExclusive
must be after the time for
* StartTimeInclusive
.
*
* An optional limit for the number of device positions returned in a single call. *
*
* Default value: 100
*
* Default value: 100
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* An optional limit for the number of device positions returned in a single call. *
*
* Default value: 100
*
* Default value: 100
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* An optional limit for the number of device positions returned in a single call. *
*
* Default value: 100
*
* Default value: 100
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDevicePositionHistoryRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The pagination token specifying which page of results to return in the response. If no token is provided, the * default page is the first page. *
*
* Default value: null
*
* Default value: null
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The pagination token specifying which page of results to return in the response. If no token is provided, the * default page is the first page. *
*
* Default value: null
*
* Default value: null
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The pagination token specifying which page of results to return in the response. If no token is provided, the * default page is the first page. *
*
* Default value: null
*
* Default value: null
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDevicePositionHistoryRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Specify the start time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours prior to the time that the request
* is made.
*
* Requirement: *
*
* The time specified for StartTimeInclusive
must be before EndTimeExclusive
.
*
YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours prior to the time that the
* request is made.
* * Requirement: *
*
* The time specified for StartTimeInclusive
must be before EndTimeExclusive
.
*
* Specify the start time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours prior to the time that the request
* is made.
*
* Requirement: *
*
* The time specified for StartTimeInclusive
must be before EndTimeExclusive
.
*
YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours prior to the time that the
* request is made.
* * Requirement: *
*
* The time specified for StartTimeInclusive
must be before EndTimeExclusive
.
*
* Specify the start time for the position history in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours prior to the time that the request
* is made.
*
* Requirement: *
*
* The time specified for StartTimeInclusive
must be before EndTimeExclusive
.
*
YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours prior to the time that the
* request is made.
* * Requirement: *
*
* The time specified for StartTimeInclusive
must be before EndTimeExclusive
.
*
* The tracker resource receiving the request for the device position history. *
* * @param trackerName * The tracker resource receiving the request for the device position history. */ public void setTrackerName(String trackerName) { this.trackerName = trackerName; } /** ** The tracker resource receiving the request for the device position history. *
* * @return The tracker resource receiving the request for the device position history. */ public String getTrackerName() { return this.trackerName; } /** ** The tracker resource receiving the request for the device position history. *
* * @param trackerName * The tracker resource receiving the request for the device position history. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDevicePositionHistoryRequest withTrackerName(String trackerName) { setTrackerName(trackerName); 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 (getDeviceId() != null) sb.append("DeviceId: ").append(getDeviceId()).append(","); if (getEndTimeExclusive() != null) sb.append("EndTimeExclusive: ").append(getEndTimeExclusive()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()).append(","); if (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()).append(","); if (getStartTimeInclusive() != null) sb.append("StartTimeInclusive: ").append(getStartTimeInclusive()).append(","); if (getTrackerName() != null) sb.append("TrackerName: ").append(getTrackerName()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetDevicePositionHistoryRequest == false) return false; GetDevicePositionHistoryRequest other = (GetDevicePositionHistoryRequest) obj; if (other.getDeviceId() == null ^ this.getDeviceId() == null) return false; if (other.getDeviceId() != null && other.getDeviceId().equals(this.getDeviceId()) == false) return false; if (other.getEndTimeExclusive() == null ^ this.getEndTimeExclusive() == null) return false; if (other.getEndTimeExclusive() != null && other.getEndTimeExclusive().equals(this.getEndTimeExclusive()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == 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.getStartTimeInclusive() == null ^ this.getStartTimeInclusive() == null) return false; if (other.getStartTimeInclusive() != null && other.getStartTimeInclusive().equals(this.getStartTimeInclusive()) == false) return false; if (other.getTrackerName() == null ^ this.getTrackerName() == null) return false; if (other.getTrackerName() != null && other.getTrackerName().equals(this.getTrackerName()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDeviceId() == null) ? 0 : getDeviceId().hashCode()); hashCode = prime * hashCode + ((getEndTimeExclusive() == null) ? 0 : getEndTimeExclusive().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getStartTimeInclusive() == null) ? 0 : getStartTimeInclusive().hashCode()); hashCode = prime * hashCode + ((getTrackerName() == null) ? 0 : getTrackerName().hashCode()); return hashCode; } @Override public GetDevicePositionHistoryRequest clone() { return (GetDevicePositionHistoryRequest) super.clone(); } }