/*
 * $Id$
 *
 * This file is part of the Cloud Services Integration Platform (CSIP),
 * a Model-as-a-Service framework, API and application suite.
 *
 * 2012-2022, Olaf David and others, OMSLab, Colorado State University.
 *
 * OMSLab licenses this file to you under the MIT license.
 * See the LICENSE file in the project root for more information.
 */
package csip;

/**
 * Service Constants
 *
 * @author od
 */
public interface ModelDataServiceConstants {

  // General const
  String KEY_REPORT = "report";
  String KEY_METAINFO = "metainfo";
  String KEY_PARAMETER = "parameter";
  String KEY_RESULT = "result";

  // metainfo keys
  String KEY_PARAMETERSETS = "parametersets";
  String KEY_SUUID = "suid";
  String KEY_STATUS = "status";
  String KEY_LOG = "log";
  String KEY_ARCHIVE = "archive";
  String KEY_NEXT_POLL = "next_poll";
  String KEY_FIRST_POLL = "first_poll";
  String KEY_CPU_TIME = "cpu_time";
  String KEY_CLOUD_NODE = "cloud_node";
  String KEY_SERVICE_URL = "service_url";
  String KEY_URL = "url";
  String KEY_REQ_IP = "request_ip";
  String KEY_KEEP_RESULTS = "keep_results";
  String KEY_EXPIRATION_DATE = "expiration_date";
  String KEY_TSTAMP = "tstamp";  //?
  String KEY_TZ = "tz";   // timezone
  String KEY_PROGRESS = "progress";
  String KEY_WEBHOOK = "webhook";
  String KEY_REQUEST_FILE = "request_file";

  // webhook
  String HEADER_WEBHOOK = "X-CSIP-Webhook";
  String HEADER_REQUEST_FILE = "X-CSIP-Request-File";

  // cosu metainfo
  String KEY_COSU = "cosu";
  String KEY_OF = "of";
  String KEY_DATA = "data";

  // parameter keys
  String KEY_NAME = "name";
  String VALUE = "value";
  String KEY_VALUE = "value";
  String KEY_TYPE = "type";
  String KEY_COORDINATES = "coordinates";
  String GEOMETRY = "geometry";
  String KEY_UNIT = "unit";
  String KEY_DESC = "description";
  String KEY_PATH = "path";
  String KEY_REQUEST_RESULTS = "request-results";

  String FORM_PARAM = "param";

  String ERROR = "error";
  String OK = "ok";
  String IN = "in";
  String INTENT = "intent";
  String MAX = "max";
  String MIN = "min";
  String OUT = "out";
  String RANGE = "range";
  String UNIT = "unit";

  // execution stages
  String STARTED = "Started";
  String RUNNING = "Running";
  String FINISHED = "Finished";
  String CANCELED = "Canceled";
  String ARCHIVED = "Archived";
  String FAILED = "Failed";
  String UNKNOWN = "Unknown";
  String SUBMITTED = "Submitted";
  String TIMEDOUT = "Timeout";
  String DENIED = "Denied";
  String QUEUED = "Queued";

  // execution modes
  String SYNC = "sync";
  String ASYNC = "async";
  String KEY_MODE = "mode";

  // files 
  String REPORT_FILE = "report.json";
  String REQUEST_FILE = ".request.json";
  String RESPONSE_FILE = ".response.json";
  String RESULT_FILE = ".result.json";
  String LOG_FILE = ".log.txt";
  //
  String REPORT_TYPE = "type";
  String REPORT_VALUE = "value";
  String REPORT_NAME = "name";
  String REPORT_UNITS = "units";
  String REPORT_DESC = "description";
  String REPORT_DIM0 = "dimension0";
  String REPORT_DIM = "dim";

}