flywheel.api.views_api
ViewsApi
Bases: object
data_view_columns(**kwargs)
Return a list of all known column aliases for use in data views
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
data_view_columns_with_http_info(**kwargs)
Return a list of all known column aliases for use in data views
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_view(view_id, **kwargs)
Delete a data view
Soft deletes data view in database This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_view_with_http_info(view_id, **kwargs)
Delete a data view
Soft deletes data view in database This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
evaluate_view(view_id, container_id, **kwargs)
Execute a view, returning data in the preferred format.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
container_id | str | The target container for view execution | required |
ticket | (str, optional) | download ticket id | required |
filename | (str, optional) | download ticket filename, defaults to view-data | required |
format | (FileFormat, optional) | Available values : csv, tsv, json, ndjson, json_flat, json-row-column | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
evaluate_view_adhoc(container_id, body, **kwargs)
Execute an ad-hoc view, returning data in the preferred format.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container_id | str | The target container for view execution | required |
body | ContainerPipelineInput | | required |
filename | (str, optional) | download ticket filename, defaults to view-data | required |
format | (FileFormat, optional) | Available values : csv, tsv, json, ndjson, json_flat, json-row-column | required |
ticket | (str, optional) | download ticket id | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
evaluate_view_adhoc_with_http_info(container_id, body, **kwargs)
Execute an ad-hoc view, returning data in the preferred format.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container_id | str | The target container for view execution | required |
body | ContainerPipelineInput | | required |
filename | (str, optional) | download ticket filename, defaults to view-data | required |
format | (FileFormat, optional) | Available values : csv, tsv, json, ndjson, json_flat, json-row-column | required |
ticket | (str, optional) | download ticket id | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
evaluate_view_with_http_info(view_id, container_id, **kwargs)
Execute a view, returning data in the preferred format.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
container_id | str | The target container for view execution | required |
ticket | (str, optional) | download ticket id | required |
filename | (str, optional) | download ticket filename, defaults to view-data | required |
format | (FileFormat, optional) | Available values : csv, tsv, json, ndjson, json_flat, json-row-column | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_view(view_id, **kwargs)
Return the view identified by ViewId
Gets view by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_view_with_http_info(view_id, **kwargs)
Return the view identified by ViewId
Gets view by id. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_view(view_id, body, **kwargs)
Update the view identified by ViewId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
body | ContainerModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
modify_view_with_http_info(view_id, body, **kwargs)
Update the view identified by ViewId
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
body | ContainerModify | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
queue_adhoc(container_id, body, **kwargs)
Execute an ad-hoc view, returning a reference to the created data view execution.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container_id | str | The target container for view execution | required |
body | ContainerPipelineInput | | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
queue_adhoc_with_http_info(container_id, body, **kwargs)
Execute an ad-hoc view, returning a reference to the created data view execution.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container_id | str | The target container for view execution | required |
body | ContainerPipelineInput | | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
queue_saved(view_id, container_id, **kwargs)
Execute a view, returning a reference to the created data view execution.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
container_id | str | The target container for view execution | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
queue_saved_with_http_info(view_id, container_id, **kwargs)
Execute a view, returning a reference to the created data view execution.
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
view_id | str | The ID of the view | required |
container_id | str | The target container for view execution | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
filter | (str, optional) | An optional filter expression | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
save_view_data_to_container(container_id, body, **kwargs)
Execute a view, saving data to the target container / file
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container_id | str | The target container for view execution | required |
body | ContainerIdViewInputExecuteAndSave | | required |
format | (FileFormat, optional) | Available values : csv, tsv, json, ndjson, json_flat, json-row-column | required |
ticket | (str, optional) | download ticket id | required |
filter | (str, optional) | An optional filter expression | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
save_view_data_to_container_with_http_info(container_id, body, **kwargs)
Execute a view, saving data to the target container / file
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container_id | str | The target container for view execution | required |
body | ContainerIdViewInputExecuteAndSave | | required |
format | (FileFormat, optional) | Available values : csv, tsv, json, ndjson, json_flat, json-row-column | required |
ticket | (str, optional) | download ticket id | required |
filter | (str, optional) | An optional filter expression | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
skip | (int, optional) | The optional number of rows to skip | required |
limit | (int, optional) | The optional max number of rows to return | required |
async_ | (bool, optional) | Perform the request asynchronously | required |