Package Avalara.SDK.api.A1099.V2

Class JobsApi

java.lang.Object

Avalara.SDK.api.A1099.V2.JobsApi

public class JobsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JobsApi.GetJobRequest	Represents the Request object for the GetJob API

Constructor Summary

Constructors

Constructor	Description
JobsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
JobsApi.GetJobRequest	getGetJobRequest()	Getter function to instantiate Request class
int	getHostIndex()
JobResponse	getJob(JobsApi.GetJobRequest requestParameters)	Retrieves information about the job Retrieves information about the job
okhttp3.Call	getJobAsync(JobsApi.GetJobRequest requestParameters, ApiCallback<JobResponse> _callback)	Retrieves information about the job (asynchronously) Retrieves information about the job
okhttp3.Call	getJobCall(JobsApi.GetJobRequest requestParameters, ApiCallback _callback)	Build call for getJob
ApiResponse<JobResponse>	getJobWithHttpInfo(JobsApi.GetJobRequest requestParameters)	Retrieves information about the job Retrieves information about the job
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsApi

public JobsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getJobCall

public okhttp3.Call getJobCall(JobsApi.GetJobRequest requestParameters,
                               ApiCallback _callback)
                        throws ApiException

Build call for getJob

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
404	Not Found	-
500	Server Error	-
401	Unauthorized	-

getJob

public JobResponse getJob(JobsApi.GetJobRequest requestParameters)
                   throws ApiException

Retrieves information about the job Retrieves information about the job

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

JobResponse

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
404	Not Found	-
500	Server Error	-
401	Unauthorized	-

getJobWithHttpInfo

public ApiResponse<JobResponse> getJobWithHttpInfo(JobsApi.GetJobRequest requestParameters)
                                            throws ApiException

Retrieves information about the job Retrieves information about the job

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<JobResponse>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
404	Not Found	-
500	Server Error	-
401	Unauthorized	-

getJobAsync

public okhttp3.Call getJobAsync(JobsApi.GetJobRequest requestParameters,
                                ApiCallback<JobResponse> _callback)
                         throws ApiException

Retrieves information about the job (asynchronously) Retrieves information about the job

Parameters:

requestOptions - Object which represents the options available for a given API/request

_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

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
404	Not Found	-
500	Server Error	-
401	Unauthorized	-

getGetJobRequest

public JobsApi.GetJobRequest getGetJobRequest()

Getter function to instantiate Request class