flywheel.api.download_api
DownloadApi
Bases: object
create_download_ticket(body, **kwargs)
Create a download ticket
Use filters in the payload to exclude/include files. To pass a single filter, each of its conditions should be satisfied. If a file pass at least one filter, it is included in the targets. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | DownloadInput | | required |
type | (DownloadStrategy, optional) | The download type, one of: bulk, classic or full. Default is classic. | required |
bulk | (bool, optional) | , defaults to false | required |
metadata | (bool, optional) | For "full" download, whether or not to include metadata sidecars. Default is false. | required |
analyses | (bool, optional) | For "full" download, whether or not to include analyses. Default is false. | required |
prefix | (str, optional) | A string to customize the name of the download in the format | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_download_ticket_with_http_info(body, **kwargs)
Create a download ticket
Use filters in the payload to exclude/include files. To pass a single filter, each of its conditions should be satisfied. If a file pass at least one filter, it is included in the targets. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | DownloadInput | | required |
type | (DownloadStrategy, optional) | The download type, one of: bulk, classic or full. Default is classic. | required |
bulk | (bool, optional) | , defaults to false | required |
metadata | (bool, optional) | For "full" download, whether or not to include metadata sidecars. Default is false. | required |
analyses | (bool, optional) | For "full" download, whether or not to include analyses. Default is false. | required |
prefix | (str, optional) | A string to customize the name of the download in the format | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
download_ticket(ticket, dest_file, **kwargs)
Download files listed in the given ticket.
You can use POST to create a download ticket The files listed in the ticket are put into a tar archive This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ticket | str | ID of the download ticket | required |
format | (DownloadFormat, optional) | | required |
dest_file | str | Destination file path | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
download_ticket_with_http_info(ticket, **kwargs)
Download files listed in the given ticket.
You can use POST to create a download ticket The files listed in the ticket are put into a tar archive This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ticket | str | ID of the download ticket | required |
format | (DownloadFormat, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |