com.qubole.qds.sdk.java.api.ClusterApi 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.ClusterItem;
import com.qubole.qds.sdk.java.entities.ClusterState;
import com.qubole.qds.sdk.java.entities.Message;
import java.util.List;

/**
 * Corresponds to http://www.qubole.com/docs/documentation/cluster-api/
 */
public interface ClusterApi
{
    /**
     * Corresponds to http://www.qubole.com/docs/list-clusters/
     *
     * @return new builder
     */
    public InvokableBuilder> list();

    /**
     * Corresponds to http://www.qubole.com/docs/get-cluster-state/
     *
     * @param labelOrId the Cluster label/id
     * @return new builder
     */
    public InvokableBuilder state(String labelOrId);

    /**
     * Corresponds to http://www.qubole.com/docs/get-cluster-information/
     *
     * @param labelOrId the Cluster label/id
     * @return new builder
     */
    public InvokableBuilder information(String labelOrId);

    /**
     * Corresponds to http://www.qubole.com/docs/start-terminate-cluster/ for "start"
     *
     * @param labelOrId the Cluster label/id
     * @return new builder
     */
    public InvokableBuilder start(String labelOrId);

    /**
     * Corresponds to http://www.qubole.com/docs/start-terminate-cluster/ for "terminate"
     *
     * @param labelOrId the Cluster label/id
     * @return new builder
     */
    public InvokableBuilder terminate(String labelOrId);

    /**
     * Corresponds to http://www.qubole.com/docs/edit-cluster/
     *
     * @param labelOrId the Cluster label/id
     * @param configBuilder config values - use {@link #clusterConfig()}
     * @return new builder
     */
    public InvokableBuilder edit(String labelOrId, ClusterConfigBuilder configBuilder);

    /**
     * Corresponds to http://www.qubole.com/docs/create-new-cluster/
     *
     * @param configBuilder config values - use {@link #clusterConfig()}
     * @return new builder
     */
    public InvokableBuilder create(ClusterConfigBuilder configBuilder);

    /**
     * Corresponds to http://www.qubole.com/docs/delete-cluster/
     *
     * @param labelOrId the Cluster label/id
     * @return new builder
     */
    public InvokableBuilder delete(String labelOrId);

    /**
     * Return a new cluster config builder. Can be used with
     * apis such as {@link ClusterApi#edit(String, ClusterConfigBuilder)}
     *
     * @return builder
     */
    public ClusterConfigBuilder clusterConfig();
}