Interface GetLoaderJobStatusRequest.Builder

    • Method Detail

      • loadId

        GetLoaderJobStatusRequest.Builder loadId​(String loadId)

        The load ID of the load job to get the status of.

        Parameters:
        loadId - The load ID of the load job to get the status of.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • details

        GetLoaderJobStatusRequest.Builder details​(Boolean details)

        Flag indicating whether or not to include details beyond the overall status (TRUE or FALSE; the default is FALSE).

        Parameters:
        details - Flag indicating whether or not to include details beyond the overall status (TRUE or FALSE; the default is FALSE).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • errors

        GetLoaderJobStatusRequest.Builder errors​(Boolean errors)

        Flag indicating whether or not to include a list of errors encountered (TRUE or FALSE; the default is FALSE).

        The list of errors is paged. The page and errorsPerPage parameters allow you to page through all the errors.

        Parameters:
        errors - Flag indicating whether or not to include a list of errors encountered (TRUE or FALSE; the default is FALSE).

        The list of errors is paged. The page and errorsPerPage parameters allow you to page through all the errors.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • page

        GetLoaderJobStatusRequest.Builder page​(Integer page)

        The error page number (a positive integer; the default is 1). Only valid when the errors parameter is set to TRUE.

        Parameters:
        page - The error page number (a positive integer; the default is 1). Only valid when the errors parameter is set to TRUE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • errorsPerPage

        GetLoaderJobStatusRequest.Builder errorsPerPage​(Integer errorsPerPage)

        The number of errors returned in each page (a positive integer; the default is 10). Only valid when the errors parameter set to TRUE.

        Parameters:
        errorsPerPage - The number of errors returned in each page (a positive integer; the default is 10). Only valid when the errors parameter set to TRUE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.