Skip to content

JobSample

Used by
Source code in docs_src/capo_databrew/types/job_sample.py 
12
13
14
15
16
class JobSample(TypedDict, closed=True):
    mode: NotRequired["capo_databrew.types.sample_mode.SampleMode"]
    """<p>A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:</p> <ul> <li> <p>FULL_DATASET - The profile job is run on the entire dataset.</p> </li> <li> <p>CUSTOM_ROWS - The profile job is run on the number of rows specified in the <code>Size</code> parameter.</p> </li> </ul>"""
    size: NotRequired["capo_databrew.types.job_size.JobSize"]
    """<p>The <code>Size</code> parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.</p> <p>Long.MAX_VALUE = 9223372036854775807</p>"""

mode instance-attribute 

mode: NotRequired[SampleMode]

A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

  • FULL_DATASET - The profile job is run on the entire dataset.

  • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

size instance-attribute 

size: NotRequired[JobSize]

The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807