dxjob.h

Go to the documentation of this file.

// Copyright (C) 2013-2016 DNAnexus, Inc.
//
// This file is part of dx-toolkit (DNAnexus platform client libraries).
//
//   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.
 
#ifndef DXCPP_BINDINGS_DXJOB_H
#define DXCPP_BINDINGS_DXJOB_H
 
#include <string>
#include <limits>
#include "dxjson/dxjson.h"
 
namespace dx {
 
 
  class DXJob {
   private:
    std::string dxid_;
   public:
    DXJob() { }
 
    DXJob(const std::string &dxid) : dxid_(dxid) { }
 
    dx::JSON describe() const;
 
    void setID(const std::string &dxid) { dxid_ = dxid; }
 
    std::string getState() const { return describe()["state"].get<std::string>(); }
 
    std::string getID() const { return dxid_; }
 
    void create(const dx::JSON &fn_input, 
                const std::string &fn_name, 
                const std::string &job_name="",
                const std::vector<std::string> &depends_on=std::vector<std::string>(),
                const dx::JSON &instance_type=dx::JSON(dx::JSON_NULL)
                );
 
    void terminate() const;
 
    void waitOnDone(const int timeout=std::numeric_limits<int>::max()) const;
 
    dx::JSON getOutputRef(const std::string &field);
 
    static DXJob newDXJob(const dx::JSON &fn_input,
                          const std::string &fn_name,
                          const std::string &job_name="",
                          const std::vector<std::string> &depends_on=std::vector<std::string>(),
                          const dx::JSON &instance_type=dx::JSON(dx::JSON_NULL)
                          );
  };
}
 
#include "../bindings.h"
 
#endif