flywheel.api.custom_filters_api
CustomFiltersApi
Bases: object
create_custom_filter(body, **kwargs)
Create a custom filter for user
Creates a custom filter for the user This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | FilterInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
create_custom_filter_with_http_info(body, **kwargs)
Create a custom filter for user
Creates a custom filter for the user This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | FilterInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_custom_filter(custom_filter_id, **kwargs)
Delete a custom filter for user
Deletes a custom filter for the authenticated user This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
custom_filter_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
delete_custom_filter_with_http_info(custom_filter_id, **kwargs)
Delete a custom filter for user
Deletes a custom filter for the authenticated user This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
custom_filter_id | str | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_custom_filters(**kwargs)
Get all custom filters for user
Retrieves all custom filters for the authenticated user's origin This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_all_custom_filters_with_http_info(**kwargs)
Get all custom filters for user
Retrieves all custom filters for the authenticated user's origin This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order. (e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return. | required |
skip | (int, optional) | The number of entries to skip., defaults to 0 | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
update_custom_filter(custom_filter_id, body, **kwargs)
Update a custom filter for user
Updates an existing custom filter This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
custom_filter_id | str | | required |
body | FilterInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
update_custom_filter_with_http_info(custom_filter_id, body, **kwargs)
Update a custom filter for user
Updates an existing custom filter This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
custom_filter_id | str | | required |
body | FilterInput | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |