| Package | Description |
|---|---|
| com.ibm.optim.oaas.client |
This package contains the base exceptions that can be thrown by the client library
and some utility classes.
|
| com.ibm.optim.oaas.client.job |
This package contains the classes to create and handle jobs.
|
| Constructor and Description |
|---|
InvalidClientIdException(Object[] params,
OperationException e) |
InvalidParameterException(Object[] params,
OperationException e) |
ResourceAccessException(Object[] params,
OperationException e) |
| Modifier and Type | Method and Description |
|---|---|
void |
JobClient.abortJob(String jobid)
Aborts execution of a job.
|
String |
JobClient.copyJob(String jobid,
JobCreationData data,
boolean shallow)
Creates a new job by copying an existing job.
|
Future<JobResponse> |
JobRequestBuilder.create(JobExecutor executor)
Builds the request and creates the job using a given job executor.
|
Future<JobResponse> |
JobRequest.create(JobExecutor executor)
Creates the job as defined in this request.
|
Future<JobResponse> |
JobExecutor.create(JobRequest request,
JobCallback callback)
Creates a job request but does not submit the job.
|
String |
JobClient.createJob(JobCreationData data)
Creates a new job.
|
String |
JobClient.createJobAttachment(String jobid,
JobAttachmentCreationData att)
Creates a job attachment for a given job.
|
void |
JobClient.deleteAllJobs()
Deletes all jobs.
|
boolean |
JobClient.deleteJob(String jobid)
Deletes a job.
|
boolean |
JobClient.deleteJobAttachment(String jobid,
String attid)
Deletes a job attachment.
|
void |
JobClient.deleteJobAttachments(String jobid)
Deletes all job attachments of a given job.
|
void |
JobOutput.download(JobClient client,
String jobid)
Downloads an attachment.
|
InputStream |
JobClient.downloadJobAttachment(String jobid,
String attid)
Downloads job attachment contents as a stream.
|
void |
JobClient.downloadJobAttachment(String jobid,
String attid,
File file)
Downloads job attachment contents and stores them as a file.
|
<T> T |
JobClient.downloadJobAttachment(String jobid,
String attid,
com.fasterxml.jackson.databind.ObjectMapper mapper,
Class<T> type)
Downloads job attachment contents as a JSON object.
|
<T> T |
JobClient.downloadJobAttachment(String jobid,
String attid,
com.fasterxml.jackson.databind.ObjectMapper mapper,
com.fasterxml.jackson.core.type.TypeReference<T> type)
Downloads job attachment contents as a JSON object.
|
void |
JobClient.downloadJobAttachment(String jobid,
String attid,
OutputStream stream)
Downloads job attachment contents and copies them to an output stream.
|
InputStream |
JobClient.downloadLog(String jobid)
Downloads the log as a stream.
|
void |
JobClient.downloadLog(String jobid,
File file)
Downloads the log and stores it as a file.
|
void |
JobClient.downloadLog(String jobid,
OutputStream stream)
Downloads the log and copies it to an output stream.
|
Future<JobResponse> |
JobRequestBuilder.execute(JobExecutor executor)
Builds the request and executes it using a given job executor
|
Future<JobResponse> |
JobRequest.execute(JobExecutor executor)
Executes this request by submitting it to a job executor.
|
Future<JobResponse> |
JobExecutor.execute(JobRequest request)
Executes a job request.
|
Future<JobResponse> |
JobExecutor.execute(JobRequest request,
JobCallback callback)
Executes a job request and calls a callback at major steps of the
execution.
|
void |
JobClient.executeJob(String jobid)
Submits a job for execution.
|
List<? extends Job> |
JobClient.getAllJobs()
Returns all the jobs.
|
JobFailureInfo |
JobClient.getFailureInfo(String jobid)
Returns job failure information for the given job.
|
Job |
JobClient.getJob(String jobid)
Returns a given job.
|
JobAttachment |
JobClient.getJobAttachment(String jobid,
String attid)
Returns the job attachment (if any) of a given job.
|
List<? extends JobAttachment> |
JobClient.getJobAttachments(String jobid)
Returns the list of job attachments for a job.
|
List<? extends JobAttachment> |
JobClient.getJobAttachments(String jobid,
JobAttachmentType type)
Returns the list of job attachments of a given type for a job.
|
JobExecutionStatus |
JobClient.getJobExecutionStatus(String jobid)
Returns the job execution status.
|
List<? extends JobLogItem> |
JobClient.getJobLogItems(String jobid)
Returns the list of the log items of a given job.
|
List<? extends JobLogItem> |
JobClient.getJobLogItems(String jobid,
long start)
Returns the list of the log items of a given job starting at a given index
(included).
|
List<? extends JobLogItem> |
JobClient.getJobLogItems(String jobid,
long start,
boolean continuous)
Returns the list of log items of a given job starting at a given index
(included).
|
void |
JobClient.killJob(String jobid)
Kills the execution of a job.
|
Future<JobResponse> |
JobExecutor.monitor(JobRequest request,
String jobid,
JobCallback callback)
Monitor a job request that was submitted.
|
String |
JobClient.recreateJob(String jobid,
JobCreationData data,
boolean execute)
Creates a new job by replacing an existing job.
|
Future<JobResponse> |
JobExecutor.submit(JobRequest request,
JobCallback callback)
Submits a job request but does not monitor the execution nor process the outputs and logs.
|
void |
JobInput.upload(JobClient client,
String jobid)
Uploads this source as the contents of an attachment to a given job.
|
void |
JobClient.uploadJobAttachment(String jobid,
String attid,
AttachmentContentWriter writer)
Uploads job attachment contents with a custom writer.
|
void |
JobClient.uploadJobAttachment(String jobid,
String attid,
File file)
Uploads job attachment contents as a file.
|
void |
JobClient.uploadJobAttachment(String jobid,
String attid,
InputStream stream)
Uploads job attachment contents as a stream.
|
void |
JobClient.uploadJobAttachment(String jobid,
String attid,
com.fasterxml.jackson.databind.ObjectMapper mapper,
Object obj)
Uploads job attachment contents as a JSON stream.
|
Copyright © 2015–2017 IBM Corporation. Licensed under the Apache License, Version 2.0.