Skip to content

GetLoaderJobStatusInput

Source code in docs_src/capo_neptunedata/types/get_loader_job_status_input.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
class GetLoaderJobStatusInput(TypedDict, closed=True):
    load_id: "str"
    """<p>The load ID of the load job to get the status of.</p>"""
    details: NotRequired["bool"]
    """<p>Flag indicating whether or not to include details beyond the overall status (<code>TRUE</code> or <code>FALSE</code>; the default is <code>FALSE</code>).</p>"""
    errors: NotRequired["bool"]
    """<p>Flag indicating whether or not to include a list of errors encountered (<code>TRUE</code> or <code>FALSE</code>; the default is <code>FALSE</code>).</p> <p>The list of errors is paged. The <code>page</code> and <code>errorsPerPage</code> parameters allow you to page through all the errors.</p>"""
    page: NotRequired["capo_neptunedata.types.positive_integer.PositiveInteger"]
    """<p>The error page number (a positive integer; the default is <code>1</code>). Only valid when the <code>errors</code> parameter is set to <code>TRUE</code>.</p>"""
    errors_per_page: NotRequired[
        "capo_neptunedata.types.positive_integer.PositiveInteger"
    ]
    """<p>The number of errors returned in each page (a positive integer; the default is <code>10</code>). Only valid when the <code>errors</code> parameter set to <code>TRUE</code>.</p>"""

details instance-attribute 

details: NotRequired[bool]

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

errors instance-attribute 

errors: NotRequired[bool]

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.

errors_per_page instance-attribute 

errors_per_page: NotRequired[PositiveInteger]

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

load_id instance-attribute 

load_id: str

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

page instance-attribute 

page: NotRequired[PositiveInteger]

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