com.codedx.client.api

Class JobsApi

java.lang.Object

com.codedx.client.api.JobsApi

public class JobsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JobsApi()
JobsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
java.io.File	getJobResult(java.lang.String jobId) Get Job Result Fetches the result from a job.
com.squareup.okhttp.Call	getJobResultAsync(java.lang.String jobId, ApiCallback<java.io.File> callback) Get Job Result (asynchronously) Fetches the result from a job.
com.squareup.okhttp.Call	getJobResultCall(java.lang.String jobId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getJobResult
ApiResponse<java.io.File>	getJobResultWithHttpInfo(java.lang.String jobId) Get Job Result Fetches the result from a job.
Job	getJobStatus(java.lang.String jobId) Query Job Status Queries the status of a running job.
com.squareup.okhttp.Call	getJobStatusAsync(java.lang.String jobId, ApiCallback<Job> callback) Query Job Status (asynchronously) Queries the status of a running job.
com.squareup.okhttp.Call	getJobStatusCall(java.lang.String jobId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getJobStatus
ApiResponse<Job>	getJobStatusWithHttpInfo(java.lang.String jobId) Query Job Status Queries the status of a running job.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobsApi

public JobsApi()

JobsApi

public JobsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getJobResultCall

public com.squareup.okhttp.Call getJobResultCall(java.lang.String jobId,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for getJobResult

Parameters:

jobId - The ID of the job to get the result for (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getJobResult

public java.io.File getJobResult(java.lang.String jobId)
                          throws ApiException

Get Job Result Fetches the result from a job.

Parameters:

jobId - The ID of the job to get the result for (required)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getJobResultWithHttpInfo

public ApiResponse<java.io.File> getJobResultWithHttpInfo(java.lang.String jobId)
                                                   throws ApiException

Get Job Result Fetches the result from a job.

Parameters:

jobId - The ID of the job to get the result for (required)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getJobResultAsync

public com.squareup.okhttp.Call getJobResultAsync(java.lang.String jobId,
                                                  ApiCallback<java.io.File> callback)
                                           throws ApiException

Get Job Result (asynchronously) Fetches the result from a job.

Parameters:

jobId - The ID of the job to get the result for (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getJobStatusCall

public com.squareup.okhttp.Call getJobStatusCall(java.lang.String jobId,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for getJobStatus

Parameters:

jobId - The ID of the job to check (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getJobStatus

public Job getJobStatus(java.lang.String jobId)
                 throws ApiException

Query Job Status Queries the status of a running job.

Parameters:

jobId - The ID of the job to check (required)

Returns:

Job

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getJobStatusWithHttpInfo

public ApiResponse<Job> getJobStatusWithHttpInfo(java.lang.String jobId)
                                          throws ApiException

Query Job Status Queries the status of a running job.

Parameters:

jobId - The ID of the job to check (required)

Returns:

ApiResponse<Job>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getJobStatusAsync

public com.squareup.okhttp.Call getJobStatusAsync(java.lang.String jobId,
                                                  ApiCallback<Job> callback)
                                           throws ApiException

Query Job Status (asynchronously) Queries the status of a running job.

Parameters:

jobId - The ID of the job to check (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object