com.amazonaws.services.location.model.ForecastGeofenceEventsResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-location Show documentation
The AWS Java SDK for Amazon Location module holds the client classes that are used for communicating with Amazon Location Service
The newest version!
/*
 * 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;

/**
 * 
 * @see AWS
 *      API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ForecastGeofenceEventsResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {

    /**
     * 
     * The list of forecasted events.
     * 
     */
    private java.util.List forecastedEvents;
    /**
     * 
     * 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.
     * 
     */
    private String nextToken;
    /**
     * 
     * The distance unit for the forecasted events.
     * 
     */
    private String distanceUnit;
    /**
     * 
     * The speed unit for the forecasted events.
     * 
     */
    private String speedUnit;

    /**
     * 
     * The list of forecasted events.
     * 
     * 
     * @return The list of forecasted events.
     */

    public java.util.List getForecastedEvents() {
        return forecastedEvents;
    }

    /**
     * 
     * The list of forecasted events.
     * 
     * 
     * @param forecastedEvents
     *        The list of forecasted events.
     */

    public void setForecastedEvents(java.util.Collection forecastedEvents) {
        if (forecastedEvents == null) {
            this.forecastedEvents = null;
            return;
        }

        this.forecastedEvents = new java.util.ArrayList(forecastedEvents);
    }

    /**
     * 
     * The list of forecasted events.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setForecastedEvents(java.util.Collection)} or {@link #withForecastedEvents(java.util.Collection)} if you
     * want to override the existing values.
     * 
     * 
     * @param forecastedEvents
     *        The list of forecasted events.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ForecastGeofenceEventsResult withForecastedEvents(ForecastedEvent... forecastedEvents) {
        if (this.forecastedEvents == null) {
            setForecastedEvents(new java.util.ArrayList(forecastedEvents.length));
        }
        for (ForecastedEvent ele : forecastedEvents) {
            this.forecastedEvents.add(ele);
        }
        return this;
    }

    /**
     * 
     * The list of forecasted events.
     * 
     * 
     * @param forecastedEvents
     *        The list of forecasted events.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ForecastGeofenceEventsResult withForecastedEvents(java.util.Collection forecastedEvents) {
        setForecastedEvents(forecastedEvents);
        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.
     * 
     * 
     * @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.
     */

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

    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.
     * 
     * 
     * @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.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ForecastGeofenceEventsResult withNextToken(String nextToken) {
        setNextToken(nextToken);
        return this;
    }

    /**
     * 
     * The distance unit for the forecasted events.
     * 
     * 
     * @param distanceUnit
     *        The distance unit for the forecasted events.
     * @see DistanceUnit
     */

    public void setDistanceUnit(String distanceUnit) {
        this.distanceUnit = distanceUnit;
    }

    /**
     * 
     * The distance unit for the forecasted events.
     * 
     * 
     * @return The distance unit for the forecasted events.
     * @see DistanceUnit
     */

    public String getDistanceUnit() {
        return this.distanceUnit;
    }

    /**
     * 
     * The distance unit for the forecasted events.
     * 
     * 
     * @param distanceUnit
     *        The distance unit for the forecasted events.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see DistanceUnit
     */

    public ForecastGeofenceEventsResult withDistanceUnit(String distanceUnit) {
        setDistanceUnit(distanceUnit);
        return this;
    }

    /**
     * 
     * The distance unit for the forecasted events.
     * 
     * 
     * @param distanceUnit
     *        The distance unit for the forecasted events.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see DistanceUnit
     */

    public ForecastGeofenceEventsResult withDistanceUnit(DistanceUnit distanceUnit) {
        this.distanceUnit = distanceUnit.toString();
        return this;
    }

    /**
     * 
     * The speed unit for the forecasted events.
     * 
     * 
     * @param speedUnit
     *        The speed unit for the forecasted events.
     * @see SpeedUnit
     */

    public void setSpeedUnit(String speedUnit) {
        this.speedUnit = speedUnit;
    }

    /**
     * 
     * The speed unit for the forecasted events.
     * 
     * 
     * @return The speed unit for the forecasted events.
     * @see SpeedUnit
     */

    public String getSpeedUnit() {
        return this.speedUnit;
    }

    /**
     * 
     * The speed unit for the forecasted events.
     * 
     * 
     * @param speedUnit
     *        The speed unit for the forecasted events.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SpeedUnit
     */

    public ForecastGeofenceEventsResult withSpeedUnit(String speedUnit) {
        setSpeedUnit(speedUnit);
        return this;
    }

    /**
     * 
     * The speed unit for the forecasted events.
     * 
     * 
     * @param speedUnit
     *        The speed unit for the forecasted events.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SpeedUnit
     */

    public ForecastGeofenceEventsResult withSpeedUnit(SpeedUnit speedUnit) {
        this.speedUnit = speedUnit.toString();
        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 (getForecastedEvents() != null)
            sb.append("ForecastedEvents: ").append(getForecastedEvents()).append(",");
        if (getNextToken() != null)
            sb.append("NextToken: ").append(getNextToken()).append(",");
        if (getDistanceUnit() != null)
            sb.append("DistanceUnit: ").append(getDistanceUnit()).append(",");
        if (getSpeedUnit() != null)
            sb.append("SpeedUnit: ").append(getSpeedUnit());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof ForecastGeofenceEventsResult == false)
            return false;
        ForecastGeofenceEventsResult other = (ForecastGeofenceEventsResult) obj;
        if (other.getForecastedEvents() == null ^ this.getForecastedEvents() == null)
            return false;
        if (other.getForecastedEvents() != null && other.getForecastedEvents().equals(this.getForecastedEvents()) == 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.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;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getForecastedEvents() == null) ? 0 : getForecastedEvents().hashCode());
        hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
        hashCode = prime * hashCode + ((getDistanceUnit() == null) ? 0 : getDistanceUnit().hashCode());
        hashCode = prime * hashCode + ((getSpeedUnit() == null) ? 0 : getSpeedUnit().hashCode());
        return hashCode;
    }

    @Override
    public ForecastGeofenceEventsResult clone() {
        try {
            return (ForecastGeofenceEventsResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

}