`flywheel.api.files_api`

`FilesApi`

Bases: object

`add_file_tags(file_id, body, **kwargs)`

Add list of tags on a file.

Add the tags on a file to the list of tags This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_file_tags_with_http_info(file_id, body, **kwargs)`

Add list of tags on a file.

Add the tags on a file to the list of tags This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_file(file_id, **kwargs)`

Delete a File

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.)
A user with admin permissions on the container may delete any file. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	Version of the file to delete (defaults to current version)	required
`delete_reason`	`(ContainerDeleteReason, optional)`	A reason for deletion when audit-trail is enabled	required
`force`	`(bool, optional)`	Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_file_tags(file_id, **kwargs)`

Remove the specified tags from most recent file version

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`(list[str], optional)`	List of application-specific tags	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_file_tags_with_http_info(file_id, **kwargs)`

Remove the specified tags from most recent file version

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`(list[str], optional)`	List of application-specific tags	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_file_with_http_info(file_id, **kwargs)`

Delete a File

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.)
A user with admin permissions on the container may delete any file. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	Version of the file to delete (defaults to current version)	required
`delete_reason`	`(ContainerDeleteReason, optional)`	A reason for deletion when audit-trail is enabled	required
`force`	`(bool, optional)`	Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release., defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_files(**kwargs)`

Return all files

Get metadata of all current user files 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_files_with_http_info(**kwargs)`

Return all files

Get metadata of all current user files 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_file(file_id, **kwargs)`

Get File

Get file details This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_info(file_id, **kwargs)`

Get Info

Get info dict for any file version. Returns: dict of key/value pairs This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_info_with_http_info(file_id, **kwargs)`

Get Info

Get info dict for any file version. Returns: dict of key/value pairs This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_tags(file_id, **kwargs)`

Return a file tags, from any version

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_tags_with_http_info(file_id, **kwargs)`

Return a file tags, from any version

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_versions(file_id, **kwargs)`

Get Versions

Get file version details This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_versions_with_http_info(file_id, **kwargs)`

Get Versions

Get file version details This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_with_http_info(file_id, **kwargs)`

Get File

Get file details This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_zip_info(file_id, **kwargs)`

Get Zip Info

Get info on zipfile This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`ticket`	`(str, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_file_zip_info_with_http_info(file_id, **kwargs)`

Get Zip Info

Get info on zipfile This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`(int, optional)`	, defaults to 0	required
`ticket`	`(str, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_file_classification(file_id, body, **kwargs)`

Modify Classification

Modify classification of most recent file version This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`FileClassificationDelta`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_file_classification_with_http_info(file_id, body, **kwargs)`

Modify Classification

Modify classification of most recent file version This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`FileClassificationDelta`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_file_info(file_id, **kwargs)`

Modify Info

Add info to most recent file version, adding items or replacing some existing ones. Parameters: info (dict) -- key/value pairs to add Returns: dict added This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`(object, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_file_info_with_http_info(file_id, **kwargs)`

Modify Info

Add info to most recent file version, adding items or replacing some existing ones. Parameters: info (dict) -- key/value pairs to add Returns: dict added This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`(object, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`move_file(file_id, body, **kwargs)`

Move and/or rename a file

Move a file to a new container and/or give it a new name This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`FileMoveInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`move_file_with_http_info(file_id, body, **kwargs)`

Move and/or rename a file

Move a file to a new container and/or give it a new name This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`FileMoveInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`replace_file_info(file_id, **kwargs)`

Replace Info

Add info to most recent file version, replacing all existing values. Parameters: info (dict) -- all key/value pairs to populate info Returns: dict added This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`(object, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`replace_file_info_with_http_info(file_id, **kwargs)`

Replace Info

Add info to most recent file version, replacing all existing values. Parameters: info (dict) -- all key/value pairs to populate info Returns: dict added This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`(object, optional)`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`restore_file(file_id, version, evaluate_gear_rules, **kwargs)`

Restore a File

Restore a specific version of a file as the active version. This will create a new version which will be identical to the restored version. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`int`		required
`evaluate_gear_rules`	`bool`	Specify if gear rules should be reevaluated on the newly created file version	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`restore_file_with_http_info(file_id, version, evaluate_gear_rules, **kwargs)`

Restore a File

Restore a specific version of a file as the active version. This will create a new version which will be identical to the restored version. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`version`	`int`		required
`evaluate_gear_rules`	`bool`	Specify if gear rules should be reevaluated on the newly created file version	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`set_file_tags(file_id, body, **kwargs)`

Set list of tags on a file.

Set the tags on a file to the list of tags provided This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`list[str]`	List of application-specific tags	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`set_file_tags_with_http_info(file_id, body, **kwargs)`

Set list of tags on a file.

Set the tags on a file to the list of tags provided This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`file_id`	`str`		required
`body`	`list[str]`	List of application-specific tags	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`upsert_file(body, **kwargs)`

Upsert a File

Create or update a file This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`FileUpsertInput`		required
`force_update`	`(bool, optional)`	, defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`upsert_file_with_http_info(body, **kwargs)`

Upsert a File

Create or update a file This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`FileUpsertInput`		required
`force_update`	`(bool, optional)`	, defaults to false	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required