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







com.ibm.optim.oaas.client.job (Java Client for DOcplexcloud 1.0 API)










Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Package
Next Package


Frames
No Frames


All Classes









Package com.ibm.optim.oaas.client.job

This package contains the classes to create and handle jobs.

See: Description





Interface Summary 

Interface
Description



AttachmentContentWriter

Interface of a custom attachment writer.



JobCallback

Provides notifications when a job is executed and monitored by an executor.



JobClient

Interface of a job client used to create, submit and monitor optimization
 jobs.



JobClientBuilder

Builder interface to configure a job client.



JobExecutor

A job executor is in charge of submitting and monitoring the execution of
 jobs.



JobExecutorBuilder

Builder used to configure a job executor.



JobInput

Interface for a job input source.



JobLogOutput

Interface of the job output source.



JobOutput

Interface of a job output source.



JobRequest

Interface of a job request.



JobRequestBuilder

Builder to configure a job request.



JobResponse

Interface of a job response to get the job status and result values.







Class Summary 

Class
Description



AbstractJobCallback

Provides an empty implementation of the JobCallback so that only the targeted
 events can be overridden.



JobClientFactory

Factory to create and configure job clients.



JobExecutorFactory

Factory to create and configure job executors.







Exception Summary 

Exception
Description



AttachmentNotFoundException

Job exception indicating that the attachment or the attachment content was not found.



AttachmentStorageLimitException

Exception that is thrown when a given attachment size has exceeded the limit defined in the
 subscription.



EmptyAttachmentException

Validation exception indicating that the attachment is empty.



FormatNotSupportedException

Validation exception thrown when the requested result format is not supported by the job processor.



IllegalJobStatusException

Validation exception thrown when an action is attempted on a job which does not have the right status
 to handle this action.



InvalidApplicationException

Validation exception thrown when the application is not valid or not supported.



InvalidAttachmentNameException

Validation exception thrown when the name of an attachment is invalid.



InvalidAttachmentsException

Validation exception thrown when the given combination of attachment types is not supported by the
 specified application.



JobException

Exception associated with a job.



JobLimitException

Subscription exception thrown when the maximum number of jobs has been reached.



JobNotFoundException

Job exception thrown when the job cannot be found.



MissingAttachmentNameException

Validation exception thrown when the name of an attachment is missing.



MissingAttachmentsException

Validation exception thrown when no application was specified and no attachments were
 declared.



MissingExtensionException

Validation exception thrown when the application is not valid or not supported.



StorageLimitException

Subscription exception thrown when the total storage limit defined in the subscription has been
 reached.



SubscriptionException

Base exception of all issues related to subscription settings and limits.



UndefinedApplicationException

Validation exception thrown when no application has been defined.



UndefinedSubscriptionException

Security exception thrown when the subscription is invalid or has not been defined.



UnrecognizedAttachmentsException

Validation exception thrown when the application was not set and the combination of attachments is
 not recognized as valid for any application.



ValidationException

Base exception for issues related to the application (OPL or CPLEX) and the
 supported type of attachments.









Package com.ibm.optim.oaas.client.job Description
This package contains the classes to create and handle jobs.





Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Package
Next Package


Frames
No Frames


All Classes








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

Interface	Description
AttachmentContentWriter	Interface of a custom attachment writer.
JobCallback	Provides notifications when a job is executed and monitored by an executor.
JobClient	Interface of a job client used to create, submit and monitor optimization jobs.
JobClientBuilder	Builder interface to configure a job client.
JobExecutor	A job executor is in charge of submitting and monitoring the execution of jobs.
JobExecutorBuilder	Builder used to configure a job executor.
JobInput	Interface for a job input source.
JobLogOutput	Interface of the job output source.
JobOutput	Interface of a job output source.
JobRequest	Interface of a job request.
JobRequestBuilder	Builder to configure a job request.
JobResponse	Interface of a job response to get the job status and result values.

Class	Description
AbstractJobCallback	Provides an empty implementation of the JobCallback so that only the targeted events can be overridden.
JobClientFactory	Factory to create and configure job clients.
JobExecutorFactory	Factory to create and configure job executors.

Exception	Description
AttachmentNotFoundException	Job exception indicating that the attachment or the attachment content was not found.
AttachmentStorageLimitException	Exception that is thrown when a given attachment size has exceeded the limit defined in the subscription.
EmptyAttachmentException	Validation exception indicating that the attachment is empty.
FormatNotSupportedException	Validation exception thrown when the requested result format is not supported by the job processor.
IllegalJobStatusException	Validation exception thrown when an action is attempted on a job which does not have the right status to handle this action.
InvalidApplicationException	Validation exception thrown when the application is not valid or not supported.
InvalidAttachmentNameException	Validation exception thrown when the name of an attachment is invalid.
InvalidAttachmentsException	Validation exception thrown when the given combination of attachment types is not supported by the specified application.
JobException	Exception associated with a job.
JobLimitException	Subscription exception thrown when the maximum number of jobs has been reached.
JobNotFoundException	Job exception thrown when the job cannot be found.
MissingAttachmentNameException	Validation exception thrown when the name of an attachment is missing.
MissingAttachmentsException	Validation exception thrown when no application was specified and no attachments were declared.
MissingExtensionException	Validation exception thrown when the application is not valid or not supported.
StorageLimitException	Subscription exception thrown when the total storage limit defined in the subscription has been reached.
SubscriptionException	Base exception of all issues related to subscription settings and limits.
UndefinedApplicationException	Validation exception thrown when no application has been defined.
UndefinedSubscriptionException	Security exception thrown when the subscription is invalid or has not been defined.
UnrecognizedAttachmentsException	Validation exception thrown when the application was not set and the combination of attachments is not recognized as valid for any application.
ValidationException	Base exception for issues related to the application (OPL or CPLEX) and the supported type of attachments.