org.finra.herd.sdk.api

Class JobDefinitionApi

java.lang.Object

org.finra.herd.sdk.api.JobDefinitionApi

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

Constructor Summary

Constructors

Constructor and Description
JobDefinitionApi()
JobDefinitionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
JobDefinition	jobDefinitionCreateJobDefinition(JobDefinitionCreateRequest jobDefinitionCreateRequest) createJobDefinition Creates a new job definition.
JobDefinition	jobDefinitionGetJobDefinition(String namespace, String jobName) getJobDefinition Gets an existing job definition.
JobDefinition	jobDefinitionUpdateJobDefinition(String namespace, String jobName, JobDefinitionUpdateRequest jobDefinitionUpdateRequest) updateJobDefinition Updates an existing job definition.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobDefinitionApi

public JobDefinitionApi()

JobDefinitionApi

public JobDefinitionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

jobDefinitionCreateJobDefinition

public JobDefinition jobDefinitionCreateJobDefinition(JobDefinitionCreateRequest jobDefinitionCreateRequest)
                                               throws ApiException

createJobDefinition Creates a new job definition. <p>Requires WRITE permission on namespace</p>

Parameters:

jobDefinitionCreateRequest - the information needed to create the job definition.

Returns:

JobDefinition

Throws:

ApiException

jobDefinitionGetJobDefinition

public JobDefinition jobDefinitionGetJobDefinition(String namespace,
                                                   String jobName)
                                            throws ApiException

getJobDefinition Gets an existing job definition. <p>Requires READ permission on namespace</p>

Parameters:

namespace - the namespace of the job definition.

jobName - the job name of the job definition.

Returns:

JobDefinition

Throws:

ApiException

jobDefinitionUpdateJobDefinition

public JobDefinition jobDefinitionUpdateJobDefinition(String namespace,
                                                      String jobName,
                                                      JobDefinitionUpdateRequest jobDefinitionUpdateRequest)
                                               throws ApiException

updateJobDefinition Updates an existing job definition. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace of the job definition.

jobName - the job name of the job definition.

jobDefinitionUpdateRequest - the information needed to update the job definition.

Returns:

JobDefinition

Throws:

ApiException