tapis-files 0.3.0

The Tapis Files API provides for management of file resources on Tapis systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

# Rust API client for tapis-files

The Tapis Files API provides for management of file resources on Tapis systems

For more information, please visit [https://tapis-project.org](https://tapis-project.org)

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 1.8.2
- Package version: 0.2.0
- Generator version: 7.18.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `tapis-files` and add the following to `Cargo.toml` under `[dependencies]`:

```
tapis-files = { path = "./tapis-files" }
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8080*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ContentApi* | [**get_contents**](docs/ContentApi.md#get_contents) | **GET** /v3/files/content/{systemId}/{path} | 
*FileOperationsApi* | [**delete**](docs/FileOperationsApi.md#delete) | **DELETE** /v3/files/ops/{systemId}/{path} | 
*FileOperationsApi* | [**get_facl**](docs/FileOperationsApi.md#get_facl) | **GET** /v3/files/utils/linux/facl/{systemId}/{path} | 
*FileOperationsApi* | [**get_stat_info**](docs/FileOperationsApi.md#get_stat_info) | **GET** /v3/files/utils/linux/{systemId}/{path} | 
*FileOperationsApi* | [**insert**](docs/FileOperationsApi.md#insert) | **POST** /v3/files/ops/{systemId}/{path} | 
*FileOperationsApi* | [**list_files**](docs/FileOperationsApi.md#list_files) | **GET** /v3/files/ops/{systemId}/{path} | 
*FileOperationsApi* | [**mkdir**](docs/FileOperationsApi.md#mkdir) | **POST** /v3/files/ops/{systemId} | 
*FileOperationsApi* | [**move_copy**](docs/FileOperationsApi.md#move_copy) | **PUT** /v3/files/ops/{systemId}/{path} | 
*FileOperationsApi* | [**run_linux_native_op**](docs/FileOperationsApi.md#run_linux_native_op) | **POST** /v3/files/utils/linux/{systemId}/{path} | 
*FileOperationsApi* | [**set_facl**](docs/FileOperationsApi.md#set_facl) | **POST** /v3/files/utils/linux/facl/{systemId}/{path} | 
*GeneralApi* | [**health_check**](docs/GeneralApi.md#health_check) | **GET** /v3/files/healthcheck | 
*GeneralApi* | [**ready_check**](docs/GeneralApi.md#ready_check) | **GET** /v3/files/readycheck | 
*PermissionsApi* | [**delete_permissions**](docs/PermissionsApi.md#delete_permissions) | **DELETE** /v3/files/permissions/{systemId}/{path} | 
*PermissionsApi* | [**get_permissions**](docs/PermissionsApi.md#get_permissions) | **GET** /v3/files/permissions/{systemId}/{path} | 
*PermissionsApi* | [**grant_permissions**](docs/PermissionsApi.md#grant_permissions) | **POST** /v3/files/permissions/{systemId}/{path} | 
*PostItsApi* | [**create_post_it**](docs/PostItsApi.md#create_post_it) | **POST** /v3/files/postits/{systemId}/{path} | Create a PostIt
*PostItsApi* | [**delete_post_it**](docs/PostItsApi.md#delete_post_it) | **DELETE** /v3/files/postits/{postitId} | Delete a PostIt
*PostItsApi* | [**get_post_it**](docs/PostItsApi.md#get_post_it) | **GET** /v3/files/postits/{postitId} | Get PostIt.
*PostItsApi* | [**list_post_its**](docs/PostItsApi.md#list_post_its) | **GET** /v3/files/postits | List PostIts.
*PostItsApi* | [**redeem_post_it**](docs/PostItsApi.md#redeem_post_it) | **GET** /v3/files/postits/redeem/{postitId} | Redeem PostIt.
*PostItsApi* | [**update_post_it**](docs/PostItsApi.md#update_post_it) | **PATCH** /v3/files/postits/{postitId} | Modify a PostIt
*SharingApi* | [**get_share_info**](docs/SharingApi.md#get_share_info) | **GET** /v3/files/share/{systemId}/{path} | Retrieve all sharing information for a path on a system
*SharingApi* | [**share_path**](docs/SharingApi.md#share_path) | **POST** /v3/files/share/{systemId}/{path} | Share a path on a system with one or more users.
*SharingApi* | [**share_path_public**](docs/SharingApi.md#share_path_public) | **POST** /v3/files/share_public/{systemId}/{path} | Share a path on a system publicly with all users in the tenant.
*SharingApi* | [**un_share_path**](docs/SharingApi.md#un_share_path) | **POST** /v3/files/unshare/{systemId}/{path} | Unshare a path on a system with one or more users.
*SharingApi* | [**un_share_path_all**](docs/SharingApi.md#un_share_path_all) | **POST** /v3/files/unshare_all/{systemId}/{path} | Remove all shares for a path on a system including public access.
*SharingApi* | [**un_share_path_public**](docs/SharingApi.md#un_share_path_public) | **POST** /v3/files/unshare_public/{systemId}/{path} | Remove public access for a path on a system.
*TransfersApi* | [**cancel_transfer_task**](docs/TransfersApi.md#cancel_transfer_task) | **DELETE** /v3/files/transfers/{transferTaskId} | 
*TransfersApi* | [**create_transfer_task**](docs/TransfersApi.md#create_transfer_task) | **POST** /v3/files/transfers | 
*TransfersApi* | [**get_recent_transfer_tasks**](docs/TransfersApi.md#get_recent_transfer_tasks) | **GET** /v3/files/transfers | 
*TransfersApi* | [**get_transfer_task**](docs/TransfersApi.md#get_transfer_task) | **GET** /v3/files/transfers/{transferTaskId} | 
*TransfersApi* | [**get_transfer_task_details**](docs/TransfersApi.md#get_transfer_task_details) | **GET** /v3/files/transfers/{transferTaskId}/details | 


## Documentation For Models

 - [AclEntryInfo](docs/AclEntryInfo.md)
 - [CreatePermissionRequest](docs/CreatePermissionRequest.md)
 - [CreatePostItRequest](docs/CreatePostItRequest.md)
 - [FileInfo](docs/FileInfo.md)
 - [FileListingResponse](docs/FileListingResponse.md)
 - [FilePermission](docs/FilePermission.md)
 - [FilePermissionResponse](docs/FilePermissionResponse.md)
 - [FileStatInfo](docs/FileStatInfo.md)
 - [FileStatInfoResponse](docs/FileStatInfoResponse.md)
 - [FileStringResponse](docs/FileStringResponse.md)
 - [FileTypeEnum](docs/FileTypeEnum.md)
 - [HeaderByteRange](docs/HeaderByteRange.md)
 - [ListTypeEnum](docs/ListTypeEnum.md)
 - [MkdirRequest](docs/MkdirRequest.md)
 - [MoveCopyRequest](docs/MoveCopyRequest.md)
 - [NativeLinuxGetFaclResponse](docs/NativeLinuxGetFaclResponse.md)
 - [NativeLinuxOpRequest](docs/NativeLinuxOpRequest.md)
 - [NativeLinuxOpResponse](docs/NativeLinuxOpResponse.md)
 - [NativeLinuxOpResultResponse](docs/NativeLinuxOpResultResponse.md)
 - [NativeLinuxSetFaclRequest](docs/NativeLinuxSetFaclRequest.md)
 - [NativeLinuxSetFaclResponse](docs/NativeLinuxSetFaclResponse.md)
 - [NativeLinuxSetFaclResult](docs/NativeLinuxSetFaclResult.md)
 - [PermEnum](docs/PermEnum.md)
 - [PostIt](docs/PostIt.md)
 - [PostItListResponse](docs/PostItListResponse.md)
 - [PostItResponse](docs/PostItResponse.md)
 - [ReqShareUpdate](docs/ReqShareUpdate.md)
 - [ReqTransfer](docs/ReqTransfer.md)
 - [ReqTransferElement](docs/ReqTransferElement.md)
 - [RespBasic](docs/RespBasic.md)
 - [RespChangeCount](docs/RespChangeCount.md)
 - [RespFileList](docs/RespFileList.md)
 - [RespShareInfo](docs/RespShareInfo.md)
 - [RespString](docs/RespString.md)
 - [ResultChangeCount](docs/ResultChangeCount.md)
 - [ResultShareInfo](docs/ResultShareInfo.md)
 - [ShareFileRequest](docs/ShareFileRequest.md)
 - [SharedFileObject](docs/SharedFileObject.md)
 - [StringResponse](docs/StringResponse.md)
 - [TransferStatusEnum](docs/TransferStatusEnum.md)
 - [TransferTask](docs/TransferTask.md)
 - [TransferTaskChild](docs/TransferTaskChild.md)
 - [TransferTaskListResponse](docs/TransferTaskListResponse.md)
 - [TransferTaskParent](docs/TransferTaskParent.md)
 - [TransferTaskResponse](docs/TransferTaskResponse.md)
 - [UpdatePostItRequest](docs/UpdatePostItRequest.md)
 - [UserShareInfo](docs/UserShareInfo.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

cicsupport@tacc.utexas.edu