com.microsoft.azure.cosmos.connectors.cassandra.service.IScheduledTask Maven / Gradle / Ivy

/*
 * Copyright (c) Microsoft Corporation.  All rights reserved.
 */

package com.microsoft.azure.cosmos.connectors.cassandra.service;

import com.microsoft.azure.cosmos.connectors.cassandra.config.Config;

/**
 * A task that can be scheduled at frequent intervals.
 */
public interface IScheduledTask extends Runnable {

    /**
     * Scheduling interval in milliseconds
     *
     * @return Scheduling interval
     */
    long getTaskSchedulingIntervalInMilliseconds();

    /**
     * Whether the task is enabled or not.
     *
     * @return True if enabled, false otherwise
     */
    boolean isTaskEnabled();

    /**
     * Gets the agent configuration
     *
     * @return Agent Config
     */
    Config getConfig();

    /**
     * The name of the scheduled task
     *
     * @return Scheduled Task Name
     */
    String getTaskName();
}