com.amazonaws.services.location.model.ForecastGeofenceEventsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location Show documentation
/*
* Copyright 2019-2024 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 ForecastGeofenceEventsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the geofence collection.
*
*/
private String collectionName;
/**
*
* The device's state, including current position and speed.
*
*/
private ForecastGeofenceEventsDeviceState deviceState;
/**
*
* Specifies the time horizon in minutes for the forecasted events.
*
*/
private Double timeHorizonMinutes;
/**
*
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
*
* Default Value: Kilometers
*
*/
private String distanceUnit;
/**
*
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
*
* Default Value: KilometersPerHour.
*
*/
private String speedUnit;
/**
*
* 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
*
*/
private String nextToken;
/**
*
* An optional limit for the number of resources returned in a single call.
*
*
* Default value: 20
*
*/
private Integer maxResults;
/**
*
* The name of the geofence collection.
*
*
* @param collectionName
* The name of the geofence collection.
*/
public void setCollectionName(String collectionName) {
this.collectionName = collectionName;
}
/**
*
* The name of the geofence collection.
*
*
* @return The name of the geofence collection.
*/
public String getCollectionName() {
return this.collectionName;
}
/**
*
* The name of the geofence collection.
*
*
* @param collectionName
* The name of the geofence collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForecastGeofenceEventsRequest withCollectionName(String collectionName) {
setCollectionName(collectionName);
return this;
}
/**
*
* The device's state, including current position and speed.
*
*
* @param deviceState
* The device's state, including current position and speed.
*/
public void setDeviceState(ForecastGeofenceEventsDeviceState deviceState) {
this.deviceState = deviceState;
}
/**
*
* The device's state, including current position and speed.
*
*
* @return The device's state, including current position and speed.
*/
public ForecastGeofenceEventsDeviceState getDeviceState() {
return this.deviceState;
}
/**
*
* The device's state, including current position and speed.
*
*
* @param deviceState
* The device's state, including current position and speed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForecastGeofenceEventsRequest withDeviceState(ForecastGeofenceEventsDeviceState deviceState) {
setDeviceState(deviceState);
return this;
}
/**
*
* Specifies the time horizon in minutes for the forecasted events.
*
*
* @param timeHorizonMinutes
* Specifies the time horizon in minutes for the forecasted events.
*/
public void setTimeHorizonMinutes(Double timeHorizonMinutes) {
this.timeHorizonMinutes = timeHorizonMinutes;
}
/**
*
* Specifies the time horizon in minutes for the forecasted events.
*
*
* @return Specifies the time horizon in minutes for the forecasted events.
*/
public Double getTimeHorizonMinutes() {
return this.timeHorizonMinutes;
}
/**
*
* Specifies the time horizon in minutes for the forecasted events.
*
*
* @param timeHorizonMinutes
* Specifies the time horizon in minutes for the forecasted events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForecastGeofenceEventsRequest withTimeHorizonMinutes(Double timeHorizonMinutes) {
setTimeHorizonMinutes(timeHorizonMinutes);
return this;
}
/**
*
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
*
* Default Value: Kilometers
*
*
* @param distanceUnit
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
* Default Value: Kilometers
* @see DistanceUnit
*/
public void setDistanceUnit(String distanceUnit) {
this.distanceUnit = distanceUnit;
}
/**
*
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
*
* Default Value: Kilometers
*
*
* @return The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
* Default Value: Kilometers
* @see DistanceUnit
*/
public String getDistanceUnit() {
return this.distanceUnit;
}
/**
*
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
*
* Default Value: Kilometers
*
*
* @param distanceUnit
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
* Default Value: Kilometers
* @return Returns a reference to this object so that method calls can be chained together.
* @see DistanceUnit
*/
public ForecastGeofenceEventsRequest withDistanceUnit(String distanceUnit) {
setDistanceUnit(distanceUnit);
return this;
}
/**
*
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
*
* Default Value: Kilometers
*
*
* @param distanceUnit
* The distance unit used for the NearestDistance property returned in a forecasted event. The
* measurement system must match for DistanceUnit and SpeedUnit; if
* Kilometers is specified for DistanceUnit, then SpeedUnit must be
* KilometersPerHour.
*
* Default Value: Kilometers
* @return Returns a reference to this object so that method calls can be chained together.
* @see DistanceUnit
*/
public ForecastGeofenceEventsRequest withDistanceUnit(DistanceUnit distanceUnit) {
this.distanceUnit = distanceUnit.toString();
return this;
}
/**
*
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
*
* Default Value: KilometersPerHour.
*
*
* @param speedUnit
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
* Default Value: KilometersPerHour.
* @see SpeedUnit
*/
public void setSpeedUnit(String speedUnit) {
this.speedUnit = speedUnit;
}
/**
*
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
*
* Default Value: KilometersPerHour.
*
*
* @return The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
* Default Value: KilometersPerHour.
* @see SpeedUnit
*/
public String getSpeedUnit() {
return this.speedUnit;
}
/**
*
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
*
* Default Value: KilometersPerHour.
*
*
* @param speedUnit
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
* Default Value: KilometersPerHour.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpeedUnit
*/
public ForecastGeofenceEventsRequest withSpeedUnit(String speedUnit) {
setSpeedUnit(speedUnit);
return this;
}
/**
*
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
*
* Default Value: KilometersPerHour.
*
*
* @param speedUnit
* The speed unit for the device captured by the device state. The measurement system must match for
* DistanceUnit and SpeedUnit; if Kilometers is specified for
* DistanceUnit, then SpeedUnit must be KilometersPerHour.
*
* Default Value: KilometersPerHour.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpeedUnit
*/
public ForecastGeofenceEventsRequest withSpeedUnit(SpeedUnit speedUnit) {
this.speedUnit = speedUnit.toString();
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
*
*
* @param 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
*/
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
*
*
* @return 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
*/
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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForecastGeofenceEventsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* An optional limit for the number of resources returned in a single call.
*
*
* Default value: 20
*
*
* @param maxResults
* An optional limit for the number of resources returned in a single call.
*
* Default value: 20
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* An optional limit for the number of resources returned in a single call.
*
*
* Default value: 20
*
*
* @return An optional limit for the number of resources returned in a single call.
*
* Default value: 20
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* An optional limit for the number of resources returned in a single call.
*
*
* Default value: 20
*
*
* @param maxResults
* An optional limit for the number of resources returned in a single call.
*
* Default value: 20
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForecastGeofenceEventsRequest 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 (getCollectionName() != null)
sb.append("CollectionName: ").append(getCollectionName()).append(",");
if (getDeviceState() != null)
sb.append("DeviceState: ").append(getDeviceState()).append(",");
if (getTimeHorizonMinutes() != null)
sb.append("TimeHorizonMinutes: ").append(getTimeHorizonMinutes()).append(",");
if (getDistanceUnit() != null)
sb.append("DistanceUnit: ").append(getDistanceUnit()).append(",");
if (getSpeedUnit() != null)
sb.append("SpeedUnit: ").append(getSpeedUnit()).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 ForecastGeofenceEventsRequest == false)
return false;
ForecastGeofenceEventsRequest other = (ForecastGeofenceEventsRequest) obj;
if (other.getCollectionName() == null ^ this.getCollectionName() == null)
return false;
if (other.getCollectionName() != null && other.getCollectionName().equals(this.getCollectionName()) == false)
return false;
if (other.getDeviceState() == null ^ this.getDeviceState() == null)
return false;
if (other.getDeviceState() != null && other.getDeviceState().equals(this.getDeviceState()) == false)
return false;
if (other.getTimeHorizonMinutes() == null ^ this.getTimeHorizonMinutes() == null)
return false;
if (other.getTimeHorizonMinutes() != null && other.getTimeHorizonMinutes().equals(this.getTimeHorizonMinutes()) == false)
return false;
if (other.getDistanceUnit() == null ^ this.getDistanceUnit() == null)
return false;
if (other.getDistanceUnit() != null && other.getDistanceUnit().equals(this.getDistanceUnit()) == false)
return false;
if (other.getSpeedUnit() == null ^ this.getSpeedUnit() == null)
return false;
if (other.getSpeedUnit() != null && other.getSpeedUnit().equals(this.getSpeedUnit()) == 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 + ((getCollectionName() == null) ? 0 : getCollectionName().hashCode());
hashCode = prime * hashCode + ((getDeviceState() == null) ? 0 : getDeviceState().hashCode());
hashCode = prime * hashCode + ((getTimeHorizonMinutes() == null) ? 0 : getTimeHorizonMinutes().hashCode());
hashCode = prime * hashCode + ((getDistanceUnit() == null) ? 0 : getDistanceUnit().hashCode());
hashCode = prime * hashCode + ((getSpeedUnit() == null) ? 0 : getSpeedUnit().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public ForecastGeofenceEventsRequest clone() {
return (ForecastGeofenceEventsRequest) super.clone();
}
}