JobParameters (Java Client for DOcplexcloud 1.0 API)

All Superinterfaces:

Map<String,Object>
```
public interface JobParameters
extends Map<String,Object>
```
Stores various job parameters. System parameters start with a prefix of oaas, and additional custom properties can be added to keep track of job context.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALERT_TIME` Indicates that an email alert will be sent when a the jobs reaches the specified alert time limit.
`static String`	`BLUEMIX_REGION` Indicates which Bluemix region was used if the job was submitted via Bluemix and if, and only if, the Bluemix region has been detected.
`static String`	`DROPSOLVE` Indicates if the job was submitted interactively using the DropSolve.
`static String`	`JOB_CORES` Only used in Reserved Bare Metal subscription, this parameter specifies cores used to process job.
`static String`	`JOB_MEMORY_MBYTES` Only used in Reserved Bare Metal subscription, this parameter specifies maximum memory megabytes used to process job.
`static String`	`LOG_LIMIT` Log size limit in characters.
`static String`	`NOTIFY_COMPLETION` Indicates that an email notification will be sent upon completion of the job.
`static String`	`OPL_RUN_CONFIG` Specifies the name of the OPL run configuration to be executed by the OPL Worker.
`static String`	`RESULTS_FORMAT` Specifies the format for returned results.
`static String`	`RESULTS_FORMAT_JSON` String value for `RESULTS_FORMAT` parameter to specify JSON as results format.
`static String`	`RESULTS_FORMAT_TEXT` String value for `RESULTS_FORMAT` parameter to specify TEXT as results format.
`static String`	`RESULTS_FORMAT_XLSX` String value for `RESULTS_FORMAT` parameter to specify XLSX as results format.
`static String`	`RESULTS_FORMAT_XML` String value for `RESULTS_FORMAT` parameter to specify XML as results format.
`static String`	`TIME_LIMIT` Time limits in milliseconds.
`static String`	`WEBHOOK` Specifies the webhook to be called on job completion.

Method Summary

Methods
Modifier and Type	Method and Description
`Long`	`getAlertTime()` Returns the alert limit.
`Boolean`	`getAsBoolean(String name)` Returns the parameter value as a Boolean.
`boolean`	`getAsBoolean(String name, boolean defaultValue)` Returns the parameter value as a Boolean with a default value.
`Double`	`getAsDouble(String name)` Returns the parameter value as a Double.
`double`	`getAsDouble(String name, double defaultValue)` Returns the parameter value as a Double with a default value.
`Integer`	`getAsInteger(String name)` Returns the parameter value as a Integer.
`int`	`getAsInteger(String name, int defaultValue)` Returns the parameter value as a Integer with a default value.
`Long`	`getAsLong(String name)` Returns the parameter value as a Double.
`long`	`getAsLong(String name, long defaultValue)` Returns the parameter value as a Double with a default value.
`String`	`getAsString(String name)` Returns the parameter value as a String.
`String`	`getAsString(String name, String defaultValue)` Returns the parameter value as a String with a default value.
`String`	`getBluemixRegion()` Returns the Bluemix region that submitted this job (if known).
`Boolean`	`getDropSolve()` The DropSolve flag.
`Integer`	`getJobCores()` Returns cores used to process job.
`Integer`	`getJobMemoryMbytes()` Returns maximum memory megabytes used to process the job.
`Long`	`getLogLimit()` Returns the log limit.
`Boolean`	`getNotifyCompletion()` Returns the notify completion flag.
`String`	`getOplRunConfig()` Returns the OPL run configuration.
`String`	`getResultsFormat()` Returns results format.
`Long`	`getTimeLimit()` Returns the time limit.
`String`	`getWebhook()` Returns the webhook.
`void`	`setAlertTime(Long value)` Sets the alert limit.
`void`	`setBluemixRegion(String bluemixRegion)` Sets the Bluemix region that created this job (if known).
`void`	`setJobCores(Integer cores)` Sets the number of cores used to process the job.
`void`	`setJobMemoryMbytes(Integer mbytes)` Sets maximum memory megabytes used to process the job.
`void`	`setLogLimit(Long value)` Sets the log limit.
`void`	`setNotifyCompletion(Boolean notify)` Sets the notify completion flag.
`void`	`setOplRunConfig(String value)` Sets the OPL run configuration.
`void`	`setResultsFormat(String value)` Sets the results format.
`void`	`setTimeLimit(Long value)` Sets the time limit.
`void`	`setWebhook(String value)` Sets the webhook.

Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

- Field Detail
  - TIME_LIMIT
```
static final String TIME_LIMIT
```
    Time limits in milliseconds. This can be used to setup a time limit that is smaller than the limit defined by the subscription.
    
    See Also:
    Constant Field Values
  - LOG_LIMIT
```
static final String LOG_LIMIT
```
    Log size limit in characters. This can be used to setup a time limit that is smaller than the limit defined by the subscription.
    
    See Also:
    Constant Field Values
  - OPL_RUN_CONFIG
```
static final String OPL_RUN_CONFIG
```
    Specifies the name of the OPL run configuration to be executed by the OPL Worker.
    
    See Also:
    Constant Field Values
  - RESULTS_FORMAT
```
static final String RESULTS_FORMAT
```
    Specifies the format for returned results. JSON is the default format. Other formats may or may not be supported by each application type.
    
    See Also:
    Constant Field Values
  - RESULTS_FORMAT_TEXT
```
static final String RESULTS_FORMAT_TEXT
```
    String value for RESULTS_FORMAT parameter to specify TEXT as results format. This format may or may not be supported by a given application.
    
    See Also:
    Constant Field Values
  - RESULTS_FORMAT_XML
```
static final String RESULTS_FORMAT_XML
```
    String value for RESULTS_FORMAT parameter to specify XML as results format. This format may or may not be supported by a given application.
    
    See Also:
    Constant Field Values
  - RESULTS_FORMAT_JSON
```
static final String RESULTS_FORMAT_JSON
```
    String value for RESULTS_FORMAT parameter to specify JSON as results format. This is the default format, supported by all applications.
    
    See Also:
    Constant Field Values
  - RESULTS_FORMAT_XLSX
```
static final String RESULTS_FORMAT_XLSX
```
    String value for RESULTS_FORMAT parameter to specify XLSX as results format. This format may or may not be supported by a given application.
    
    See Also:
    Constant Field Values
  - WEBHOOK
```
static final String WEBHOOK
```
    Specifies the webhook to be called on job completion. A webhook is an HTTP URL that will be accessed by the DOcloud service upon job completion to notify the client. This is useful when the job is submitted by a web application and when polling the jobs status is not desirable. The DOcloud service will issue a POST on the passed URL with the job query parameter to indicate the job id that completed. The client can then access the API to retrieve the job status and results.
    
    See Also:
    Constant Field Values
  - DROPSOLVE
```
static final String DROPSOLVE
```
    Indicates if the job was submitted interactively using the DropSolve. This parameter is used internally, but may be accessed to distinguish between jobs submitted by API or interactively using the DropSolve.
    
    See Also:
    Constant Field Values
  - NOTIFY_COMPLETION
```
static final String NOTIFY_COMPLETION
```
    Indicates that an email notification will be sent upon completion of the job.
    
    See Also:
    Constant Field Values
  - ALERT_TIME
```
static final String ALERT_TIME
```
    Indicates that an email alert will be sent when a the jobs reaches the specified alert time limit.
    
    See Also:
    Constant Field Values
  - JOB_CORES
```
static final String JOB_CORES
```
    Only used in Reserved Bare Metal subscription, this parameter specifies cores used to process job. Value can vary from 1 to max number of cores of processing instance (currently 14 cores). If not specified, job uses all instance's cores
    
    See Also:
    Constant Field Values
  - JOB_MEMORY_MBYTES
```
static final String JOB_MEMORY_MBYTES
```
    Only used in Reserved Bare Metal subscription, this parameter specifies maximum memory megabytes used to process job. Value can vary from 512MB to max memory of processing instance (currently 252GB). If not specified, job uses all instance's memory.
    
    See Also:
    Constant Field Values
  - BLUEMIX_REGION
```
static final String BLUEMIX_REGION
```
    Indicates which Bluemix region was used if the job was submitted via Bluemix and if, and only if, the Bluemix region has been detected. This parameter is used internally, but may be accessed to distinguish from which Bluemix region the job was submitted if known.
    
    See Also:
    Constant Field Values
- Method Detail
  - getTimeLimit
```
Long getTimeLimit()
```
    Returns the time limit.
    
    Returns:
    The time limit.
    See Also:
    TIME_LIMIT
  - setTimeLimit
```
void setTimeLimit(Long value)
```
    Sets the time limit.
    
    Parameters:
    value - The time limit.
    See Also:
    TIME_LIMIT
  - getLogLimit
```
Long getLogLimit()
```
    Returns the log limit.
    
    Returns:
    The log limit.
    See Also:
    LOG_LIMIT
  - setLogLimit
```
void setLogLimit(Long value)
```
    Sets the log limit.
    
    Parameters:
    value - The log limit.
    See Also:
    LOG_LIMIT
  - getOplRunConfig
```
String getOplRunConfig()
```
    Returns the OPL run configuration.
    
    Returns:
    The OPL run configuration.
    See Also:
    OPL_RUN_CONFIG
  - setOplRunConfig
```
void setOplRunConfig(String value)
```
    Sets the OPL run configuration.
    
    Parameters:
    value - The OPL run configuration.
    See Also:
    OPL_RUN_CONFIG
  - getResultsFormat
```
String getResultsFormat()
```
    Returns results format.
    
    Returns:
    The results format.
    See Also:
    RESULTS_FORMAT
  - setResultsFormat
```
void setResultsFormat(String value)
```
    Sets the results format.
    
    Parameters:
    value - The results format.
    See Also:
    RESULTS_FORMAT
  - getWebhook
```
String getWebhook()
```
    Returns the webhook.
    
    Returns:
    The web hooks.
    See Also:
    WEBHOOK
  - setWebhook
```
void setWebhook(String value)
```
    Sets the webhook.
    
    Parameters:
    value - The the webhook.
    See Also:
    WEBHOOK
  - getDropSolve
```
Boolean getDropSolve()
```
    The DropSolve flag.
    
    Returns:
    The time limit.
    See Also:
    DROPSOLVE
  - getNotifyCompletion
```
Boolean getNotifyCompletion()
```
    Returns the notify completion flag.
    
    Returns:
    true if notification is requested, false otherwise
    See Also:
    NOTIFY_COMPLETION
  - setNotifyCompletion
```
void setNotifyCompletion(Boolean notify)
```
    Sets the notify completion flag.
    
    Parameters:
    notify - true if notification is requested, false otherwise
    See Also:
    NOTIFY_COMPLETION
  - getAlertTime
```
Long getAlertTime()
```
    Returns the alert limit.
    
    Returns:
    The alert limit or null if undefined.
    See Also:
    ALERT_TIME
  - getJobCores
```
Integer getJobCores()
```
    Returns cores used to process job.
    
    Returns:
    Cores used to process job.
    See Also:
    JOB_CORES
  - setJobCores
```
void setJobCores(Integer cores)
```
    Sets the number of cores used to process the job.
    
    Parameters:
    cores - The number of cores used to process the job.
    See Also:
    JOB_CORES
  - getJobMemoryMbytes
```
Integer getJobMemoryMbytes()
```
    Returns maximum memory megabytes used to process the job.
    
    Returns:
    Maximum memory megabytes used to process the job.
    See Also:
    JOB_MEMORY_MBYTES
  - setJobMemoryMbytes
```
void setJobMemoryMbytes(Integer mbytes)
```
    Sets maximum memory megabytes used to process the job.
    
    Parameters:
    mbytes - The maximum memory megabytes used to process the job.
    See Also:
    JOB_MEMORY_MBYTES
  - getBluemixRegion
```
String getBluemixRegion()
```
    Returns the Bluemix region that submitted this job (if known).
    
    Returns:
    The Bluemix region.
    See Also:
    BLUEMIX_REGION
  - setBluemixRegion
```
void setBluemixRegion(String bluemixRegion)
```
    Sets the Bluemix region that created this job (if known).
    
    Parameters:
    bluemixRegion - The Bluemix region.
    See Also:
    BLUEMIX_REGION
  - setAlertTime
```
void setAlertTime(Long value)
```
    Sets the alert limit.
    
    Parameters:
    value - The alert limit.
    See Also:
    ALERT_TIME
  - getAsBoolean
```
Boolean getAsBoolean(String name)
```
    Returns the parameter value as a Boolean.
    
    Parameters:
    name - The parameter name.
    
    Returns:
    the parameter value.
  - getAsString
```
String getAsString(String name)
```
    Returns the parameter value as a String.
    
    Parameters:
    name - The parameter name.
    
    Returns:
    the parameter value.
  - getAsDouble
```
Double getAsDouble(String name)
```
    Returns the parameter value as a Double.
    
    Parameters:
    name - The parameter name.
    
    Returns:
    the parameter value.
  - getAsLong
```
Long getAsLong(String name)
```
    Returns the parameter value as a Double.
    
    Parameters:
    name - The parameter name.
    
    Returns:
    the parameter value.
  - getAsInteger
```
Integer getAsInteger(String name)
```
    Returns the parameter value as a Integer.
    
    Parameters:
    name - The parameter name.
    
    Returns:
    the parameter value.
  - getAsBoolean
```
boolean getAsBoolean(String name,
                   boolean defaultValue)
```
    Returns the parameter value as a Boolean with a default value.
    
    Parameters:
    name - The parameter name.
    defaultValue - default value
    
    Returns:
    the parameter value.
  - getAsString
```
String getAsString(String name,
                 String defaultValue)
```
    Returns the parameter value as a String with a default value.
    
    Parameters:
    name - The parameter name.
    defaultValue - default value
    
    Returns:
    the parameter value.
  - getAsDouble
```
double getAsDouble(String name,
                 double defaultValue)
```
    Returns the parameter value as a Double with a default value.
    
    Parameters:
    name - The parameter name.
    defaultValue - default value
    
    Returns:
    the parameter value.
  - getAsLong
```
long getAsLong(String name,
             long defaultValue)
```
    Returns the parameter value as a Double with a default value.
    
    Parameters:
    name - The parameter name.
    defaultValue - default value
    
    Returns:
    the parameter value.
  - getAsInteger
```
int getAsInteger(String name,
               int defaultValue)
```
    Returns the parameter value as a Integer with a default value.
    
    Parameters:
    name - The parameter name.
    defaultValue - default value
    
    Returns:
    the parameter value.

Interface JobParameters

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Method Summary

Methods inherited from interface java.util.Map

Field Detail

TIME_LIMIT

LOG_LIMIT

OPL_RUN_CONFIG

RESULTS_FORMAT

RESULTS_FORMAT_TEXT

RESULTS_FORMAT_XML

RESULTS_FORMAT_JSON

RESULTS_FORMAT_XLSX

WEBHOOK

DROPSOLVE

NOTIFY_COMPLETION

ALERT_TIME

JOB_CORES

JOB_MEMORY_MBYTES

BLUEMIX_REGION

Method Detail

getTimeLimit

setTimeLimit

getLogLimit

setLogLimit

getOplRunConfig

setOplRunConfig

getResultsFormat

setResultsFormat

getWebhook

setWebhook

getDropSolve

getNotifyCompletion

setNotifyCompletion

getAlertTime

getJobCores

setJobCores

getJobMemoryMbytes

setJobMemoryMbytes

getBluemixRegion

setBluemixRegion

setAlertTime

getAsBoolean

getAsString

getAsDouble

getAsLong

getAsInteger

getAsBoolean

getAsString

getAsDouble

getAsLong

getAsInteger