com.qubole.qds.sdk.java.api.SchedulerApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qds-sdk-java Show documentation
A Java library that provides the tools you need to authenticate with, and use the Qubole Data Service API.
There is a newer version: 1.3.0
/**
 * Copyright 2014- Qubole 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 com.qubole.qds.sdk.java.api;

import com.qubole.qds.sdk.java.entities.Command;
import com.qubole.qds.sdk.java.entities.Commands;
import com.qubole.qds.sdk.java.entities.Schedule;
import com.qubole.qds.sdk.java.entities.SchedulesResponse;
import com.qubole.qds.sdk.java.entities.SuccessAndStatus;

/**
 * Corresponds to http://www.qubole.com/docs/documentation/scheduler-api/
 */
public interface SchedulerApi
{
    /**
     * Corresponds to http://www.qubole.com/docs/list-schedules/
     *
     * @return builder
     */
    public PageableInvokableBuilder list();

    /**
     * Corresponds to http://www.qubole.com/docs/suspendresume-or-kill-a-schedule/ - suspend
     *
     * @param scheduleId schedule id
     * @return builder
     */
    public InvokableBuilder suspend(int scheduleId);

    /**
     * Corresponds to http://www.qubole.com/docs/suspendresume-or-kill-a-schedule/ - kill
     *
     * @param scheduleId schedule id
     * @return builder
     */
    public InvokableBuilder kill(int scheduleId);

    /**
     * Corresponds to http://www.qubole.com/docs/suspendresume-or-kill-a-schedule/ - resume
     *
     * @param scheduleId schedule id
     * @return builder
     */
    public InvokableBuilder resume(int scheduleId);

    /**
     * Corresponds to http://www.qubole.com/docs/view-a-schedule/
     *
     * @param scheduleId schedule id
     * @return builder
     */
    public InvokableBuilder view(int scheduleId);

    /**
     * Corresponds to http://www.qubole.com/docs/list-schedule-instances/
     *
     * @param scheduleId schedule id
     * @return builder
     */
    public PageableInvokableBuilder listInstances(int scheduleId);

    /**
     * Corresponds to http://www.qubole.com/docs/view-a-scheduled-command/
     *
     * @param scheduleId schedule id
     * @param instanceId instance id
     * @return builder
     */
    public InvokableBuilder viewCommand(int scheduleId, int instanceId);

    /**
     * Corresponds to http://www.qubole.com/docs/get-logs-of-scheduled-instances/
     *
     * @param scheduleId schedule id
     * @param instanceId instance id
     * @return builder
     */
    public InvokableBuilder instanceLogs(int scheduleId, int instanceId);

    /**
     * Corresponds to http://www.qubole.com/docs/get-results-of-a-scheduled-instance/
     *
     * @param scheduleId schedule id
     * @param instanceId instance id
     * @return builder
     */
    public InvokableBuilder instanceResults(int scheduleId, int instanceId);

    /**
     * Corresponds to http://docs.qubole.com/en/latest/rest-api/scheduler_api/edit-a-schedule.html
     *
     * @param scheduleId the ID of the scheduled job
     * @param configBuilder config values - use {@link #scheduleBuilder()}
     * @return new builder
     */
    public InvokableBuilder edit(String scheduleId, CreateScheduleCommandBuilder configBuilder);

    /**
     * Corresponds to http://docs.qubole.com/en/latest/rest-api/scheduler_api/create-a-schedule.html
     *
     * @param configBuilder config values - use {@link #scheduleBuilder()}
     * @return new builder
     */
    public InvokableBuilder create(CreateScheduleCommandBuilder configBuilder);

    /**
     * Corresponds to http://www.qubole.com/docs/create-a-schedule/
     *
     * @return builder
     */
    public CreateScheduleCommandBuilder scheduleBuilder();
}