org.finra.herd.sdk.api

Class JobApi

java.lang.Object

org.finra.herd.sdk.api.JobApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class JobApi
extends Object

Constructor Summary

Constructors

Constructor and Description
JobApi()
JobApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
Job	jobCreateJob(JobCreateRequest jobCreateRequest) createJob Creates and starts a new job asynchronously.
Job	jobDeleteJob(String id, JobDeleteRequest jobDeleteRequest) deleteJob Deletes a currently running job and preserves the job state in history.
Job	jobGetJob(String id, Boolean verbose) getJob Gets the details of a previously submitted job.
JobSummaries	jobGetJobs(String namespace, String jobName, String status, String startTime, String endTime) getJobs <p>Gets a list of job executions based on the specified filter parameters.</p> <p>Jobs' namespace to which you do not have READ permissions to will be omitted from the result.</p>
Job	jobSignalJob(JobSignalRequest jobSignalRequest) signalJob Signals the job with the receive task.
Job	jobUpdateJob(String id, JobUpdateRequest jobUpdateRequest) updateJob Activates or suspends a job execution.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobApi

public JobApi()

JobApi

public JobApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

jobGetJobs

public JobSummaries jobGetJobs(String namespace,
                               String jobName,
                               String status,
                               String startTime,
                               String endTime)
                        throws ApiException

getJobs <p>Gets a list of job executions based on the specified filter parameters.</p> <p>Jobs' namespace to which you do not have READ permissions to will be omitted from the result.</p>

Parameters:

namespace - an optional namespace filter

jobName - an optional job name filter

status - an optional job status filter

startTime - an optional start time filter (ex. 2015, 2015-12, 2015-12-12T3:4:5)

endTime - an optional end time filter (ex. 2015, 2015-12, 2015-12-12T3:4:5)

Returns:

JobSummaries

Throws:

ApiException

jobCreateJob

public Job jobCreateJob(JobCreateRequest jobCreateRequest)
                 throws ApiException

createJob Creates and starts a new job asynchronously. <p>Requires EXECUTE permission on namespace</p>

Parameters:

jobCreateRequest - the information needed to create the job.

Returns:

Job

Throws:

ApiException

jobGetJob

public Job jobGetJob(String id,
                     Boolean verbose)
              throws ApiException

getJob Gets the details of a previously submitted job. <p>Requires READ permission on namespace</p>

Parameters:

id - the job id.

verbose -

Returns:

Job

Throws:

ApiException

jobUpdateJob

public Job jobUpdateJob(String id,
                        JobUpdateRequest jobUpdateRequest)
                 throws ApiException

updateJob Activates or suspends a job execution. <p>Requires EXECUTE permission on namespace</p>

Parameters:

id - the job id

jobUpdateRequest - the job update request

Returns:

Job

Throws:

ApiException

jobDeleteJob

public Job jobDeleteJob(String id,
                        JobDeleteRequest jobDeleteRequest)
                 throws ApiException

deleteJob Deletes a currently running job and preserves the job state in history. <p>Requires EXECUTE permission on namespace</p>

Parameters:

id - The job id

jobDeleteRequest - The delete request

Returns:

Job

Throws:

ApiException

jobSignalJob

public Job jobSignalJob(JobSignalRequest jobSignalRequest)
                 throws ApiException

signalJob Signals the job with the receive task. <p>Requires EXECUTE permission on namespace</p>

Parameters:

jobSignalRequest - the information needed to signal the job.

Returns:

Job

Throws:

ApiException