Rust API client for tapis-workflows
Create and manage pipelines
For more information, please visit https://tapis-project.org
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec 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 | POST /v3/workflows/groups/{group_id}/archives | Create an archive |
| ArchivesApi | get_archive | GET /v3/workflows/groups/{group_id}/archives/{archive_id} | Retrieve an archive |
| ArchivesApi | list_archives | GET /v3/workflows/groups/{group_id}/archives | Retrieve archives |
| CicdApi | create_ci_pipeline | POST /v3/workflows/groups/{group_id}/ci | Create a CI/CD pipeline |
| EtlApi | create_etl_pipeline | POST /v3/workflows/beta/groups/{group_id}/etl | Create an ETL pipeline |
| GeneralApi | health_check | GET /v3/workflows/healthcheck | |
| GroupSecretsApi | add_group_secret | POST /v3/workflows/groups/{group_id}/secrets | Add a user's secret to a group |
| GroupSecretsApi | get_group_secret | GET /v3/workflows/groups/{group_id}/secrets/{group_secret_id} | Get group secret |
| GroupSecretsApi | list_group_secrets | GET /v3/workflows/groups/{group_id}/secrets | List group secrets |
| GroupSecretsApi | remove_group_secret | DELETE /v3/workflows/groups/{group_id}/secrets/{group_secret_id} | Remove user from group |
| GroupsApi | create_group | POST /v3/workflows/groups | Create a group |
| GroupsApi | delete_group | DELETE /v3/workflows/groups/{group_id} | Delete a group |
| GroupsApi | get_group | GET /v3/workflows/groups/{group_id} | Retrieve group details |
| GroupsApi | list_groups | GET /v3/workflows/groups | Retrieve groups |
| IdentitiesApi | create_identity | POST /v3/workflows/identities | Create an identity |
| IdentitiesApi | delete_identity | DELETE /v3/workflows/identities/{identity_uuid} | Delete an identity |
| IdentitiesApi | get_identity | GET /v3/workflows/identities/{identity_uuid} | Get identity |
| IdentitiesApi | list_identities | GET /v3/workflows/identities | List user identities for a given user |
| PipelineArchivesApi | list_pipeline_archives | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/archives | Retrieve pipeline archives |
| PipelineLocksApi | get_pipeline_lock | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/locks/{pipeline_lock_uuid} | PipelineLocks |
| PipelineLocksApi | list_pipeline_locks | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/locks | PipelineLocks |
| PipelineLocksApi | release_pipeline_lock | DELETE /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/locks | PipelineLocks |
| PipelineRunsApi | acquire_pipeline_lock | POST /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/locks | PipelineRuns |
| PipelineRunsApi | get_pipeline_run | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid} | Pipeline Runs |
| PipelineRunsApi | list_pipeline_runs | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs | Pipeline Runs |
| PipelineRunsApi | terminate_pipeline | POST /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid} | Terminate a running pipeline |
| PipelineRunsApi | update_pipeline_run_status | PATCH /v3/workflows/executor/runs/{pipeline_run_uuid}/{status} | Pipeline Runs |
| PipelinesApi | add_pipeline_archive | POST /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/archives/add | Add an archive to a pipeline |
| PipelinesApi | change_pipeline_owner | PATCH /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/changeOwner/{username} | Change pipeline owner |
| PipelinesApi | create_pipeline | POST /v3/workflows/groups/{group_id}/pipelines | Create a pipeline |
| PipelinesApi | delete_pipeline | DELETE /v3/workflows/groups/{group_id}/pipelines/{pipeline_id} | Delete a pipeline |
| PipelinesApi | get_pipeline | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id} | Retrieve pipeline details |
| PipelinesApi | list_pipelines | GET /v3/workflows/groups/{group_id}/pipelines | Retrieve pipelines |
| PipelinesApi | remove_pipeline_archive | DELETE /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/archives/remove | Remove archive to a pipeline |
| PipelinesApi | run_pipeline | POST /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/run | Trigger a pipeline run |
| SecretsApi | create_secret | POST /v3/workflows/secrets | Create a secret |
| SecretsApi | delete_secret | DELETE /v3/workflows/secrets/{secret_id} | Delete a secret |
| SecretsApi | get_secret | GET /v3/workflows/secrets/{secret_id} | Retrieve a secret |
| SecretsApi | list_secrets | GET /v3/workflows/secrets | Retrieve secrets |
| TaskExecutionsApi | create_task_execution | POST /v3/workflows/executor/runs/{pipeline_run_uuid}/executions | Task Executions |
| TaskExecutionsApi | 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 | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/executions | Task Executions |
| TaskExecutionsApi | update_task_execution_status | PATCH /v3/workflows/executor/executions/{task_execution_uuid}/{status} | Task Executions |
| TasksApi | create_task | POST /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks | Create a task |
| TasksApi | delete_task | DELETE /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks/{task_id} | Delete a task |
| TasksApi | get_task | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks/{task_id} | Retrieve task details |
| TasksApi | list_tasks | GET /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks | List tasks |
| TasksApi | patch_task | PATCH /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/tasks/{task_id} | Update task details |
| UsersApi | add_group_user | POST /v3/workflows/groups/{group_id}/users | Add a user to a group |
| UsersApi | get_group_user | GET /v3/workflows/groups/{group_id}/users/{username} | Get group user |
| UsersApi | list_group_users | GET /v3/workflows/groups/{group_id}/users | List users |
| UsersApi | remove_group_user | DELETE /v3/workflows/groups/{group_id}/users/{username} | Remove user from group |
| UsersApi | update_group_user | PATCH /v3/workflows/groups/{group_id}/users/{username} | Update group user |
Documentation For Models
- ApplicationTask
- Archive
- ArgSpec
- BaseArchive
- BaseDataIntegrityProfile
- BaseDestination
- BaseTask
- ByteCheckDataIntegrityProfile
- ChecksumDataIntegrityProfile
- Context
- DataIntegrityProfile
- Destination
- DockerhubCred
- DockerhubDestination
- DoneFileDataIntegrityProfile
- EnumArchiveType
- EnumBuilder
- EnumComparisonOperator
- EnumContextType
- EnumContextVisibility
- EnumDestinationType
- EnumDuplicateSubmissionPolicy
- EnumHttpMethod
- EnumIdentityType
- EnumInputType
- EnumInstaller
- EnumInvocationMode
- EnumLogicalOperator
- EnumMembershipOperator
- EnumNegationOperator
- EnumPipelineType
- EnumRetryPolicy
- EnumRunStatus
- EnumRuntimeEnvironment
- EnumTaskFlavor
- EnumTaskIoType
- EnumTaskType
- EnvSpec
- EtlActionFilter
- EtlControlSystem
- EtlDataSystem
- EtlEnumDataIntegrityType
- EtlEnumManifestGenerationPolicy
- EtlEnumManifestPriority
- EtlLocalInbox
- EtlLocalOutbox
- EtlManifestsSystem
- EtlRemoteInbox
- EtlRemoteOutbox
- EtlSystem
- EtlSystemsConfiguration
- ExecutionProfile
- ExtendedTapisJob
- FunctionTask
- GitCloneDetails
- GitRepository
- Group
- GroupDetail
- GroupSecret
- GroupUser
- Identity
- ImageBuildTask
- LocalDestination
- OutputValue
- Pipeline
- PipelineExecutionProfile
- PipelineLock
- PipelineRun
- RegistryDestination
- ReqApplicationTask
- ReqArchive
- ReqBaseArchive
- ReqBaseContext
- ReqBaseDestination
- ReqBaseIdentity
- ReqBaseTask
- ReqCiPipeline
- ReqContext
- ReqCreateEtlPipeline
- ReqCreateSecret
- ReqCreateTaskExecution
- ReqDestination
- ReqDockerhubContext
- ReqDockerhubCred
- ReqDockerhubDestination
- ReqDockerhubIdentity
- ReqFunctionTask
- ReqGithubContext
- ReqGithubCred
- ReqGithubIdentity
- ReqGitlabContext
- ReqGitlabCred
- ReqGroup
- ReqGroupSecret
- ReqGroupUser
- ReqGroupUsersInner
- ReqIdentity
- ReqImageBuildTask
- ReqLocalContext
- ReqLocalDestination
- ReqNonLocalContext
- ReqPatchPipelineRun
- ReqPatchTask
- ReqPatchTaskExecution
- ReqPipeline
- ReqPipelineLock
- ReqRegistryContext
- ReqRegistryDestination
- ReqRepoContext
- ReqRequestTask
- ReqRunPipeline
- ReqS3Archive
- ReqS3Cred
- ReqTapisActorTask
- ReqTapisJobTask
- ReqTapisSystemArchive
- ReqTask
- ReqTemplateTask
- ReqUpdateGroupUser
- RequestTask
- ResourceUrlResult
- RespArchive
- RespArchiveList
- RespBase
- RespError
- RespGroupDetail
- RespGroupList
- RespGroupSecret
- RespGroupSecretList
- RespGroupUser
- RespGroupUserList
- RespIdentity
- RespIdentityList
- RespList
- RespPipeline
- RespPipelineList
- RespPipelineLock
- RespPipelineLockAcquisition
- RespPipelineLockAcquisitionAllOfResult
- RespPipelineLockList
- RespPipelineRun
- RespPipelineRunList
- RespResourceUrl
- RespSecret
- RespSecretList
- RespString
- RespTask
- RespTaskExecution
- RespTaskExecutionList
- RespTaskList
- S3Archive
- Secret
- SecretRef
- Spec
- SpecWithValue
- TapisActorTask
- TapisEtlExtendedTapisJobDef
- TapisEtlExtension
- TapisJobExtensions
- TapisJobTask
- TapisSystemArchive
- Task
- TaskDependency
- TaskExecution
- TaskExecutionProfile
- TaskOutputRef
- TemplateTask
- Uses
- Value
- ValueFrom
- ValueFromArgs
- ValueFromEnv
- ValueFromHost
- ValueFromSecret
- ValueFromSecretOrHost
- ValueFromTaskOutput
To get access to the crate's generated documentation, use:
cargo doc --open