io.mantisrx.server.master.MantisJobOperations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mantis-control-plane-server Show documentation
mantis-control-plane-server
The newest version!
/*
 * Copyright 2019 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 io.mantisrx.server.master;

import io.mantisrx.common.Label;
import io.mantisrx.runtime.MantisJobDefinition;
import io.mantisrx.runtime.NamedJobDefinition;
import io.mantisrx.runtime.WorkerMigrationConfig;
import io.mantisrx.server.master.store.InvalidJobException;
import io.mantisrx.server.master.store.InvalidNamedJobException;
import io.mantisrx.server.master.store.NamedJob;
import io.mantisrx.server.master.store.NamedJobDeleteException;
import java.io.IOException;
import java.net.URL;
import java.util.List;
import java.util.Optional;
import rx.Observable;
import rx.functions.Action1;


public interface MantisJobOperations {

    NamedJob createNamedJob(NamedJobDefinition namedJobDefinition)
            throws InvalidNamedJobException;

    NamedJob updateNamedJar(NamedJobDefinition namedJobDefinition, boolean createIfNeeded) throws InvalidNamedJobException;

    NamedJob quickUpdateNamedJob(String user, String name, URL jobJar, String version) throws InvalidNamedJobException;

    void updateSla(String user, String name, NamedJob.SLA sla, boolean forceEnable) throws InvalidNamedJobException;

    /**
     * Update the Labels associated with the Job cluster. This complete replaces any existing labels.
     *
     * @param user   : submitter
     * @param name   : Job cluster name
     * @param labels List of Label objects
     *
     * @throws InvalidNamedJobException
     */
    void updateLabels(String user, String name, List labels) throws InvalidNamedJobException;

    void updateMigrateStrategy(String user, String name, WorkerMigrationConfig migrationConfig) throws InvalidNamedJobException;

    String quickSubmit(String jobName, String user) throws InvalidNamedJobException, InvalidJobException;

    Optional getNamedJob(String name);

    void deleteNamedJob(String name, String user) throws NamedJobDeleteException;

    void disableNamedJob(String name, String user) throws InvalidNamedJobException;

    void enableNamedJob(String name, String user) throws InvalidNamedJobException;

    MantisJobStatus submit(MantisJobDefinition jobDefinition);

    boolean deleteJob(String jobId) throws IOException;

    void killJob(String user, String jobId, String reason);

    void terminateJob(String jobId);

    Observable jobs();

    MantisJobStatus status(String jobId);

    Action1 getSlaveDisabler();

    Action1 getSlaveEnabler();

    void setReady();
}