tapis-workflows 0.3.1

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

# \PipelineLocksApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_pipeline_lock**](PipelineLocksApi.md#get_pipeline_lock) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/locks/{pipeline_lock_uuid} | PipelineLocks
[**list_pipeline_locks**](PipelineLocksApi.md#list_pipeline_locks) | **GET** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/locks | PipelineLocks
[**release_pipeline_lock**](PipelineLocksApi.md#release_pipeline_lock) | **DELETE** /v3/workflows/groups/{group_id}/pipelines/{pipeline_id}/runs/{pipeline_run_uuid}/locks | PipelineLocks



## get_pipeline_lock

> models::RespPipelineLock get_pipeline_lock(group_id, pipeline_id, pipeline_lock_uuid)
PipelineLocks

Get a pipeline lock by its UUID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**pipeline_id** | **String** |  | [required] |
**pipeline_lock_uuid** | **uuid::Uuid** |  | [required] |

### Return type

[**models::RespPipelineLock**](RespPipelineLock.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_pipeline_locks

> models::RespPipelineLockList list_pipeline_locks(group_id, pipeline_id)
PipelineLocks

List all locks for a given pipeline

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**pipeline_id** | **String** |  | [required] |

### Return type

[**models::RespPipelineLockList**](RespPipelineLockList.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## release_pipeline_lock

> release_pipeline_lock(group_id, pipeline_id, pipeline_run_uuid)
PipelineLocks

Release a lock on the Pipeline

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**pipeline_id** | **String** |  | [required] |
**pipeline_run_uuid** | **uuid::Uuid** |  | [required] |

### Return type

 (empty response body)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)