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
|
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
# Generated file, DO NOT EDIT
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------------------------
from msrest import Serializer, Deserializer
from ...client import Client
from . import models
class PipelinesClient(Client):
"""Pipelines
:param str base_url: Service URL
:param Authentication creds: Authenticated credentials.
"""
def __init__(self, base_url=None, creds=None):
super(PipelinesClient, self).__init__(base_url, creds)
client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
self._serialize = Serializer(client_models)
self._deserialize = Deserializer(client_models)
resource_area_identifier = None
def get_artifact(self, project, pipeline_id, run_id, artifact_name, expand=None):
"""GetArtifact.
[Preview API] Get a specific artifact from a pipeline run
:param str project: Project ID or project name
:param int pipeline_id: ID of the pipeline.
:param int run_id: ID of the run of that pipeline.
:param str artifact_name: Name of the artifact.
:param str expand: Expand options. Default is None.
:rtype: :class:`<Artifact> <azure.devops.v6_0.pipelines.models.Artifact>`
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
if pipeline_id is not None:
route_values['pipelineId'] = self._serialize.url('pipeline_id', pipeline_id, 'int')
if run_id is not None:
route_values['runId'] = self._serialize.url('run_id', run_id, 'int')
query_parameters = {}
if artifact_name is not None:
query_parameters['artifactName'] = self._serialize.query('artifact_name', artifact_name, 'str')
if expand is not None:
query_parameters['$expand'] = self._serialize.query('expand', expand, 'str')
response = self._send(http_method='GET',
location_id='85023071-bd5e-4438-89b0-2a5bf362a19d',
version='6.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('Artifact', response)
def get_log(self, project, pipeline_id, run_id, log_id, expand=None):
"""GetLog.
[Preview API] Get a specific log from a pipeline run
:param str project: Project ID or project name
:param int pipeline_id: ID of the pipeline.
:param int run_id: ID of the run of that pipeline.
:param int log_id: ID of the log.
:param str expand: Expand options. Default is None.
:rtype: :class:`<Log> <azure.devops.v6_0.pipelines.models.Log>`
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
if pipeline_id is not None:
route_values['pipelineId'] = self._serialize.url('pipeline_id', pipeline_id, 'int')
if run_id is not None:
route_values['runId'] = self._serialize.url('run_id', run_id, 'int')
if log_id is not None:
route_values['logId'] = self._serialize.url('log_id', log_id, 'int')
query_parameters = {}
if expand is not None:
query_parameters['$expand'] = self._serialize.query('expand', expand, 'str')
response = self._send(http_method='GET',
location_id='fb1b6d27-3957-43d5-a14b-a2d70403e545',
version='6.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('Log', response)
def list_logs(self, project, pipeline_id, run_id, expand=None):
"""ListLogs.
[Preview API] Get a list of logs from a pipeline run.
:param str project: Project ID or project name
:param int pipeline_id: ID of the pipeline.
:param int run_id: ID of the run of that pipeline.
:param str expand: Expand options. Default is None.
:rtype: :class:`<LogCollection> <azure.devops.v6_0.pipelines.models.LogCollection>`
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
if pipeline_id is not None:
route_values['pipelineId'] = self._serialize.url('pipeline_id', pipeline_id, 'int')
if run_id is not None:
route_values['runId'] = self._serialize.url('run_id', run_id, 'int')
query_parameters = {}
if expand is not None:
query_parameters['$expand'] = self._serialize.query('expand', expand, 'str')
response = self._send(http_method='GET',
location_id='fb1b6d27-3957-43d5-a14b-a2d70403e545',
version='6.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('LogCollection', response)
def create_pipeline(self, input_parameters, project):
"""CreatePipeline.
[Preview API] Create a pipeline.
:param :class:`<CreatePipelineParameters> <azure.devops.v6_0.pipelines.models.CreatePipelineParameters>` input_parameters: Input parameters.
:param str project: Project ID or project name
:rtype: :class:`<Pipeline> <azure.devops.v6_0.pipelines.models.Pipeline>`
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
content = self._serialize.body(input_parameters, 'CreatePipelineParameters')
response = self._send(http_method='POST',
location_id='28e1305e-2afe-47bf-abaf-cbb0e6a91988',
version='6.0-preview.1',
route_values=route_values,
content=content)
return self._deserialize('Pipeline', response)
def get_pipeline(self, project, pipeline_id, pipeline_version=None):
"""GetPipeline.
[Preview API] Gets a pipeline, optionally at the specified version
:param str project: Project ID or project name
:param int pipeline_id: The pipeline ID
:param int pipeline_version: The pipeline version
:rtype: :class:`<Pipeline> <azure.devops.v6_0.pipelines.models.Pipeline>`
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
if pipeline_id is not None:
route_values['pipelineId'] = self._serialize.url('pipeline_id', pipeline_id, 'int')
query_parameters = {}
if pipeline_version is not None:
query_parameters['pipelineVersion'] = self._serialize.query('pipeline_version', pipeline_version, 'int')
response = self._send(http_method='GET',
location_id='28e1305e-2afe-47bf-abaf-cbb0e6a91988',
version='6.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('Pipeline', response)
def list_pipelines(self, project, order_by=None, top=None, continuation_token=None):
"""ListPipelines.
[Preview API] Get a list of pipelines.
:param str project: Project ID or project name
:param str order_by: A sort expression. Defaults to "name asc"
:param int top: The maximum number of pipelines to return
:param str continuation_token: A continuation token from a previous request, to retrieve the next page of results
:rtype: [Pipeline]
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
query_parameters = {}
if order_by is not None:
query_parameters['orderBy'] = self._serialize.query('order_by', order_by, 'str')
if top is not None:
query_parameters['$top'] = self._serialize.query('top', top, 'int')
if continuation_token is not None:
query_parameters['continuationToken'] = self._serialize.query('continuation_token', continuation_token, 'str')
response = self._send(http_method='GET',
location_id='28e1305e-2afe-47bf-abaf-cbb0e6a91988',
version='6.0-preview.1',
route_values=route_values,
query_parameters=query_parameters)
return self._deserialize('[Pipeline]', self._unwrap_collection(response))
def get_run(self, project, pipeline_id, run_id):
"""GetRun.
[Preview API] Gets a run for a particular pipeline.
:param str project: Project ID or project name
:param int pipeline_id: The pipeline id
:param int run_id: The run id
:rtype: :class:`<Run> <azure.devops.v6_0.pipelines.models.Run>`
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
if pipeline_id is not None:
route_values['pipelineId'] = self._serialize.url('pipeline_id', pipeline_id, 'int')
if run_id is not None:
route_values['runId'] = self._serialize.url('run_id', run_id, 'int')
response = self._send(http_method='GET',
location_id='7859261e-d2e9-4a68-b820-a5d84cc5bb3d',
version='6.0-preview.1',
route_values=route_values)
return self._deserialize('Run', response)
def list_runs(self, project, pipeline_id):
"""ListRuns.
[Preview API] Gets top 10000 runs for a particular pipeline.
:param str project: Project ID or project name
:param int pipeline_id: The pipeline id
:rtype: [Run]
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
if pipeline_id is not None:
route_values['pipelineId'] = self._serialize.url('pipeline_id', pipeline_id, 'int')
response = self._send(http_method='GET',
location_id='7859261e-d2e9-4a68-b820-a5d84cc5bb3d',
version='6.0-preview.1',
route_values=route_values)
return self._deserialize('[Run]', self._unwrap_collection(response))
def run_pipeline(self, run_parameters, project, pipeline_id, pipeline_version=None):
"""RunPipeline.
[Preview API] Runs a pipeline.
:param :class:`<RunPipelineParameters> <azure.devops.v6_0.pipelines.models.RunPipelineParameters>` run_parameters: Optional additional parameters for this run.
:param str project: Project ID or project name
:param int pipeline_id: The pipeline ID.
:param int pipeline_version: The pipeline version.
:rtype: :class:`<Run> <azure.devops.v6_0.pipelines.models.Run>`
"""
route_values = {}
if project is not None:
route_values['project'] = self._serialize.url('project', project, 'str')
if pipeline_id is not None:
route_values['pipelineId'] = self._serialize.url('pipeline_id', pipeline_id, 'int')
query_parameters = {}
if pipeline_version is not None:
query_parameters['pipelineVersion'] = self._serialize.query('pipeline_version', pipeline_version, 'int')
content = self._serialize.body(run_parameters, 'RunPipelineParameters')
response = self._send(http_method='POST',
location_id='7859261e-d2e9-4a68-b820-a5d84cc5bb3d',
version='6.0-preview.1',
route_values=route_values,
query_parameters=query_parameters,
content=content)
return self._deserialize('Run', response)
|
