Package com.w3asel.inventree.api

Class BackgroundTaskApi

java.lang.Object
com.w3asel.inventree.api.BackgroundTaskApi
public class BackgroundTaskApi extends Object

  • Constructor Details

    • BackgroundTaskApi

      public BackgroundTaskApi()

    • BackgroundTaskApi

      public BackgroundTaskApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • backgroundTaskFailedBulkDestroyCall

      public okhttp3.Call backgroundTaskFailedBulkDestroyCall(@Nonnull BulkRequest bulkRequest, ApiCallback _callback) throws ApiException
      Build call for backgroundTaskFailedBulkDestroy
      Parameters:
      bulkRequest - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskFailedBulkDestroy

      public void backgroundTaskFailedBulkDestroy(@Nonnull BulkRequest bulkRequest) throws ApiException
      Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskFailedBulkDestroyWithHttpInfo

      public ApiResponse<Void> backgroundTaskFailedBulkDestroyWithHttpInfo(@Nonnull BulkRequest bulkRequest) throws ApiException
      Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskFailedBulkDestroyAsync

      public okhttp3.Call backgroundTaskFailedBulkDestroyAsync(@Nonnull BulkRequest bulkRequest, ApiCallback<Void> _callback) throws ApiException
      (asynchronously) Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (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
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskFailedListCall

      public okhttp3.Call backgroundTaskFailedListCall(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search, ApiCallback _callback) throws ApiException
      Build call for backgroundTaskFailedList
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, started, stopped. (optional)
      search - A search term. Searched fields: func. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskFailedList

      public PaginatedFailedTaskList backgroundTaskFailedList(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search) throws ApiException
      Provides a read-only list of currently failed tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, started, stopped. (optional)
      search - A search term. Searched fields: func. (optional)
      Returns:
      PaginatedFailedTaskList
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskFailedListWithHttpInfo

      public ApiResponse<PaginatedFailedTaskList> backgroundTaskFailedListWithHttpInfo(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search) throws ApiException
      Provides a read-only list of currently failed tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, started, stopped. (optional)
      search - A search term. Searched fields: func. (optional)
      Returns:
      ApiResponse<PaginatedFailedTaskList>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskFailedListAsync

      public okhttp3.Call backgroundTaskFailedListAsync(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search, ApiCallback<PaginatedFailedTaskList> _callback) throws ApiException
      (asynchronously) Provides a read-only list of currently failed tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, started, stopped. (optional)
      search - A search term. Searched fields: func. (optional)
      _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:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskPendingBulkDestroyCall

      public okhttp3.Call backgroundTaskPendingBulkDestroyCall(@Nonnull BulkRequest bulkRequest, ApiCallback _callback) throws ApiException
      Build call for backgroundTaskPendingBulkDestroy
      Parameters:
      bulkRequest - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskPendingBulkDestroy

      public void backgroundTaskPendingBulkDestroy(@Nonnull BulkRequest bulkRequest) throws ApiException
      Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskPendingBulkDestroyWithHttpInfo

      public ApiResponse<Void> backgroundTaskPendingBulkDestroyWithHttpInfo(@Nonnull BulkRequest bulkRequest) throws ApiException
      Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskPendingBulkDestroyAsync

      public okhttp3.Call backgroundTaskPendingBulkDestroyAsync(@Nonnull BulkRequest bulkRequest, ApiCallback<Void> _callback) throws ApiException
      (asynchronously) Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (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
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • backgroundTaskPendingListCall

      public okhttp3.Call backgroundTaskPendingListCall(@Nonnull Integer limit, @Nullable Integer offset, ApiCallback _callback) throws ApiException
      Build call for backgroundTaskPendingList
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskPendingList

      public PaginatedPendingTaskList backgroundTaskPendingList(@Nonnull Integer limit, @Nullable Integer offset) throws ApiException
      Provides a read-only list of currently pending tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      Returns:
      PaginatedPendingTaskList
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskPendingListWithHttpInfo

      public ApiResponse<PaginatedPendingTaskList> backgroundTaskPendingListWithHttpInfo(@Nonnull Integer limit, @Nullable Integer offset) throws ApiException
      Provides a read-only list of currently pending tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      Returns:
      ApiResponse<PaginatedPendingTaskList>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskPendingListAsync

      public okhttp3.Call backgroundTaskPendingListAsync(@Nonnull Integer limit, @Nullable Integer offset, ApiCallback<PaginatedPendingTaskList> _callback) throws ApiException
      (asynchronously) Provides a read-only list of currently pending tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      _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:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskRetrieveCall

      public okhttp3.Call backgroundTaskRetrieveCall(ApiCallback _callback) throws ApiException
      Build call for backgroundTaskRetrieve
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 No response body -

    • backgroundTaskRetrieve

      public void backgroundTaskRetrieve() throws ApiException
      Return information about the current status of the background task queue.
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 No response body -

    • backgroundTaskRetrieveWithHttpInfo

      public ApiResponse<Void> backgroundTaskRetrieveWithHttpInfo() throws ApiException
      Return information about the current status of the background task queue.
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 No response body -

    • backgroundTaskRetrieveAsync

      public okhttp3.Call backgroundTaskRetrieveAsync(ApiCallback<Void> _callback) throws ApiException
      (asynchronously) Return information about the current status of the background task queue.
      Parameters:
      _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:
      Response Details
      Status Code Description Response Headers
      200 No response body -

    • backgroundTaskScheduledListCall

      public okhttp3.Call backgroundTaskScheduledListCall(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search, ApiCallback _callback) throws ApiException
      Build call for backgroundTaskScheduledList
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, last_run, next_run. (optional)
      search - A search term. Searched fields: func. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskScheduledList

      public PaginatedScheduledTaskList backgroundTaskScheduledList(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search) throws ApiException
      Provides a read-only list of currently scheduled tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, last_run, next_run. (optional)
      search - A search term. Searched fields: func. (optional)
      Returns:
      PaginatedScheduledTaskList
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskScheduledListWithHttpInfo

      public ApiResponse<PaginatedScheduledTaskList> backgroundTaskScheduledListWithHttpInfo(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search) throws ApiException
      Provides a read-only list of currently scheduled tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, last_run, next_run. (optional)
      search - A search term. Searched fields: func. (optional)
      Returns:
      ApiResponse<PaginatedScheduledTaskList>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • backgroundTaskScheduledListAsync

      public okhttp3.Call backgroundTaskScheduledListAsync(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search, ApiCallback<PaginatedScheduledTaskList> _callback) throws ApiException
      (asynchronously) Provides a read-only list of currently scheduled tasks.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: pk, func, last_run, next_run. (optional)
      search - A search term. Searched fields: func. (optional)
      _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:
      Response Details
      Status Code Description Response Headers
      200 -