com.ibm.optim.oaas.client.job.JobRequest.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api_java_client Show documentation

Java client API for DOCplexCloud, version 1.0-STABLE-b832

The newest version!







JobRequest (Java Client for DOcplexcloud 1.0 API)










Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.ibm.optim.oaas.client.job
Interface JobRequest








public interface JobRequest
Interface of a job request.
See Also:
JobClientBuilder.build()











Field Summary

Fields 

Modifier and Type
Field and Description


static com.ibm.icu.text.DateFormat
UTC_ISO8601_DATE_FORMAT
Date format that can be specified for the live log.










Method Summary

Methods 

Modifier and Type
Method and Description


Future<JobResponse>
create(JobExecutor executor)
Creates the job as defined in this request.



Future<JobResponse>
execute(JobExecutor executor)
Executes this request by submitting it to a job executor.



JobClient
getClient()
Returns the job client.



String
getCopyJobId()
Returns the job to copy if defined.



JobCreationData
getData()
Returns the job data used to create and initialize the job.



List<? extends JobInput>
getInput()
Returns the list of configured input sources.



String
getJobId()
Returns The job ID once the job has been submitted.



OutputStream
getLivelog()
Returns the live log stream if defined.



com.ibm.icu.text.DateFormat
getLivelogDateFormat()
Returns the live log date format.



List<? extends JobLogOutput>
getLogOutput()
Returns The list of job log output values.



List<? extends JobOutput>
getOutput()
Returns the list of job result output values.



String
getRecreateJobId()
Returns the job to recreate if defined.



boolean
getShallowCopy()
Indicates if a shallow copy was requested.



long
getTimeout()
Returns the job monitoring timeout.



boolean
isDeleteOnCompletion()
Indicates if the job will be deleted upon completion.
















Field Detail





UTC_ISO8601_DATE_FORMAT
static final com.ibm.icu.text.DateFormat UTC_ISO8601_DATE_FORMAT
Date format that can be specified for the live log.









Method Detail





getClient
JobClient getClient()
Returns the job client.
Returns:
The job client.







getData
JobCreationData getData()
Returns the job data used to create and initialize the job.
Returns:
The job creation data.







getInput
List<? extends JobInput> getInput()
Returns the list of configured input sources.
Returns:
The list of input sources.







getOutput
List<? extends JobOutput> getOutput()
Returns the list of job result output values.
Returns:
The list of job output.







getLogOutput
List<? extends JobLogOutput> getLogOutput()
Returns The list of job log output values.
Returns:
The list of job log output.







isDeleteOnCompletion
boolean isDeleteOnCompletion()
Indicates if the job will be deleted upon completion.
 A job is completed if its status
 is one of PROCESSED, FAILED, or INTERRUPTED.
Returns:
The job delete flag.







getTimeout
long getTimeout()
Returns the job monitoring timeout.
Returns:
The monitoring timeout.







execute
Future<JobResponse> execute(JobExecutor executor)
                            throws OperationException,
                                   IOException,
                                   InterruptedException,
                                   JobException
Executes this request by submitting it to a job executor.
Parameters:
executor - The job executor.
Returns:
The future job response.
Throws:
OperationException - if any other remote exception was raised.
IOException - if an I-O exception was raised.
InterruptedException - if the job was interrupted.
JobException - if the job failed.
See Also:
JobExecutor.execute(JobRequest)







create
Future<JobResponse> create(JobExecutor executor)
                           throws OperationException,
                                  IOException,
                                  InterruptedException,
                                  JobException
Creates the job as defined in this request.
Parameters:
executor - The job executor.
Returns:
The future job response.
Throws:
OperationException - if any other remote exception was raised.
IOException - if an I-O exception was raised.
InterruptedException - if the job was interrupted.
JobException - if the job failed.







getJobId
String getJobId()
Returns The job ID once the job has been submitted.
Returns:
The job ID or null if the request has not yet been submitted.







getLivelog
OutputStream getLivelog()
Returns the live log stream if defined.
Returns:
the live log stream or null if not defined.







getLivelogDateFormat
com.ibm.icu.text.DateFormat getLivelogDateFormat()
Returns the live log date format.
Returns:
The date format.







getCopyJobId
String getCopyJobId()
Returns the job to copy if defined.
Returns:
the job ID to copy or null if undefined.







getShallowCopy
boolean getShallowCopy()
Indicates if a shallow copy was requested.
Returns:
true if shallow copy, false otherwise
See Also:
getCopyJobId()







getRecreateJobId
String getRecreateJobId()
Returns the job to recreate if defined.
Returns:
the job ID to recreate or null if undefined.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2015–2017 IBM Corporation. Licensed under the Apache License, Version 2.0.

Modifier and Type	Method and Description
`Future<JobResponse>`	`create(JobExecutor executor)` Creates the job as defined in this request.
`Future<JobResponse>`	`execute(JobExecutor executor)` Executes this request by submitting it to a job executor.
`JobClient`	`getClient()` Returns the job client.
`String`	`getCopyJobId()` Returns the job to copy if defined.
`JobCreationData`	`getData()` Returns the job data used to create and initialize the job.
`List<? extends JobInput>`	`getInput()` Returns the list of configured input sources.
`String`	`getJobId()` Returns The job ID once the job has been submitted.
`OutputStream`	`getLivelog()` Returns the live log stream if defined.
`com.ibm.icu.text.DateFormat`	`getLivelogDateFormat()` Returns the live log date format.
`List<? extends JobLogOutput>`	`getLogOutput()` Returns The list of job log output values.
`List<? extends JobOutput>`	`getOutput()` Returns the list of job result output values.
`String`	`getRecreateJobId()` Returns the job to recreate if defined.
`boolean`	`getShallowCopy()` Indicates if a shallow copy was requested.
`long`	`getTimeout()` Returns the job monitoring timeout.
`boolean`	`isDeleteOnCompletion()` Indicates if the job will be deleted upon completion.