com.sitewhere.spi.microservice.monitoring.IProgressMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sitewhere-microservice Show documentation

SiteWhere Microservice Components Library

There is a newer version: 3.0.13

Show newest version

/*
 * Copyright (c) SiteWhere, LLC. All rights reserved. http://www.sitewhere.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package com.sitewhere.spi.microservice.monitoring;

import java.io.Serializable;

/**
 * Message sent to indicate progress for a long-running task.
 */
public interface IProgressMessage extends Serializable {

    /**
     * Get name of overall task being monitored.
     * 
     * @return
     */
    String getTaskName();

    /**
     * Get progress value as a number between 0 and 100.
     * 
     * @return
     */
    double getProgressPercentage();

    /**
     * Get message shown for current operation.
     * 
     * @return
     */
    String getMessage();

    /**
     * Get timestamp for message.
     * 
     * @return
     */
    Long getTimeStamp();
}