tapis-workflows 0.3.0

Create and manage pipelines
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

# Rust API client for tapis-workflows

Create and manage pipelines

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.6.0
- 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-workflows` and add the following to `Cargo.toml` under `[dependencies]`:

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

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ArchivesApi* | [**create_archive**](docs/ArchivesApi.md#create_archive) | **POST** /v3/workflows/groups/{group_id}/archives | Create an archive
*ArchivesApi* | [**get_archive**](docs/ArchivesApi.md#get_archive) | **GET** /v3/workflows/groups/{group_id}/archives/{archive_id} | Retrieve an archive
*ArchivesApi* | [**list_archives**](docs/ArchivesApi.md#list_archives) | **GET** /v3/workflows/groups/{group_id}/archives | Retrieve archives
*CicdApi* | [**create_ci_pipeline**](docs/CicdApi.md#create_ci_pipeline) | **POST** /v3/workflows/groups/{group_id}/ci | Create a CI/CD pipeline
*EtlApi* | [**create_etl_pipeline**](docs/EtlApi.md#create_etl_pipeline) | **POST** /v3/workflows/beta/groups/{group_id}/etl | Create an ETL pipeline
*GeneralApi* | [**health_check**](docs/GeneralApi.md#health_check) | **GET** /v3/workflows/healthcheck | 
*GroupSecretsApi* | [**add_group_secret**](docs/GroupSecretsApi.md#add_group_secret) | **POST** /v3/workflows/groups/{group_id}/secrets | Add a user's secret to a group
*GroupSecretsApi* | [**get_group_secret**](docs/GroupSecretsApi.md#get_group_secret) | **GET** /v3/workflows/groups/{group_id}/secrets/{group_secret_id} | Get group secret
*GroupSecretsApi* | [**list_group_secrets**](docs/GroupSecretsApi.md#list_group_secrets) | **GET** /v3/workflows/groups/{group_id}/secrets | List group secrets
*GroupSecretsApi* | [**remove_group_secret**](docs/GroupSecretsApi.md#remove_group_secret) | **DELETE** /v3/workflows/groups/{group_id}/secrets/{group_secret_id} | Remove user from group
*GroupsApi* | [**create_group**](docs/GroupsApi.md#create_group) | **POST** /v3/workflows/groups | Create a group
*GroupsApi* | [**delete_group**](docs/GroupsApi.md#delete_group) | **DELETE** /v3/workflows/groups/{group_id} | Delete a group
*GroupsApi* | [**get_group**](docs/GroupsApi.md#get_group) | **GET** /v3/workflows/groups/{group_id} | Retrieve group details
*GroupsApi* | [**list_groups**](docs/GroupsApi.md#list_groups) | **GET** /v3/workflows/groups | Retrieve groups
*IdentitiesApi* | [**create_identity**](docs/IdentitiesApi.md#create_identity) | **POST** /v3/workflows/identities | Create an identity
*IdentitiesApi* | [**delete_identity**](docs/IdentitiesApi.md#delete_identity) | **DELETE** /v3/workflows/identities/{identity_uuid} | Delete an identity
*IdentitiesApi* | [**get_identity**](docs/IdentitiesApi.md#get_identity) | **GET** /v3/workflows/identities/{identity_uuid} | Get identity
*IdentitiesApi* | [**list_identities**](docs/IdentitiesApi.md#list_identities) | **GET** /v3/workflows/identities | List user identities for a given user
*PipelineArchivesApi* | [**list_pipeline_archives**](docs/PipelineArchivesApi.md#list_pipeline_archives) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/archives | Retrieve pipeline archives
*PipelineLocksApi* | [**get_pipeline_lock**](docs/PipelineLocksApi.md#get_pipeline_lock) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/locks/{pipeline_lock_uuid} | PipelineLocks
*PipelineLocksApi* | [**list_pipeline_locks**](docs/PipelineLocksApi.md#list_pipeline_locks) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/locks | PipelineLocks
*PipelineLocksApi* | [**release_pipeline_lock**](docs/PipelineLocksApi.md#release_pipeline_lock) | **DELETE** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/locks | PipelineLocks
*PipelineRunsApi* | [**acquire_pipeline_lock**](docs/PipelineRunsApi.md#acquire_pipeline_lock) | **POST** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/locks | PipelineRuns
*PipelineRunsApi* | [**get_pipeline_run**](docs/PipelineRunsApi.md#get_pipeline_run) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid} | Pipeline Runs
*PipelineRunsApi* | [**list_pipeline_runs**](docs/PipelineRunsApi.md#list_pipeline_runs) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs | Pipeline Runs
*PipelineRunsApi* | [**terminate_pipeline**](docs/PipelineRunsApi.md#terminate_pipeline) | **POST** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid} | Terminate a running pipeline
*PipelineRunsApi* | [**update_pipeline_run_status**](docs/PipelineRunsApi.md#update_pipeline_run_status) | **PATCH** /v3/workflows/executor/runs/{pipeline_run_uuid}/{status} | Pipeline Runs
*PipelinesApi* | [**add_pipeline_archive**](docs/PipelinesApi.md#add_pipeline_archive) | **POST** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/archives/add | Add an archive to a pipeline
*PipelinesApi* | [**change_pipeline_owner**](docs/PipelinesApi.md#change_pipeline_owner) | **PATCH** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/changeOwner/{username} | Change pipeline owner
*PipelinesApi* | [**create_pipeline**](docs/PipelinesApi.md#create_pipeline) | **POST** /v3/workflows/groups/{group_id}/pipelines | Create a pipeline
*PipelinesApi* | [**delete_pipeline**](docs/PipelinesApi.md#delete_pipeline) | **DELETE** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id} | Delete a pipeline
*PipelinesApi* | [**get_pipeline**](docs/PipelinesApi.md#get_pipeline) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id} | Retrieve pipeline details
*PipelinesApi* | [**list_pipelines**](docs/PipelinesApi.md#list_pipelines) | **GET** /v3/workflows/groups/{group_id}/pipelines | Retrieve pipelines
*PipelinesApi* | [**remove_pipeline_archive**](docs/PipelinesApi.md#remove_pipeline_archive) | **DELETE** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/archives/remove | Remove archive to a pipeline
*PipelinesApi* | [**run_pipeline**](docs/PipelinesApi.md#run_pipeline) | **POST** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/run | Trigger a pipeline run
*SecretsApi* | [**create_secret**](docs/SecretsApi.md#create_secret) | **POST** /v3/workflows/secrets | Create a secret
*SecretsApi* | [**delete_secret**](docs/SecretsApi.md#delete_secret) | **DELETE** /v3/workflows/secrets/{secret_id} | Delete a secret
*SecretsApi* | [**get_secret**](docs/SecretsApi.md#get_secret) | **GET** /v3/workflows/secrets/{secret_id} | Retrieve a secret
*SecretsApi* | [**list_secrets**](docs/SecretsApi.md#list_secrets) | **GET** /v3/workflows/secrets | Retrieve secrets
*TaskExecutionsApi* | [**create_task_execution**](docs/TaskExecutionsApi.md#create_task_execution) | **POST** /v3/workflows/executor/runs/{pipeline_run_uuid}/executions | Task Executions
*TaskExecutionsApi* | [**get_task_execution**](docs/TaskExecutionsApi.md#get_task_execution) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/executions/{task_execution_uuid} | Task Executions
*TaskExecutionsApi* | [**list_task_executions**](docs/TaskExecutionsApi.md#list_task_executions) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/executions | Task Executions
*TaskExecutionsApi* | [**update_task_execution_status**](docs/TaskExecutionsApi.md#update_task_execution_status) | **PATCH** /v3/workflows/executor/executions/{task_execution_uuid}/{status} | Task Executions
*TasksApi* | [**create_task**](docs/TasksApi.md#create_task) | **POST** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks | Create a task
*TasksApi* | [**delete_task**](docs/TasksApi.md#delete_task) | **DELETE** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks/{task_id} | Delete a task
*TasksApi* | [**get_task**](docs/TasksApi.md#get_task) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks/{task_id} | Retrieve task details
*TasksApi* | [**list_tasks**](docs/TasksApi.md#list_tasks) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks | List tasks
*TasksApi* | [**patch_task**](docs/TasksApi.md#patch_task) | **PATCH** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks/{task_id} | Update task details
*UsersApi* | [**add_group_user**](docs/UsersApi.md#add_group_user) | **POST** /v3/workflows/groups/{group_id}/users | Add a user to a group
*UsersApi* | [**get_group_user**](docs/UsersApi.md#get_group_user) | **GET** /v3/workflows/groups/{group_id}/users/{username} | Get group user
*UsersApi* | [**list_group_users**](docs/UsersApi.md#list_group_users) | **GET** /v3/workflows/groups/{group_id}/users | List users
*UsersApi* | [**remove_group_user**](docs/UsersApi.md#remove_group_user) | **DELETE** /v3/workflows/groups/{group_id}/users/{username} | Remove user from group
*UsersApi* | [**update_group_user**](docs/UsersApi.md#update_group_user) | **PATCH** /v3/workflows/groups/{group_id}/users/{username} | Update group user


## Documentation For Models

 - [ApplicationTask](docs/ApplicationTask.md)
 - [Archive](docs/Archive.md)
 - [ArgSpec](docs/ArgSpec.md)
 - [BaseArchive](docs/BaseArchive.md)
 - [BaseDataIntegrityProfile](docs/BaseDataIntegrityProfile.md)
 - [BaseDestination](docs/BaseDestination.md)
 - [BaseTask](docs/BaseTask.md)
 - [ByteCheckDataIntegrityProfile](docs/ByteCheckDataIntegrityProfile.md)
 - [ChecksumDataIntegrityProfile](docs/ChecksumDataIntegrityProfile.md)
 - [Context](docs/Context.md)
 - [DataIntegrityProfile](docs/DataIntegrityProfile.md)
 - [Destination](docs/Destination.md)
 - [DockerhubCred](docs/DockerhubCred.md)
 - [DockerhubDestination](docs/DockerhubDestination.md)
 - [DoneFileDataIntegrityProfile](docs/DoneFileDataIntegrityProfile.md)
 - [EnumArchiveType](docs/EnumArchiveType.md)
 - [EnumBuilder](docs/EnumBuilder.md)
 - [EnumComparisonOperator](docs/EnumComparisonOperator.md)
 - [EnumContextType](docs/EnumContextType.md)
 - [EnumContextVisibility](docs/EnumContextVisibility.md)
 - [EnumDestinationType](docs/EnumDestinationType.md)
 - [EnumDuplicateSubmissionPolicy](docs/EnumDuplicateSubmissionPolicy.md)
 - [EnumHttpMethod](docs/EnumHttpMethod.md)
 - [EnumIdentityType](docs/EnumIdentityType.md)
 - [EnumInputType](docs/EnumInputType.md)
 - [EnumInstaller](docs/EnumInstaller.md)
 - [EnumInvocationMode](docs/EnumInvocationMode.md)
 - [EnumLogicalOperator](docs/EnumLogicalOperator.md)
 - [EnumMembershipOperator](docs/EnumMembershipOperator.md)
 - [EnumNegationOperator](docs/EnumNegationOperator.md)
 - [EnumPipelineType](docs/EnumPipelineType.md)
 - [EnumRetryPolicy](docs/EnumRetryPolicy.md)
 - [EnumRunStatus](docs/EnumRunStatus.md)
 - [EnumRuntimeEnvironment](docs/EnumRuntimeEnvironment.md)
 - [EnumTaskFlavor](docs/EnumTaskFlavor.md)
 - [EnumTaskIoType](docs/EnumTaskIoType.md)
 - [EnumTaskType](docs/EnumTaskType.md)
 - [EnvSpec](docs/EnvSpec.md)
 - [EtlActionFilter](docs/EtlActionFilter.md)
 - [EtlControlSystem](docs/EtlControlSystem.md)
 - [EtlDataSystem](docs/EtlDataSystem.md)
 - [EtlEnumDataIntegrityType](docs/EtlEnumDataIntegrityType.md)
 - [EtlEnumManifestGenerationPolicy](docs/EtlEnumManifestGenerationPolicy.md)
 - [EtlEnumManifestPriority](docs/EtlEnumManifestPriority.md)
 - [EtlLocalInbox](docs/EtlLocalInbox.md)
 - [EtlLocalOutbox](docs/EtlLocalOutbox.md)
 - [EtlManifestsSystem](docs/EtlManifestsSystem.md)
 - [EtlRemoteInbox](docs/EtlRemoteInbox.md)
 - [EtlRemoteOutbox](docs/EtlRemoteOutbox.md)
 - [EtlSystem](docs/EtlSystem.md)
 - [EtlSystemsConfiguration](docs/EtlSystemsConfiguration.md)
 - [ExecutionProfile](docs/ExecutionProfile.md)
 - [ExtendedTapisJob](docs/ExtendedTapisJob.md)
 - [FunctionTask](docs/FunctionTask.md)
 - [GitCloneDetails](docs/GitCloneDetails.md)
 - [GitRepository](docs/GitRepository.md)
 - [Group](docs/Group.md)
 - [GroupDetail](docs/GroupDetail.md)
 - [GroupSecret](docs/GroupSecret.md)
 - [GroupUser](docs/GroupUser.md)
 - [Identity](docs/Identity.md)
 - [ImageBuildTask](docs/ImageBuildTask.md)
 - [LocalDestination](docs/LocalDestination.md)
 - [OutputValue](docs/OutputValue.md)
 - [Pipeline](docs/Pipeline.md)
 - [PipelineExecutionProfile](docs/PipelineExecutionProfile.md)
 - [PipelineLock](docs/PipelineLock.md)
 - [PipelineRun](docs/PipelineRun.md)
 - [RegistryDestination](docs/RegistryDestination.md)
 - [ReqApplicationTask](docs/ReqApplicationTask.md)
 - [ReqArchive](docs/ReqArchive.md)
 - [ReqBaseArchive](docs/ReqBaseArchive.md)
 - [ReqBaseContext](docs/ReqBaseContext.md)
 - [ReqBaseDestination](docs/ReqBaseDestination.md)
 - [ReqBaseIdentity](docs/ReqBaseIdentity.md)
 - [ReqBaseTask](docs/ReqBaseTask.md)
 - [ReqCiPipeline](docs/ReqCiPipeline.md)
 - [ReqContext](docs/ReqContext.md)
 - [ReqCreateEtlPipeline](docs/ReqCreateEtlPipeline.md)
 - [ReqCreateSecret](docs/ReqCreateSecret.md)
 - [ReqCreateTaskExecution](docs/ReqCreateTaskExecution.md)
 - [ReqDestination](docs/ReqDestination.md)
 - [ReqDockerhubContext](docs/ReqDockerhubContext.md)
 - [ReqDockerhubCred](docs/ReqDockerhubCred.md)
 - [ReqDockerhubDestination](docs/ReqDockerhubDestination.md)
 - [ReqDockerhubIdentity](docs/ReqDockerhubIdentity.md)
 - [ReqFunctionTask](docs/ReqFunctionTask.md)
 - [ReqGithubContext](docs/ReqGithubContext.md)
 - [ReqGithubCred](docs/ReqGithubCred.md)
 - [ReqGithubIdentity](docs/ReqGithubIdentity.md)
 - [ReqGitlabContext](docs/ReqGitlabContext.md)
 - [ReqGitlabCred](docs/ReqGitlabCred.md)
 - [ReqGroup](docs/ReqGroup.md)
 - [ReqGroupSecret](docs/ReqGroupSecret.md)
 - [ReqGroupUser](docs/ReqGroupUser.md)
 - [ReqGroupUsersInner](docs/ReqGroupUsersInner.md)
 - [ReqIdentity](docs/ReqIdentity.md)
 - [ReqImageBuildTask](docs/ReqImageBuildTask.md)
 - [ReqLocalContext](docs/ReqLocalContext.md)
 - [ReqLocalDestination](docs/ReqLocalDestination.md)
 - [ReqNonLocalContext](docs/ReqNonLocalContext.md)
 - [ReqPatchPipelineRun](docs/ReqPatchPipelineRun.md)
 - [ReqPatchTask](docs/ReqPatchTask.md)
 - [ReqPatchTaskExecution](docs/ReqPatchTaskExecution.md)
 - [ReqPipeline](docs/ReqPipeline.md)
 - [ReqPipelineLock](docs/ReqPipelineLock.md)
 - [ReqRegistryContext](docs/ReqRegistryContext.md)
 - [ReqRegistryDestination](docs/ReqRegistryDestination.md)
 - [ReqRepoContext](docs/ReqRepoContext.md)
 - [ReqRequestTask](docs/ReqRequestTask.md)
 - [ReqRunPipeline](docs/ReqRunPipeline.md)
 - [ReqS3Archive](docs/ReqS3Archive.md)
 - [ReqS3Cred](docs/ReqS3Cred.md)
 - [ReqTapisActorTask](docs/ReqTapisActorTask.md)
 - [ReqTapisJobTask](docs/ReqTapisJobTask.md)
 - [ReqTapisSystemArchive](docs/ReqTapisSystemArchive.md)
 - [ReqTask](docs/ReqTask.md)
 - [ReqTemplateTask](docs/ReqTemplateTask.md)
 - [ReqUpdateGroupUser](docs/ReqUpdateGroupUser.md)
 - [RequestTask](docs/RequestTask.md)
 - [ResourceUrlResult](docs/ResourceUrlResult.md)
 - [RespArchive](docs/RespArchive.md)
 - [RespArchiveList](docs/RespArchiveList.md)
 - [RespBase](docs/RespBase.md)
 - [RespError](docs/RespError.md)
 - [RespGroupDetail](docs/RespGroupDetail.md)
 - [RespGroupList](docs/RespGroupList.md)
 - [RespGroupSecret](docs/RespGroupSecret.md)
 - [RespGroupSecretList](docs/RespGroupSecretList.md)
 - [RespGroupUser](docs/RespGroupUser.md)
 - [RespGroupUserList](docs/RespGroupUserList.md)
 - [RespIdentity](docs/RespIdentity.md)
 - [RespIdentityList](docs/RespIdentityList.md)
 - [RespList](docs/RespList.md)
 - [RespPipeline](docs/RespPipeline.md)
 - [RespPipelineList](docs/RespPipelineList.md)
 - [RespPipelineLock](docs/RespPipelineLock.md)
 - [RespPipelineLockAcquisition](docs/RespPipelineLockAcquisition.md)
 - [RespPipelineLockAcquisitionAllOfResult](docs/RespPipelineLockAcquisitionAllOfResult.md)
 - [RespPipelineLockList](docs/RespPipelineLockList.md)
 - [RespPipelineRun](docs/RespPipelineRun.md)
 - [RespPipelineRunList](docs/RespPipelineRunList.md)
 - [RespResourceUrl](docs/RespResourceUrl.md)
 - [RespSecret](docs/RespSecret.md)
 - [RespSecretList](docs/RespSecretList.md)
 - [RespString](docs/RespString.md)
 - [RespTask](docs/RespTask.md)
 - [RespTaskExecution](docs/RespTaskExecution.md)
 - [RespTaskExecutionList](docs/RespTaskExecutionList.md)
 - [RespTaskList](docs/RespTaskList.md)
 - [S3Archive](docs/S3Archive.md)
 - [Secret](docs/Secret.md)
 - [SecretRef](docs/SecretRef.md)
 - [Spec](docs/Spec.md)
 - [SpecWithValue](docs/SpecWithValue.md)
 - [TapisActorTask](docs/TapisActorTask.md)
 - [TapisEtlExtendedTapisJobDef](docs/TapisEtlExtendedTapisJobDef.md)
 - [TapisEtlExtension](docs/TapisEtlExtension.md)
 - [TapisJobExtensions](docs/TapisJobExtensions.md)
 - [TapisJobTask](docs/TapisJobTask.md)
 - [TapisSystemArchive](docs/TapisSystemArchive.md)
 - [Task](docs/Task.md)
 - [TaskDependency](docs/TaskDependency.md)
 - [TaskExecution](docs/TaskExecution.md)
 - [TaskExecutionProfile](docs/TaskExecutionProfile.md)
 - [TaskOutputRef](docs/TaskOutputRef.md)
 - [TemplateTask](docs/TemplateTask.md)
 - [Uses](docs/Uses.md)
 - [Value](docs/Value.md)
 - [ValueFrom](docs/ValueFrom.md)
 - [ValueFromArgs](docs/ValueFromArgs.md)
 - [ValueFromEnv](docs/ValueFromEnv.md)
 - [ValueFromHost](docs/ValueFromHost.md)
 - [ValueFromSecret](docs/ValueFromSecret.md)
 - [ValueFromSecretOrHost](docs/ValueFromSecretOrHost.md)
 - [ValueFromTaskOutput](docs/ValueFromTaskOutput.md)


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

```
cargo doc --open
```

## Author

cicsupport@tacc.utexas.edu