com.amazonaws.services.iotanalytics.model.RetentionPeriod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-iotanalytics Show documentation
The AWS Java SDK for AWS IoT Analytics module holds the client classes that are used for communicating with AWS IoT Analytics Service
There is a newer version: 1.12.780
Show 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.iotanalytics.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * How long, in days, message data is kept.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RetentionPeriod implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * If true, message data is kept indefinitely.
     * 
     */
    private Boolean unlimited;
    /**
     * 
     * The number of days that message data is kept. The unlimited parameter must be false.
     * 
     */
    private Integer numberOfDays;

    /**
     * 
     * If true, message data is kept indefinitely.
     * 
     * 
     * @param unlimited
     *        If true, message data is kept indefinitely.
     */

    public void setUnlimited(Boolean unlimited) {
        this.unlimited = unlimited;
    }

    /**
     * 
     * If true, message data is kept indefinitely.
     * 
     * 
     * @return If true, message data is kept indefinitely.
     */

    public Boolean getUnlimited() {
        return this.unlimited;
    }

    /**
     * 
     * If true, message data is kept indefinitely.
     * 
     * 
     * @param unlimited
     *        If true, message data is kept indefinitely.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RetentionPeriod withUnlimited(Boolean unlimited) {
        setUnlimited(unlimited);
        return this;
    }

    /**
     * 
     * If true, message data is kept indefinitely.
     * 
     * 
     * @return If true, message data is kept indefinitely.
     */

    public Boolean isUnlimited() {
        return this.unlimited;
    }

    /**
     * 
     * The number of days that message data is kept. The unlimited parameter must be false.
     * 
     * 
     * @param numberOfDays
     *        The number of days that message data is kept. The unlimited parameter must be false.
     */

    public void setNumberOfDays(Integer numberOfDays) {
        this.numberOfDays = numberOfDays;
    }

    /**
     * 
     * The number of days that message data is kept. The unlimited parameter must be false.
     * 
     * 
     * @return The number of days that message data is kept. The unlimited parameter must be false.
     */

    public Integer getNumberOfDays() {
        return this.numberOfDays;
    }

    /**
     * 
     * The number of days that message data is kept. The unlimited parameter must be false.
     * 
     * 
     * @param numberOfDays
     *        The number of days that message data is kept. The unlimited parameter must be false.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RetentionPeriod withNumberOfDays(Integer numberOfDays) {
        setNumberOfDays(numberOfDays);
        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 (getUnlimited() != null)
            sb.append("Unlimited: ").append(getUnlimited()).append(",");
        if (getNumberOfDays() != null)
            sb.append("NumberOfDays: ").append(getNumberOfDays());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof RetentionPeriod == false)
            return false;
        RetentionPeriod other = (RetentionPeriod) obj;
        if (other.getUnlimited() == null ^ this.getUnlimited() == null)
            return false;
        if (other.getUnlimited() != null && other.getUnlimited().equals(this.getUnlimited()) == false)
            return false;
        if (other.getNumberOfDays() == null ^ this.getNumberOfDays() == null)
            return false;
        if (other.getNumberOfDays() != null && other.getNumberOfDays().equals(this.getNumberOfDays()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getUnlimited() == null) ? 0 : getUnlimited().hashCode());
        hashCode = prime * hashCode + ((getNumberOfDays() == null) ? 0 : getNumberOfDays().hashCode());
        return hashCode;
    }

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

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.iotanalytics.model.transform.RetentionPeriodMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}