com.ibm.optim.oaas.client.job.JobOutput.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!







JobOutput (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 JobOutput








public interface JobOutput
Interface of a job output source. The job executor has predefined functions to declare and download attachments
 to streams or files. A job output lets you define a custom source and when the executor is ready to
 download the content of the attachment, it will call the download function that you can define.











Method Summary

Methods 

Modifier and Type
Method and Description


void
download(JobClient client,
        String jobid)
Downloads an attachment.



Object
getContent()
Returns the content of the attachment as specified in the builder such as a
 file, stream or object.



String
getName()
Returns the name of the output source.



void
setName(String name)
Sets the name of the output.
















Method Detail





getName
String getName()
Returns the name of the output source.
Returns:
The output source name.







getContent
Object getContent()
Returns the content of the attachment as specified in the builder such as a
 file, stream or object.
Returns:
The content.







download
void download(JobClient client,
            String jobid)
              throws JobNotFoundException,
                     AttachmentNotFoundException,
                     OperationException,
                     IOException
Downloads an attachment.
Parameters:
client - The job client.
jobid - The job ID.
Throws:
OperationException - if any other remote exception was raised.
IOException - if an I-O exception was raised.
AttachmentNotFoundException - if the attachment was not declared or not found.
JobNotFoundException - if the job is not found with the given id.







setName
void setName(String name)
Sets the name of the output. This is called by the executor when the output name is
 retrieved.
Parameters:
name - The output name.













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
`void`	`download(JobClient client, String jobid)` Downloads an attachment.
`Object`	`getContent()` Returns the content of the attachment as specified in the builder such as a file, stream or object.
`String`	`getName()` Returns the name of the output source.
`void`	`setName(String name)` Sets the name of the output.