excloud.api_java_client.1.0.257.source-code.index-all.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!






Index (Java Client for DOcplexcloud 1.0 API)










Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev
Next


Frames
No Frames


All Classes








A B C D E F G H I J K L M N O P R S T U V W 


A

abortJob(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Aborts execution of a job.

AbstractJobCallback - Class in com.ibm.optim.oaas.client.job

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

AbstractJobCallback() - Constructor for class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
addJobAttachment(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Adds an input job attachment with a given name.

ALERT_TIME - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Indicates that an email alert will be sent when a the jobs reaches the specified alert time
 limit.

application(String) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the application ID.

AttachmentContentWriter - Interface in com.ibm.optim.oaas.client.job

Interface of a custom attachment writer.

AttachmentNotFoundException - Exception in com.ibm.optim.oaas.client.job

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

AttachmentNotFoundException(String, String, OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.AttachmentNotFoundException
 
AttachmentNotFoundException(String, String) - Constructor for exception com.ibm.optim.oaas.client.job.AttachmentNotFoundException
 
AttachmentStorageLimitException - Exception in com.ibm.optim.oaas.client.job

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

AttachmentStorageLimitException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.AttachmentStorageLimitException
 
AttachmentStorageLimitException(String, JobSubscriptionImpl, long, String) - Constructor for exception com.ibm.optim.oaas.client.job.AttachmentStorageLimitException
 




B

BLUEMIX_REGION - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Indicates which Bluemix region was used if the job was submitted via Bluemix and if, and only if,
 the Bluemix region has been detected.

BLUEMIX_SERVICE_LABEL - Static variable in class com.ibm.optim.oaas.client.job.JobClientFactory

This is the text ("docplexcloud") that is used to search for a definition of
 the service in Bluemix when no name is provided.

build() - Method in interface com.ibm.optim.oaas.client.job.JobClientBuilder

Returns the configured job client.

build() - Method in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Returns the configure job executor.

build() - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Returns the configured job request.





C

clientEmail(String) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the client email address.

clientName(String) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the client name used to identify the client submitting a job.

com.ibm.optim.oaas.client - package 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.http - package com.ibm.optim.oaas.client.http

This package contains the classes that handle the HTTP connection.

com.ibm.optim.oaas.client.job - package com.ibm.optim.oaas.client.job

This package contains the classes to create and handle jobs.

com.ibm.optim.oaas.client.job.model - package com.ibm.optim.oaas.client.job.model

This package contains the classes that define the job model.

completed(JobResponse) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
completed(JobResponse) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when the executor has completed the processing of the job request.

copy(String) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Indicates that the new job should be constructed by copying an existing job.

copy(String, boolean) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Indicates that the new job should be constructed by copying an existing job.

copyJob(String, JobCreationData, boolean) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Creates a new job by copying an existing job.

create(int, int, int) - Static method in class com.ibm.optim.oaas.client.http.HttpClientFactory

Creates a standard HTTP client with specific values of socket timeout,
 connection timeout and maximum number of connections.

create(JobRequest, JobCallback) - Method in interface com.ibm.optim.oaas.client.job.JobExecutor

Creates a job request but does not submit the job.

create(JobExecutor) - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Creates the job as defined in this request.

create(JobExecutor) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Builds the request and creates the job using a given job executor.

created(JobResponse) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
created(JobResponse) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when a job has been created.

createDefault() - Static method in class com.ibm.optim.oaas.client.http.HttpClientFactory

Creates a standard HTTP client with the default socket timeout,
 connection timeout and maximum connections.

createDefault(String, String) - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Creates a default job client to connect to the given base URL using the
 given client ID.

createDefault(String, String, String) - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Creates a default job client to connect to the given base URL using the
 given client ID and client secret.

createDefault() - Static method in class com.ibm.optim.oaas.client.job.JobExecutorFactory

Returns the new default job executor.

createDefaultFromBluemix() - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Creates a default job client to connect to the IBM Decision Optimization service by looking up the
 service with the label starting with JobClientFactory.BLUEMIX_SERVICE_LABEL in the VCAP_SERVICES.

createDefaultFromBluemix(String) - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Creates a default job client to connect to the IBM Decision Optimization service by looking up the
 service name in the VCAP_SERVICES.

createJob(JobCreationData) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Creates a new job.

createJobAttachment(String, JobAttachmentCreationData) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Creates a job attachment for a given job.

custom() - Static method in class com.ibm.optim.oaas.client.http.HttpClientFactory

Creates a builder to configure a custom HTTP client.

custom(String, String) - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Returns a builder to configure the job client.

custom(String, String, String) - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Returns a builder to configure the job client.

custom() - Static method in class com.ibm.optim.oaas.client.job.JobExecutorFactory

Returns a job executor builder to configure a job executor.

customFromBluemix(String) - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Returns a builder to configure the job client.

customFromBluemix() - Static method in class com.ibm.optim.oaas.client.job.JobClientFactory

Returns a builder to configure the job client by looking for an IBM Decision Optimization
 service with the label starting with JobClientFactory.BLUEMIX_SERVICE_LABEL in the VCAP_SERVICES.





D

DEFAULT_CONNECTION_TIMEOUT - Static variable in class com.ibm.optim.oaas.client.http.HttpClientFactory

The default connection timeout.

DEFAULT_IDLE_TIMEOUT - Static variable in class com.ibm.optim.oaas.client.http.HttpIdleConnectionMonitorThread

Default idle timeout in seconds.

DEFAULT_INTERVAL - Static variable in class com.ibm.optim.oaas.client.http.HttpIdleConnectionMonitorThread

Default time interval to check for expired and idle connections.

DEFAULT_INTERVAL - Static variable in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Default time interval used to check job status in milliseconds.

DEFAULT_MAX_CONNECTIONS - Static variable in class com.ibm.optim.oaas.client.http.HttpClientFactory

The default maximum number of connections.

DEFAULT_RETRY - Static variable in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Default maximum retry attempts on calls to servers, when applicable.

DEFAULT_RETRY_DELAY - Static variable in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Default initial retry delay in milliseconds.

DEFAULT_SOCKET_TIMEOUT - Static variable in class com.ibm.optim.oaas.client.http.HttpClientFactory

The default socket timeout.

DEFAULT_THREADS - Static variable in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Default number of threads.

DEFAULT_TIMEOUT - Static variable in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Default timeout for the job monitoring.

deleteAllJobs() - Method in interface com.ibm.optim.oaas.client.job.JobClient

Deletes all jobs.

deleteJob(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Deletes a job.

deleteJobAttachment(String, String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Deletes a job attachment.

deleteJobAttachments(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Deletes all job attachments of a given job.

deleteOnCompletion(boolean) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Indicates that the job must be deleted on completion.

download(JobClient, String) - Method in interface com.ibm.optim.oaas.client.job.JobOutput

Downloads an attachment.

downloadJobAttachment(String, String, File) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads job attachment contents and stores them as a file.

downloadJobAttachment(String, String, OutputStream) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads job attachment contents and copies them to an output stream.

downloadJobAttachment(String, String, ObjectMapper, TypeReference<T>) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads job attachment contents as a JSON object.

downloadJobAttachment(String, String, ObjectMapper, Class<T>) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads job attachment contents as a JSON object.

downloadJobAttachment(String, String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads job attachment contents as a stream.

downloadLog(String, File) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads the log and stores it as a file.

downloadLog(String, OutputStream) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads the log and copies it to an output stream.

downloadLog(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Downloads the log as a stream.

DROPSOLVE - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Indicates if the job was submitted interactively using the DropSolve.





E

EmptyAttachmentException - Exception in com.ibm.optim.oaas.client.job

Validation exception indicating that the attachment is empty.

EmptyAttachmentException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.EmptyAttachmentException
 
EmptyAttachmentException(String) - Constructor for exception com.ibm.optim.oaas.client.job.EmptyAttachmentException
 
exception(JobResponse, Exception) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
exception(JobResponse, Exception) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when an exception has occurred.

execute(JobRequest) - Method in interface com.ibm.optim.oaas.client.job.JobExecutor

Executes a job request.

execute(JobRequest, JobCallback) - Method in interface com.ibm.optim.oaas.client.job.JobExecutor

Executes a job request and calls a callback at major steps of the
 execution.

execute(JobExecutor) - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Executes this request by submitting it to a job executor.

execute(JobExecutor) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Builds the request and executes it using a given job executor

executeJob(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Submits a job for execution.





F

failed(JobResponse) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
failed(JobResponse) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when a job has failed.

format(LogRecord) - Method in class com.ibm.optim.oaas.client.OaasLogFormatter
 
FormatNotSupportedException - Exception in com.ibm.optim.oaas.client.job

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

FormatNotSupportedException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.FormatNotSupportedException
 
FormatNotSupportedException(String, String) - Constructor for exception com.ibm.optim.oaas.client.job.FormatNotSupportedException
 




G

getAlertTime() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the alert limit.

getAllJobs() - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns all the jobs.

getApiClient() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Returns the job API client information.

getApplicationId() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the ID of the application associated with the job.

getApplicationId() - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Gets the ID of the application.

getApplicationVersion() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the version of the application associated with the submitted job.

getApplicationVersion() - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Gets version of the application.

getApplicationVersionUsed() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the version of the application used during job processing.

getAsBoolean(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Boolean.

getAsBoolean(String, boolean) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Boolean with a default value.

getAsDouble(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Double.

getAsDouble(String, double) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Double with a default value.

getAsInteger(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Integer.

getAsInteger(String, int) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Integer with a default value.

getAsLong(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Double.

getAsLong(String, long) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a Double with a default value.

getAsString(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a String.

getAsString(String, String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the parameter value as a String with a default value.

getAttachment(String) - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets an attachment to the job.

getAttachment(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Gets an attachment to the job.

getAttachmentId() - Method in exception com.ibm.optim.oaas.client.job.AttachmentNotFoundException

Returns the ID of the attachment associated with the exception.

getAttachments() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the attachments to the job.

getAttachments() - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Gets the attachments associated with creating the job.

getBluemixRegion() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the Bluemix region that submitted this job (if known).

getClient() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the job client.

getClient() - Method in interface com.ibm.optim.oaas.client.job.JobResponse

Returns the job client.

getClientEmail() - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Returns the client email used to for notification.

getClientName() - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Returns the client name used to identify the client submitting this job.

getCode() - Method in exception com.ibm.optim.oaas.client.OperationException

Returns the server returned code if defined.

getCode() - Method in interface com.ibm.optim.oaas.client.ServerExceptionData

Returns the server-side exception code.

getContent() - Method in interface com.ibm.optim.oaas.client.job.JobLogOutput

Returns the content of the log as specified in the builder such as a file
 or stream.

getContent() - Method in interface com.ibm.optim.oaas.client.job.JobOutput

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

getCopyJobId() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the job to copy if defined.

getCreatedAt() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the time when the job was created.

getCustomerIBMId() - Method in interface com.ibm.optim.oaas.client.job.model.JobSubscription

Gets the IBM ID of the subscription customer

getCustomerId() - Method in interface com.ibm.optim.oaas.client.job.model.JobSubscription

Gets the ID of the subscription customer

getData() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the job data used to create and initialize the job.

getData() - Method in interface com.ibm.optim.oaas.client.job.JobResponse

Returns The job data used to create and initialize the job.

getDate() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogRecord

Gets the time of the job log record.

getDetails() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets details about the job.

getDropSolve() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

The DropSolve flag.

getEmail() - Method in interface com.ibm.optim.oaas.client.job.model.JobApiClient

Gets the email address specified for this job.

getEmail() - Method in interface com.ibm.optim.oaas.client.job.model.JobSubscriber

Gets email address of the subscriber.

getEndedAt() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the time when the job completed.

getEndRecordedAt() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the time when the job completion status was recorded.

getEngineLogRecords() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogItem

Gets the optimization engine log records associated with the job.

getExceptionclass() - Method in interface com.ibm.optim.oaas.client.ServerExceptionData

Returns the server-side exception class name.

getExecutionStatus() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the execution status of the job.

getExecutionStatus() - Method in interface com.ibm.optim.oaas.client.job.model.JobStatus
 
getFailureInfo(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns job failure information for the given job.

getFailureInfo() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets information regarding the failure of the processing of the job.

getIBMId() - Method in interface com.ibm.optim.oaas.client.job.model.JobSubscriber

Gets the IBM ID of the subscriber.

getId() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets ID of the job.

getId() - Method in interface com.ibm.optim.oaas.client.job.model.JobApiClient

Gets the client ID used to create this job.

getId() - Method in interface com.ibm.optim.oaas.client.job.model.JobSubscription

Gets the ID of the job subscription.

getInput() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the list of configured input sources.

getInterruptedAt() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the time when the job was interrupted.

getInterruptionStatus() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets information about the current interruption status of the job.

getJob(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns a given job.

getJob() - Method in interface com.ibm.optim.oaas.client.job.JobResponse

Returns the job description as it was stored when it completed.

getJobAttachment(String, String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns the job attachment (if any) of a given job.

getJobAttachments(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns the list of job attachments for a job.

getJobAttachments(String, JobAttachmentType) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns the list of job attachments of a given type for a job.

getJobCores() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns cores used to process job.

getJobExecutionStatus(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns the job execution status.

getJobId() - Method in exception com.ibm.optim.oaas.client.job.AttachmentNotFoundException

Returns the ID of the job associated with the exception.

getJobId() - Method in exception com.ibm.optim.oaas.client.job.JobNotFoundException

Returns the ID of the associated job.

getJobId() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns The job ID once the job has been submitted.

getJobId() - Method in interface com.ibm.optim.oaas.client.job.JobResponse

Returns The job ID.

getJobId() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogItem

Gets the ID of the associated job.

getJobLogItems(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns the list of the log items of a given job.

getJobLogItems(String, long) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns the list of the log items of a given job starting at a given index
 (included).

getJobLogItems(String, long, boolean) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Returns the list of log items of a given job starting at a given index
 (included).

getJobMemoryMbytes() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns maximum memory megabytes used to process the job.

getLanguage() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the current language for the job.

getLastProcessingOwner() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the processor ID that executed the job.

getLength() - Method in interface com.ibm.optim.oaas.client.job.JobInput

Returns the length of the input source or -1 if unknown.

getLength() - Method in interface com.ibm.optim.oaas.client.job.model.JobAttachment

Gets the size of the attachment.

getLength() - Method in interface com.ibm.optim.oaas.client.job.model.JobAttachmentCreationData

Gets the size of the attachment.

getLevel() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogRecord

Gets the log level of the job log record.

getLivelog() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the live log stream if defined.

getLivelogDateFormat() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the live log date format.

getLocalizedMessage(String) - Method in exception com.ibm.optim.oaas.client.OaasException

Gets the localized message using a given locale.

getLocalizedMessage() - Method in exception com.ibm.optim.oaas.client.OaasException

Gets the localized message.

getLocalizedMessage(String) - Method in exception com.ibm.optim.oaas.client.OaasRuntimeException

Gets the localized message using a given locale.

getLocalizedMessage() - Method in exception com.ibm.optim.oaas.client.OaasRuntimeException

Gets the localized message.

getLocalizedMessage() - Method in interface com.ibm.optim.oaas.client.ServerExceptionData

Returns the server-side localized exception message.

getLogLimit() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the log limit.

getLogOutput() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns The list of job log output values.

getLogOutput() - Method in interface com.ibm.optim.oaas.client.job.JobResponse

Returns The list of job log output values.

getMessage() - Method in interface com.ibm.optim.oaas.client.job.model.JobFailureInfo

Gets a message describing the job failure.

getMessage() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogRecord

Gets the message of the job log record.

getMessage() - Method in exception com.ibm.optim.oaas.client.OaasException

Use localized messages if you have them.

getMessage() - Method in exception com.ibm.optim.oaas.client.OaasRuntimeException

Uses localized messages if you have them.

getMessage() - Method in interface com.ibm.optim.oaas.client.ServerExceptionData

Returns the server-side exception message.

getMessageCode() - Method in exception com.ibm.optim.oaas.client.OaasException

Returns the message code.

getMessageCode() - Method in exception com.ibm.optim.oaas.client.OaasRuntimeException

Returns the message code.

getName() - Method in interface com.ibm.optim.oaas.client.job.JobInput

Returns the name of the input source.

getName() - Method in interface com.ibm.optim.oaas.client.job.JobOutput

Returns the name of the output source.

getName() - Method in interface com.ibm.optim.oaas.client.job.model.JobApiClient

Gets the client name specified for this job.

getName() - Method in interface com.ibm.optim.oaas.client.job.model.JobAttachment

Gets the name of the attachment.

getName() - Method in interface com.ibm.optim.oaas.client.job.model.JobAttachmentCreationData

Gets the name of the attachment.

getName() - Method in interface com.ibm.optim.oaas.client.job.model.JobSubscriber

Gets name of the subscriber.

getNbLogItems() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the number of log items associated with the job, once it is completed.

getNotifyCompletion() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the notify completion flag.

getOperation() - Method in exception com.ibm.optim.oaas.client.OperationException

Returns the operations if defined.

getOplRunConfig() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the OPL run configuration.

getOutput() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the list of job result output values.

getOutput() - Method in interface com.ibm.optim.oaas.client.job.JobResponse

Returns The list of job result output values.

getOwner() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the owner of the job.

getParameters() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the parameters associated with the job.

getParameters() - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Gets the parameters associated with the job.

getParameters() - Method in exception com.ibm.optim.oaas.client.OaasException

Gets the parameters, if any, that were set in the constructor.

getParameters() - Method in exception com.ibm.optim.oaas.client.OaasRuntimeException

Gets the parameters, if any, that were set in the constructor.

getParameters() - Method in interface com.ibm.optim.oaas.client.ServerExceptionData

Returns the list of parameters associated with the exception.

getProcessingOwner() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the processor ID that is currently executing the job.

getRecreateJobId() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the job to recreate if defined.

getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.InvalidParameterException
 
getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.job.AttachmentNotFoundException
 
getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.job.JobNotFoundException
 
getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.job.SubscriptionException
 
getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.job.ValidationException
 
getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.OaasException

Gets the REST status code.

getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.OaasRuntimeException

Gets the REST status code.

getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.ParsingException
 
getRestStatusCode() - Method in exception com.ibm.optim.oaas.client.SecurityException
 
getResultsFormat() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns results format.

getRev() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the job revision value.

getRootCause(Throwable) - Static method in exception com.ibm.optim.oaas.client.OaasException

Gets the real (deepest) root cause of an exception.

getRootCause(Throwable) - Static method in exception com.ibm.optim.oaas.client.OaasRuntimeException

Gets the real (deepest) root cause of an exception.

getSeqid() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogItem

Sequence ID of the item in the job log.

getServerExceptionData() - Method in exception com.ibm.optim.oaas.client.OperationException

Returns the server side data returned for this exception if defined

getShallowCopy() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Indicates if a shallow copy was requested.

getSolveStatus() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets information about the current solve status of the job.

getSSLSocketFactory() - Static method in class com.ibm.optim.oaas.client.http.SNISSLConnectionSocketFactory
 
getStartedAt() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the time when the job was started.

getSubmittedAt() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the time when the job was submitted.

getSubscriber() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Returns the subscriber information.

getSubscription() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets job subscription information.

getTimeLimit() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the time limit.

getTimeout() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Returns the job monitoring timeout.

getType() - Method in interface com.ibm.optim.oaas.client.job.model.JobAttachment

Gets attachment type, indicating if the attachment is for input or output.

getType() - Method in interface com.ibm.optim.oaas.client.job.model.JobFailureInfo

Gets the job failure type.

getType() - Method in interface com.ibm.optim.oaas.client.job.model.JobSubscription

Gets type of the job subscription.

getUpdatedAt() - Method in interface com.ibm.optim.oaas.client.job.model.Job

Gets the time when the job details were updated.

getURI() - Method in exception com.ibm.optim.oaas.client.OperationException

Returns the server URI if defined.

getWebhook() - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Returns the webhook.





H

http(CloseableHttpClient) - Method in interface com.ibm.optim.oaas.client.job.JobClientBuilder

Sets the HTTP client.

HttpClientFactory - Class in com.ibm.optim.oaas.client.http

Factory class to create HTTP clients.

HttpClientFactory() - Constructor for class com.ibm.optim.oaas.client.http.HttpClientFactory
 
HttpIdleConnectionMonitorThread - Class in com.ibm.optim.oaas.client.http

This monitor thread can be used to evict expired and idle connections.

HttpIdleConnectionMonitorThread(CloseableHttpClient) - Constructor for class com.ibm.optim.oaas.client.http.HttpIdleConnectionMonitorThread

Creates a monitor thread for the given client with default values.

HttpIdleConnectionMonitorThread(CloseableHttpClient, int, int) - Constructor for class com.ibm.optim.oaas.client.http.HttpIdleConnectionMonitorThread

Creates a monitor thread for the given client with specific values.





I

IllegalJobStatusException - Exception in com.ibm.optim.oaas.client.job

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

IllegalJobStatusException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.IllegalJobStatusException
 
IllegalJobStatusException(String, JobExecutionStatus) - Constructor for exception com.ibm.optim.oaas.client.job.IllegalJobStatusException

Construct a job status exception for jobs with the given ID and status.

IllegalJobStatusException(String, String) - Constructor for exception com.ibm.optim.oaas.client.job.IllegalJobStatusException

Construct a job status exception for jobs with the given ID and status.

input(File) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets an input source to the given file.

input(String, File) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets an input source to the given file with a specific name.

input(String, URL) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets an input source to the given URL with a specific name.

input(String, InputStream) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets an input source to the given stream.

input(String, ObjectMapper, Object) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the input to the given JSON document.

input(JobInput) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Adds a custom job input source.

InternalException - Exception in com.ibm.optim.oaas.client

Internal runtime exception.

InternalException(Exception) - Constructor for exception com.ibm.optim.oaas.client.InternalException
 
interruption(JobResponse) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
interruption(JobResponse) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when a job is being interrupted or has already been interrupted.

interval(long, TimeUnit) - Method in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Sets the time interval used to check the job status.

InvalidApplicationException - Exception in com.ibm.optim.oaas.client.job

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

InvalidApplicationException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.InvalidApplicationException
 
InvalidApplicationException(String) - Constructor for exception com.ibm.optim.oaas.client.job.InvalidApplicationException
 
InvalidAttachmentNameException - Exception in com.ibm.optim.oaas.client.job

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

InvalidAttachmentNameException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.InvalidAttachmentNameException
 
InvalidAttachmentNameException(String, int, String) - Constructor for exception com.ibm.optim.oaas.client.job.InvalidAttachmentNameException
 
InvalidAttachmentsException - Exception in com.ibm.optim.oaas.client.job

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

InvalidAttachmentsException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.InvalidAttachmentsException
 
InvalidAttachmentsException(String) - Constructor for exception com.ibm.optim.oaas.client.job.InvalidAttachmentsException
 
InvalidClientIdException - Exception in com.ibm.optim.oaas.client

Security exception thrown when the client ID is not known or invalid.

InvalidClientIdException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.InvalidClientIdException
 
InvalidClientIdException(String) - Constructor for exception com.ibm.optim.oaas.client.InvalidClientIdException
 
InvalidParameterException - Exception in com.ibm.optim.oaas.client

Exception occurred when parsing a message body or parameter.

InvalidParameterException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.InvalidParameterException
 
InvalidParameterException(String, String) - Constructor for exception com.ibm.optim.oaas.client.InvalidParameterException
 
isActive(JobExecutionStatus) - Static method in enum com.ibm.optim.oaas.client.job.model.JobExecutionStatus

Check if the job is currently active based on the job status.

isDeleteOnCompletion() - Method in interface com.ibm.optim.oaas.client.job.JobRequest

Indicates if the job will be deleted upon completion.

isEnded(JobExecutionStatus) - Static method in enum com.ibm.optim.oaas.client.job.model.JobExecutionStatus

Check if the job execution has completed based on the job status.

isFailure(JobExecutionStatus) - Static method in enum com.ibm.optim.oaas.client.job.model.JobExecutionStatus

Check if the job has completed its execution with a failure
 based on the job status.

isRepeatable() - Method in interface com.ibm.optim.oaas.client.job.AttachmentContentWriter

Indicates if the content can be resent in a retry.

isRepeatable() - Method in interface com.ibm.optim.oaas.client.job.JobInput

Indicates if the upload can be repeated.

isWaiting(JobExecutionStatus) - Static method in enum com.ibm.optim.oaas.client.job.model.JobExecutionStatus

Check if the job is currently waiting to be processed based on the job status.





J

Job - Interface in com.ibm.optim.oaas.client.job.model

Model class representing a job that can be executed on the server.

JOB_CORES - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Only used in subscriptions that allow parallel processing,
 this parameter specifies the maximum number of cores used to process the job.

JOB_MEMORY_MBYTES - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Only used in subscriptions that allow parallel processing,
 this parameter specifies the maximum memory in megabytes used to process the job.

JobApiClient - Interface in com.ibm.optim.oaas.client.job.model

Job API client information.

JobAttachment - Interface in com.ibm.optim.oaas.client.job.model

Attachment to a job.

JobAttachmentCreationData - Interface in com.ibm.optim.oaas.client.job.model

Attachment to a job.

JobAttachmentType - Enum in com.ibm.optim.oaas.client.job.model

Enumeration of job attachment types.

JobCallback - Interface in com.ibm.optim.oaas.client.job

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

JobClient - Interface in com.ibm.optim.oaas.client.job

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

JobClientBuilder - Interface in com.ibm.optim.oaas.client.job

Builder interface to configure a job client.

JobClientFactory - Class in com.ibm.optim.oaas.client.job

Factory to create and configure job clients.

JobClientFactory() - Constructor for class com.ibm.optim.oaas.client.job.JobClientFactory
 
JobCreationData - Interface in com.ibm.optim.oaas.client.job.model

Job creation data used to initialize a new job associated with an application.

JobException - Exception in com.ibm.optim.oaas.client.job

Exception associated with a job.

JobExecutionStatus - Enum in com.ibm.optim.oaas.client.job.model

Enumeration of job execution status values.

JobExecutor - Interface in com.ibm.optim.oaas.client.job

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

JobExecutorBuilder - Interface in com.ibm.optim.oaas.client.job

Builder used to configure a job executor.

JobExecutorFactory - Class in com.ibm.optim.oaas.client.job

Factory to create and configure job executors.

JobExecutorFactory() - Constructor for class com.ibm.optim.oaas.client.job.JobExecutorFactory
 
JobFailureInfo - Interface in com.ibm.optim.oaas.client.job.model

Detailed information about a job failure, with the type of failure as well as
 a message describing the failure.

JobFailureType - Enum in com.ibm.optim.oaas.client.job.model

Enumeration of possible job failure types.

JobInput - Interface in com.ibm.optim.oaas.client.job

Interface for a job input source.

JobInterruptionStatus - Enum in com.ibm.optim.oaas.client.job.model

Enumeration describing the interruption status of executing a job.

JobLimitException - Exception in com.ibm.optim.oaas.client.job

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

JobLimitException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.JobLimitException
 
JobLimitException(String, JobSubscriptionImpl, int) - Constructor for exception com.ibm.optim.oaas.client.job.JobLimitException
 
JobLogItem - Interface in com.ibm.optim.oaas.client.job.model

Class representing an item in the log for a job.

JobLogOutput - Interface in com.ibm.optim.oaas.client.job

Interface of the job output source.

JobLogRecord - Interface in com.ibm.optim.oaas.client.job.model

Class representing a record in the log for a job.

JobNotFoundException - Exception in com.ibm.optim.oaas.client.job

Job exception thrown when the job cannot be found.

JobNotFoundException(String, OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.JobNotFoundException
 
JobNotFoundException(String) - Constructor for exception com.ibm.optim.oaas.client.job.JobNotFoundException
 
JobOutput - Interface in com.ibm.optim.oaas.client.job

Interface of a job output source.

JobParameters - Interface in com.ibm.optim.oaas.client.job.model

Stores various job parameters.

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

Interface of a job request.

JobRequestBuilder - Interface in com.ibm.optim.oaas.client.job

Builder to configure a job request.

JobResponse - Interface in com.ibm.optim.oaas.client.job

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

JobSolveStatus - Enum in com.ibm.optim.oaas.client.job.model

Enumeration of possible solve status values.

JobStatus - Interface in com.ibm.optim.oaas.client.job.model
 
JobSubscriber - Interface in com.ibm.optim.oaas.client.job.model

Job subscriber information.

JobSubscription - Interface in com.ibm.optim.oaas.client.job.model

Job subscription information.





K

killJob(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Kills the execution of a job.





L

livelog(OutputStream) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the live log output to a stream.

livelog(OutputStream, DateFormat) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the live log output to a stream.

log(File) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the log output to a file.

log(OutputStream) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the log output to a stream.

LOG_LIMIT - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Log size limit in characters.





M

missing() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogItem

Indicates if the log item is missing from the sequence when accessing the sequence in
 continuous mode.

MissingAttachmentNameException - Exception in com.ibm.optim.oaas.client.job

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

MissingAttachmentNameException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.MissingAttachmentNameException
 
MissingAttachmentNameException(String) - Constructor for exception com.ibm.optim.oaas.client.job.MissingAttachmentNameException
 
MissingAttachmentsException - Exception in com.ibm.optim.oaas.client.job

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

MissingAttachmentsException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.MissingAttachmentsException
 
MissingAttachmentsException() - Constructor for exception com.ibm.optim.oaas.client.job.MissingAttachmentsException
 
MissingExtensionException - Exception in com.ibm.optim.oaas.client.job

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

MissingExtensionException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.MissingExtensionException
 
MissingExtensionException(String) - Constructor for exception com.ibm.optim.oaas.client.job.MissingExtensionException
 
monitor(JobRequest, String, JobCallback) - Method in interface com.ibm.optim.oaas.client.job.JobExecutor

Monitor a job request that was submitted.





N

newInputJobAttachment(String) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Creates new input attachment data to be added to a job.

newJobCreationData() - Method in interface com.ibm.optim.oaas.client.job.JobClient

Creates a new object to create and initialize a new job.

newRequest() - Method in interface com.ibm.optim.oaas.client.job.JobClient

Creates a new job request builder using this client.

NOTIFY_COMPLETION - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Indicates that an email notification will be sent upon completion of the job.





O

OaasException - Exception in com.ibm.optim.oaas.client

Base class for OaaS exceptions.

OaasException(String, Throwable, Object...) - Constructor for exception com.ibm.optim.oaas.client.OaasException

Create an exception.

OaasException(String, Object...) - Constructor for exception com.ibm.optim.oaas.client.OaasException

Create an exception.

OaasException(Throwable) - Constructor for exception com.ibm.optim.oaas.client.OaasException

Create an exception.

OaasLogFormatter - Class in com.ibm.optim.oaas.client

A simple log formatter that prints a log message on one line and that can be
 configured in your application.

OaasLogFormatter() - Constructor for class com.ibm.optim.oaas.client.OaasLogFormatter
 
OaasRuntimeException - Exception in com.ibm.optim.oaas.client

Base class for OaaS runtime exceptions.

OaasRuntimeException(String, Throwable, Object...) - Constructor for exception com.ibm.optim.oaas.client.OaasRuntimeException

Creates an exception.

OaasRuntimeException(String, Object...) - Constructor for exception com.ibm.optim.oaas.client.OaasRuntimeException

Creates an exception.

OaasRuntimeException(Throwable) - Constructor for exception com.ibm.optim.oaas.client.OaasRuntimeException

Creates an exception.

OperationException - Exception in com.ibm.optim.oaas.client

Exception raised when accessing a remote resource using the HTTP protocol.

OperationException(String, String, int) - Constructor for exception com.ibm.optim.oaas.client.OperationException

Creates a client exception.

OperationException(String, String, int, ServerExceptionData) - Constructor for exception com.ibm.optim.oaas.client.OperationException

Creates a client exception with additional server information

OperationException(String, String, int, Exception) - Constructor for exception com.ibm.optim.oaas.client.OperationException

Creates a client exception with another exception as the source.

OperationException(String, String, int, String) - Constructor for exception com.ibm.optim.oaas.client.OperationException
 
OPL_RUN_CONFIG - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Specifies the name of the OPL run configuration to be executed by the OPL Worker.

output(File) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a file.

output(OutputStream) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a stream.

output(JobOutput) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Adds a custom result output.

output(ObjectMapper, TypeReference<T>) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a JSON object.

output(ObjectMapper, Class<T>) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a JSON object.

output(String, File) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a file for a particular output attachment.

output(String, ObjectMapper, Class<T>) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a JSON object for a particular output attachment.

output(String, ObjectMapper, TypeReference<T>) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a JSON object for a particular output attachment.

output(String, OutputStream) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the result output to a stream for a particular output attachment.





P

parameter(String, Object) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the value of a parameter.

ParsingException - Exception in com.ibm.optim.oaas.client

Exception occurred when parsing a message body or parameter.

ParsingException(Exception, String) - Constructor for exception com.ibm.optim.oaas.client.ParsingException
 
processed(JobResponse) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
processed(JobResponse) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when a job has been processed.





R

recreate(String) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Indicates that the new job should be constructed by replacing an existing job.

recreateJob(String, JobCreationData, boolean) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Creates a new job by replacing an existing job.

ResourceAccessException - Exception in com.ibm.optim.oaas.client

Thrown when access to a resource is not authorized.

ResourceAccessException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.ResourceAccessException
 
ResourceAccessException(String, String) - Constructor for exception com.ibm.optim.oaas.client.ResourceAccessException
 
RESULTS_FORMAT - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Specifies the format for returned results.

RESULTS_FORMAT_JSON - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

String value for JobParameters.RESULTS_FORMAT parameter to specify JSON as results format.

RESULTS_FORMAT_TEXT - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

String value for JobParameters.RESULTS_FORMAT parameter to specify TEXT as results format.

RESULTS_FORMAT_XLSX - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

String value for JobParameters.RESULTS_FORMAT parameter to specify XLSX as results format.

RESULTS_FORMAT_XML - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

String value for JobParameters.RESULTS_FORMAT parameter to specify XML as results format.

retry(int) - Method in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Sets maximum retry attempts on calls to servers, when applicable.

retryDelay(long, TimeUnit) - Method in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Sets the initial retry delay.

run() - Method in class com.ibm.optim.oaas.client.http.HttpIdleConnectionMonitorThread
 
running(JobResponse) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
running(JobResponse) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when a job has started to run.





S

SecurityException - Exception in com.ibm.optim.oaas.client

Exception to report invalid or forbidden operations

SecurityException(String, Throwable, Object...) - Constructor for exception com.ibm.optim.oaas.client.SecurityException

Create an exception.

SecurityException(String, Object...) - Constructor for exception com.ibm.optim.oaas.client.SecurityException

Create an exception.

SecurityException(int, String) - Constructor for exception com.ibm.optim.oaas.client.SecurityException
 
SecurityException(String) - Constructor for exception com.ibm.optim.oaas.client.SecurityException
 
SecurityException(Throwable) - Constructor for exception com.ibm.optim.oaas.client.SecurityException
 
ServerExceptionData - Interface in com.ibm.optim.oaas.client

Remote exception data returned by the server.

service(ExecutorService) - Method in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Sets the executor service used to manage threads and tasks within the job
 executor.

setAlertTime(Long) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the alert limit.

setApplicationId(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Sets the application ID.

setApplicationVersion(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Sets the version of the application.

setBluemixRegion(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the Bluemix region that created this job (if known).

setClientEmail(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Sets the client email address used for notification.

setClientName(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobCreationData

Sets the client name used to identify the client submitting this job.

setJobCores(Integer) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the number of cores used to process the job.

setJobMemoryMbytes(Integer) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets maximum memory megabytes used to process the job.

setLength(long) - Method in interface com.ibm.optim.oaas.client.job.model.JobAttachmentCreationData

Sets the length of the job attachment.

setLogLimit(Long) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the log limit.

setName(String) - Method in interface com.ibm.optim.oaas.client.job.JobOutput

Sets the name of the output.

setName(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobAttachmentCreationData

Sets the name of the job attachment.

setNotifyCompletion(Boolean) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the notify completion flag.

setOplRunConfig(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the OPL run configuration.

setResultsFormat(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the results format.

setTimeLimit(Long) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the time limit.

setWebhook(String) - Method in interface com.ibm.optim.oaas.client.job.model.JobParameters

Sets the webhook.

shutdown() - Method in class com.ibm.optim.oaas.client.http.HttpIdleConnectionMonitorThread

Shutdown the monitor thread.

shutdown() - Method in interface com.ibm.optim.oaas.client.job.JobExecutor

Stops the execution of the executor and releases all used resources.

SNISSLConnectionSocketFactory - Class in com.ibm.optim.oaas.client.http

This class provides a socket factory to handle SNI (Server Name Identification)
 with the IBM JDK and also perform some retries when it is difficult to connect.

stop() - Method in interface com.ibm.optim.oaas.client.job.model.JobLogItem

Indicates that the log item signals the end of the log item sequence when accessing the sequence in
 continuous mode.

StorageLimitException - Exception in com.ibm.optim.oaas.client.job

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

StorageLimitException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.StorageLimitException
 
StorageLimitException(String, JobSubscriptionImpl, long) - Constructor for exception com.ibm.optim.oaas.client.job.StorageLimitException
 
submit(JobRequest, JobCallback) - Method in interface com.ibm.optim.oaas.client.job.JobExecutor

Submits a job request but does not monitor the execution nor process the outputs and logs.

submitted(JobResponse) - Method in class com.ibm.optim.oaas.client.job.AbstractJobCallback
 
submitted(JobResponse) - Method in interface com.ibm.optim.oaas.client.job.JobCallback

Called when a job has been submitted.

SubscriptionException - Exception in com.ibm.optim.oaas.client.job

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





T

threads(int) - Method in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Sets the number of threads.

TIME_LIMIT - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Time limits in milliseconds.

timeout(long, TimeUnit) - Method in interface com.ibm.optim.oaas.client.job.JobExecutorBuilder

Sets the timeout for the job monitoring in milliseconds.

timeout(long, TimeUnit) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the timeout for the job monitoring.





U

UndefinedApplicationException - Exception in com.ibm.optim.oaas.client.job

Validation exception thrown when no application has been defined.

UndefinedApplicationException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.UndefinedApplicationException
 
UndefinedApplicationException() - Constructor for exception com.ibm.optim.oaas.client.job.UndefinedApplicationException
 
UndefinedSubscriptionException - Exception in com.ibm.optim.oaas.client.job

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

UndefinedSubscriptionException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.UndefinedSubscriptionException
 
UndefinedSubscriptionException(String, String) - Constructor for exception com.ibm.optim.oaas.client.job.UndefinedSubscriptionException
 
UnrecognizedAttachmentsException - Exception in com.ibm.optim.oaas.client.job

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

UnrecognizedAttachmentsException(Object[], OperationException) - Constructor for exception com.ibm.optim.oaas.client.job.UnrecognizedAttachmentsException
 
UnrecognizedAttachmentsException() - Constructor for exception com.ibm.optim.oaas.client.job.UnrecognizedAttachmentsException
 
upload(JobClient, String) - Method in interface com.ibm.optim.oaas.client.job.JobInput

Uploads this source as the contents of an attachment to a given job.

uploadJobAttachment(String, String, File) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Uploads job attachment contents as a file.

uploadJobAttachment(String, String, InputStream) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Uploads job attachment contents as a stream.

uploadJobAttachment(String, String, AttachmentContentWriter) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Uploads job attachment contents with a custom writer.

uploadJobAttachment(String, String, ObjectMapper, Object) - Method in interface com.ibm.optim.oaas.client.job.JobClient

Uploads job attachment contents as a JSON stream.

useBatchSubmitMode() - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Tries to create a job, upload attachments, and submit a job in one call to avoid network round
 trips.

UTC_ISO8601_DATE_FORMAT - Static variable in interface com.ibm.optim.oaas.client.job.JobRequest

Date format that can be specified for the live log.





V

ValidationException - Exception in com.ibm.optim.oaas.client.job

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

valueOf(String) - Static method in enum com.ibm.optim.oaas.client.job.model.JobAttachmentType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.ibm.optim.oaas.client.job.model.JobExecutionStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.ibm.optim.oaas.client.job.model.JobFailureType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.ibm.optim.oaas.client.job.model.JobInterruptionStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.ibm.optim.oaas.client.job.model.JobSolveStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.ibm.optim.oaas.client.job.model.JobAttachmentType

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum com.ibm.optim.oaas.client.job.model.JobExecutionStatus

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum com.ibm.optim.oaas.client.job.model.JobFailureType

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum com.ibm.optim.oaas.client.job.model.JobInterruptionStatus

Returns an array containing the constants of this enum type, in
the order they are declared.

values() - Static method in enum com.ibm.optim.oaas.client.job.model.JobSolveStatus

Returns an array containing the constants of this enum type, in
the order they are declared.

version(String) - Method in interface com.ibm.optim.oaas.client.job.JobRequestBuilder

Sets the application version to use during solve.





W

WEBHOOK - Static variable in interface com.ibm.optim.oaas.client.job.model.JobParameters

Specifies the webhook to be called on job completion.

writeTo(OutputStream) - Method in interface com.ibm.optim.oaas.client.job.AttachmentContentWriter

Writes the content of an attachment directly to the HTTP stream.


A B C D E F G H I J K L M N O P R S T U V W 




Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev
Next


Frames
No Frames


All Classes








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