DeletionConfig.java

/*
 * Copyright 2010-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.kinesisvideo.model;

import java.io.Serializable;

/**
 * <p>
 * The configuration details required to delete the connection of the stream
 * from the Edge Agent.
 * </p>
 */
public class DeletionConfig implements Serializable {
    /**
     * <p>
     * The number of hours that you want to retain the data in the stream on the
     * Edge Agent. The default value of the retention time is 720 hours, which
     * translates to 30 days.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Range: </b>1 - 720<br/>
     */
    private Integer edgeRetentionInHours;

    /**
     * <p>
     * The value of the local size required in order to delete the edge
     * configuration.
     * </p>
     */
    private LocalSizeConfig localSizeConfig;

    /**
     * <p>
     * The <code>boolean</code> value used to indicate whether or not you want
     * to mark the media for deletion, once it has been uploaded to the Kinesis
     * Video Stream cloud. The media files can be deleted if any of the deletion
     * configuration values are set to <code>true</code>, such as when the limit
     * for the <code>EdgeRetentionInHours</code>, or the
     * <code>MaxLocalMediaSizeInMB</code>, has been reached.
     * </p>
     * <p>
     * Since the default value is set to <code>true</code>, configure the
     * uploader schedule such that the media files are not being deleted before
     * they are initially uploaded to the Amazon Web Services cloud.
     * </p>
     */
    private Boolean deleteAfterUpload;

    /**
     * <p>
     * The number of hours that you want to retain the data in the stream on the
     * Edge Agent. The default value of the retention time is 720 hours, which
     * translates to 30 days.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Range: </b>1 - 720<br/>
     *
     * @return <p>
     *         The number of hours that you want to retain the data in the
     *         stream on the Edge Agent. The default value of the retention time
     *         is 720 hours, which translates to 30 days.
     *         </p>
     */
    public Integer getEdgeRetentionInHours() {
        return edgeRetentionInHours;
    }

    /**
     * <p>
     * The number of hours that you want to retain the data in the stream on the
     * Edge Agent. The default value of the retention time is 720 hours, which
     * translates to 30 days.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Range: </b>1 - 720<br/>
     *
     * @param edgeRetentionInHours <p>
     *            The number of hours that you want to retain the data in the
     *            stream on the Edge Agent. The default value of the retention
     *            time is 720 hours, which translates to 30 days.
     *            </p>
     */
    public void setEdgeRetentionInHours(Integer edgeRetentionInHours) {
        this.edgeRetentionInHours = edgeRetentionInHours;
    }

    /**
     * <p>
     * The number of hours that you want to retain the data in the stream on the
     * Edge Agent. The default value of the retention time is 720 hours, which
     * translates to 30 days.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Range: </b>1 - 720<br/>
     *
     * @param edgeRetentionInHours <p>
     *            The number of hours that you want to retain the data in the
     *            stream on the Edge Agent. The default value of the retention
     *            time is 720 hours, which translates to 30 days.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public DeletionConfig withEdgeRetentionInHours(Integer edgeRetentionInHours) {
        this.edgeRetentionInHours = edgeRetentionInHours;
        return this;
    }

    /**
     * <p>
     * The value of the local size required in order to delete the edge
     * configuration.
     * </p>
     *
     * @return <p>
     *         The value of the local size required in order to delete the edge
     *         configuration.
     *         </p>
     */
    public LocalSizeConfig getLocalSizeConfig() {
        return localSizeConfig;
    }

    /**
     * <p>
     * The value of the local size required in order to delete the edge
     * configuration.
     * </p>
     *
     * @param localSizeConfig <p>
     *            The value of the local size required in order to delete the
     *            edge configuration.
     *            </p>
     */
    public void setLocalSizeConfig(LocalSizeConfig localSizeConfig) {
        this.localSizeConfig = localSizeConfig;
    }

    /**
     * <p>
     * The value of the local size required in order to delete the edge
     * configuration.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param localSizeConfig <p>
     *            The value of the local size required in order to delete the
     *            edge configuration.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public DeletionConfig withLocalSizeConfig(LocalSizeConfig localSizeConfig) {
        this.localSizeConfig = localSizeConfig;
        return this;
    }

    /**
     * <p>
     * The <code>boolean</code> value used to indicate whether or not you want
     * to mark the media for deletion, once it has been uploaded to the Kinesis
     * Video Stream cloud. The media files can be deleted if any of the deletion
     * configuration values are set to <code>true</code>, such as when the limit
     * for the <code>EdgeRetentionInHours</code>, or the
     * <code>MaxLocalMediaSizeInMB</code>, has been reached.
     * </p>
     * <p>
     * Since the default value is set to <code>true</code>, configure the
     * uploader schedule such that the media files are not being deleted before
     * they are initially uploaded to the Amazon Web Services cloud.
     * </p>
     *
     * @return <p>
     *         The <code>boolean</code> value used to indicate whether or not
     *         you want to mark the media for deletion, once it has been
     *         uploaded to the Kinesis Video Stream cloud. The media files can
     *         be deleted if any of the deletion configuration values are set to
     *         <code>true</code>, such as when the limit for the
     *         <code>EdgeRetentionInHours</code>, or the
     *         <code>MaxLocalMediaSizeInMB</code>, has been reached.
     *         </p>
     *         <p>
     *         Since the default value is set to <code>true</code>, configure
     *         the uploader schedule such that the media files are not being
     *         deleted before they are initially uploaded to the Amazon Web
     *         Services cloud.
     *         </p>
     */
    public Boolean isDeleteAfterUpload() {
        return deleteAfterUpload;
    }

    /**
     * <p>
     * The <code>boolean</code> value used to indicate whether or not you want
     * to mark the media for deletion, once it has been uploaded to the Kinesis
     * Video Stream cloud. The media files can be deleted if any of the deletion
     * configuration values are set to <code>true</code>, such as when the limit
     * for the <code>EdgeRetentionInHours</code>, or the
     * <code>MaxLocalMediaSizeInMB</code>, has been reached.
     * </p>
     * <p>
     * Since the default value is set to <code>true</code>, configure the
     * uploader schedule such that the media files are not being deleted before
     * they are initially uploaded to the Amazon Web Services cloud.
     * </p>
     *
     * @return <p>
     *         The <code>boolean</code> value used to indicate whether or not
     *         you want to mark the media for deletion, once it has been
     *         uploaded to the Kinesis Video Stream cloud. The media files can
     *         be deleted if any of the deletion configuration values are set to
     *         <code>true</code>, such as when the limit for the
     *         <code>EdgeRetentionInHours</code>, or the
     *         <code>MaxLocalMediaSizeInMB</code>, has been reached.
     *         </p>
     *         <p>
     *         Since the default value is set to <code>true</code>, configure
     *         the uploader schedule such that the media files are not being
     *         deleted before they are initially uploaded to the Amazon Web
     *         Services cloud.
     *         </p>
     */
    public Boolean getDeleteAfterUpload() {
        return deleteAfterUpload;
    }

    /**
     * <p>
     * The <code>boolean</code> value used to indicate whether or not you want
     * to mark the media for deletion, once it has been uploaded to the Kinesis
     * Video Stream cloud. The media files can be deleted if any of the deletion
     * configuration values are set to <code>true</code>, such as when the limit
     * for the <code>EdgeRetentionInHours</code>, or the
     * <code>MaxLocalMediaSizeInMB</code>, has been reached.
     * </p>
     * <p>
     * Since the default value is set to <code>true</code>, configure the
     * uploader schedule such that the media files are not being deleted before
     * they are initially uploaded to the Amazon Web Services cloud.
     * </p>
     *
     * @param deleteAfterUpload <p>
     *            The <code>boolean</code> value used to indicate whether or not
     *            you want to mark the media for deletion, once it has been
     *            uploaded to the Kinesis Video Stream cloud. The media files
     *            can be deleted if any of the deletion configuration values are
     *            set to <code>true</code>, such as when the limit for the
     *            <code>EdgeRetentionInHours</code>, or the
     *            <code>MaxLocalMediaSizeInMB</code>, has been reached.
     *            </p>
     *            <p>
     *            Since the default value is set to <code>true</code>, configure
     *            the uploader schedule such that the media files are not being
     *            deleted before they are initially uploaded to the Amazon Web
     *            Services cloud.
     *            </p>
     */
    public void setDeleteAfterUpload(Boolean deleteAfterUpload) {
        this.deleteAfterUpload = deleteAfterUpload;
    }

    /**
     * <p>
     * The <code>boolean</code> value used to indicate whether or not you want
     * to mark the media for deletion, once it has been uploaded to the Kinesis
     * Video Stream cloud. The media files can be deleted if any of the deletion
     * configuration values are set to <code>true</code>, such as when the limit
     * for the <code>EdgeRetentionInHours</code>, or the
     * <code>MaxLocalMediaSizeInMB</code>, has been reached.
     * </p>
     * <p>
     * Since the default value is set to <code>true</code>, configure the
     * uploader schedule such that the media files are not being deleted before
     * they are initially uploaded to the Amazon Web Services cloud.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     *
     * @param deleteAfterUpload <p>
     *            The <code>boolean</code> value used to indicate whether or not
     *            you want to mark the media for deletion, once it has been
     *            uploaded to the Kinesis Video Stream cloud. The media files
     *            can be deleted if any of the deletion configuration values are
     *            set to <code>true</code>, such as when the limit for the
     *            <code>EdgeRetentionInHours</code>, or the
     *            <code>MaxLocalMediaSizeInMB</code>, has been reached.
     *            </p>
     *            <p>
     *            Since the default value is set to <code>true</code>, configure
     *            the uploader schedule such that the media files are not being
     *            deleted before they are initially uploaded to the Amazon Web
     *            Services cloud.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public DeletionConfig withDeleteAfterUpload(Boolean deleteAfterUpload) {
        this.deleteAfterUpload = deleteAfterUpload;
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getEdgeRetentionInHours() != null)
            sb.append("EdgeRetentionInHours: " + getEdgeRetentionInHours() + ",");
        if (getLocalSizeConfig() != null)
            sb.append("LocalSizeConfig: " + getLocalSizeConfig() + ",");
        if (getDeleteAfterUpload() != null)
            sb.append("DeleteAfterUpload: " + getDeleteAfterUpload());
        sb.append("}");
        return sb.toString();
    }

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

        hashCode = prime * hashCode
                + ((getEdgeRetentionInHours() == null) ? 0 : getEdgeRetentionInHours().hashCode());
        hashCode = prime * hashCode
                + ((getLocalSizeConfig() == null) ? 0 : getLocalSizeConfig().hashCode());
        hashCode = prime * hashCode
                + ((getDeleteAfterUpload() == null) ? 0 : getDeleteAfterUpload().hashCode());
        return hashCode;
    }

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

        if (obj instanceof DeletionConfig == false)
            return false;
        DeletionConfig other = (DeletionConfig) obj;

        if (other.getEdgeRetentionInHours() == null ^ this.getEdgeRetentionInHours() == null)
            return false;
        if (other.getEdgeRetentionInHours() != null
                && other.getEdgeRetentionInHours().equals(this.getEdgeRetentionInHours()) == false)
            return false;
        if (other.getLocalSizeConfig() == null ^ this.getLocalSizeConfig() == null)
            return false;
        if (other.getLocalSizeConfig() != null
                && other.getLocalSizeConfig().equals(this.getLocalSizeConfig()) == false)
            return false;
        if (other.getDeleteAfterUpload() == null ^ this.getDeleteAfterUpload() == null)
            return false;
        if (other.getDeleteAfterUpload() != null
                && other.getDeleteAfterUpload().equals(this.getDeleteAfterUpload()) == false)
            return false;
        return true;
    }
}