-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathrunners.py
More file actions
1925 lines (1558 loc) · 66.6 KB
/
runners.py
File metadata and controls
1925 lines (1558 loc) · 66.6 KB
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Optional
import httpx
from ...types import (
RunnerKind,
SearchMode,
RunnerProvider,
runner_list_params,
runner_create_params,
runner_delete_params,
runner_update_params,
runner_retrieve_params,
runner_create_logs_token_params,
runner_parse_context_url_params,
runner_create_runner_token_params,
runner_search_repositories_params,
runner_list_scm_organizations_params,
runner_check_repository_access_params,
runner_check_authentication_for_host_params,
)
from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from ..._utils import maybe_transform, async_maybe_transform
from .policies import (
PoliciesResource,
AsyncPoliciesResource,
PoliciesResourceWithRawResponse,
AsyncPoliciesResourceWithRawResponse,
PoliciesResourceWithStreamingResponse,
AsyncPoliciesResourceWithStreamingResponse,
)
from ..._compat import cached_property
from ..._resource import SyncAPIResource, AsyncAPIResource
from ..._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ...pagination import SyncRunnersPage, AsyncRunnersPage
from ..._base_client import AsyncPaginator, make_request_options
from ...types.runner import Runner
from ...types.runner_kind import RunnerKind
from ...types.search_mode import SearchMode
from ...types.runner_provider import RunnerProvider
from ...types.runner_spec_param import RunnerSpecParam
from .configurations.configurations import (
ConfigurationsResource,
AsyncConfigurationsResource,
ConfigurationsResourceWithRawResponse,
AsyncConfigurationsResourceWithRawResponse,
ConfigurationsResourceWithStreamingResponse,
AsyncConfigurationsResourceWithStreamingResponse,
)
from ...types.runner_create_response import RunnerCreateResponse
from ...types.runner_retrieve_response import RunnerRetrieveResponse
from ...types.runner_create_logs_token_response import RunnerCreateLogsTokenResponse
from ...types.runner_parse_context_url_response import RunnerParseContextURLResponse
from ...types.runner_create_runner_token_response import RunnerCreateRunnerTokenResponse
from ...types.runner_search_repositories_response import RunnerSearchRepositoriesResponse
from ...types.runner_list_scm_organizations_response import RunnerListScmOrganizationsResponse
from ...types.runner_check_repository_access_response import RunnerCheckRepositoryAccessResponse
from ...types.runner_check_authentication_for_host_response import RunnerCheckAuthenticationForHostResponse
__all__ = ["RunnersResource", "AsyncRunnersResource"]
class RunnersResource(SyncAPIResource):
@cached_property
def configurations(self) -> ConfigurationsResource:
return ConfigurationsResource(self._client)
@cached_property
def policies(self) -> PoliciesResource:
return PoliciesResource(self._client)
@cached_property
def with_raw_response(self) -> RunnersResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return RunnersResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> RunnersResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return RunnersResourceWithStreamingResponse(self)
def create(
self,
*,
kind: RunnerKind | Omit = omit,
name: str | Omit = omit,
provider: RunnerProvider | Omit = omit,
runner_manager_id: str | Omit = omit,
spec: RunnerSpecParam | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerCreateResponse:
"""Creates a new runner registration with the server.
Registrations are very
short-lived and must be renewed every 30 seconds.
Use this method to:
- Register organization runners
- Set up runner configurations
- Initialize runner credentials
- Configure auto-updates
### Examples
- Create cloud runner:
Creates a new runner in AWS EC2.
```yaml
name: "Production Runner"
provider: RUNNER_PROVIDER_AWS_EC2
spec:
desiredPhase: RUNNER_PHASE_ACTIVE
configuration:
region: "us-west"
releaseChannel: RUNNER_RELEASE_CHANNEL_STABLE
autoUpdate: true
```
- Create local runner:
Creates a new local runner on Linux.
```yaml
name: "Local Development Runner"
provider: RUNNER_PROVIDER_LINUX_HOST
spec:
desiredPhase: RUNNER_PHASE_ACTIVE
configuration:
releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST
autoUpdate: true
```
Args:
kind: The runner's kind This field is optional and here for backwards-compatibility.
Use the provider field instead. If provider is set, the runner's kind will be
deduced from the provider. Only one of kind and provider must be set.
name: The runner name for humans
provider: The specific implementation type of the runner This field is optional for
backwards compatibility but will be required in the future. When specified, kind
must not be specified (will be deduced from provider)
runner_manager_id: The runner manager id specifies the runner manager for the managed runner. This
field is mandatory for managed runners, otheriwse should not be set.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/CreateRunner",
body=maybe_transform(
{
"kind": kind,
"name": name,
"provider": provider,
"runner_manager_id": runner_manager_id,
"spec": spec,
},
runner_create_params.RunnerCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerCreateResponse,
)
def retrieve(
self,
*,
runner_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerRetrieveResponse:
"""
Gets details about a specific runner.
Use this method to:
- Check runner status
- View runner configuration
- Monitor runner health
- Verify runner capabilities
### Examples
- Get runner details:
Retrieves information about a specific runner.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/GetRunner",
body=maybe_transform({"runner_id": runner_id}, runner_retrieve_params.RunnerRetrieveParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerRetrieveResponse,
)
def update(
self,
*,
name: Optional[str] | Omit = omit,
runner_id: str | Omit = omit,
spec: Optional[runner_update_params.Spec] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> object:
"""
Updates a runner's configuration.
Use this method to:
- Modify runner settings
- Update release channels
- Change runner status
- Configure auto-update settings
### Examples
- Update configuration:
Changes runner settings.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
name: "Updated Runner Name"
spec:
configuration:
releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST
autoUpdate: true
```
Args:
name: The runner's name which is shown to users
runner_id: runner_id specifies which runner to be updated.
+required
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/UpdateRunner",
body=maybe_transform(
{
"name": name,
"runner_id": runner_id,
"spec": spec,
},
runner_update_params.RunnerUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=object,
)
def list(
self,
*,
token: str | Omit = omit,
page_size: int | Omit = omit,
filter: runner_list_params.Filter | Omit = omit,
pagination: runner_list_params.Pagination | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> SyncRunnersPage[Runner]:
"""
Lists all registered runners with optional filtering.
Use this method to:
- View all available runners
- Filter by runner type
- Monitor runner status
- Check runner availability
### Examples
- List all runners:
Shows all runners with pagination.
```yaml
pagination:
pageSize: 20
```
- Filter by provider:
Lists only AWS EC2 runners.
```yaml
filter:
providers: ["RUNNER_PROVIDER_AWS_EC2"]
pagination:
pageSize: 20
```
Args:
pagination: pagination contains the pagination options for listing runners
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/gitpod.v1.RunnerService/ListRunners",
page=SyncRunnersPage[Runner],
body=maybe_transform(
{
"filter": filter,
"pagination": pagination,
},
runner_list_params.RunnerListParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"token": token,
"page_size": page_size,
},
runner_list_params.RunnerListParams,
),
),
model=Runner,
method="post",
)
def delete(
self,
*,
force: bool | Omit = omit,
runner_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> object:
"""
Deletes a runner permanently.
Use this method to:
- Remove unused runners
- Clean up runner registrations
- Delete obsolete runners
### Examples
- Delete runner:
Permanently removes a runner.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
force: force indicates whether the runner should be deleted forcefully. When force
deleting a Runner, all Environments on the runner are also force deleted and
regular Runner lifecycle is not respected. Force deleting can result in data
loss.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/DeleteRunner",
body=maybe_transform(
{
"force": force,
"runner_id": runner_id,
},
runner_delete_params.RunnerDeleteParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=object,
)
def check_authentication_for_host(
self,
*,
host: str | Omit = omit,
runner_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerCheckAuthenticationForHostResponse:
"""
Checks if a user is authenticated for a specific host.
Use this method to:
- Verify authentication status
- Get authentication URLs
- Check PAT support
### Examples
- Check authentication:
Verifies authentication for a host.
```yaml
host: "github.com"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/CheckAuthenticationForHost",
body=maybe_transform(
{
"host": host,
"runner_id": runner_id,
},
runner_check_authentication_for_host_params.RunnerCheckAuthenticationForHostParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerCheckAuthenticationForHostResponse,
)
def check_repository_access(
self,
*,
repository_url: str | Omit = omit,
runner_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerCheckRepositoryAccessResponse:
"""
Checks if a principal has read access to a repository.
Use this method to:
- Validate repository access before workflow execution
- Verify executor credentials for automation bindings
Returns:
- has_access: true if the principal can read the repository
- FAILED_PRECONDITION if authentication is required
- INVALID_ARGUMENT if the repository URL is invalid
### Examples
- Check access:
Verifies read access to a repository.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
repositoryUrl: "https://github.com/org/repo"
```
Args:
repository_url: repository_url is the URL of the repository to check access for. Can be a clone
URL (https://github.com/org/repo.git) or web URL (https://github.com/org/repo).
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/CheckRepositoryAccess",
body=maybe_transform(
{
"repository_url": repository_url,
"runner_id": runner_id,
},
runner_check_repository_access_params.RunnerCheckRepositoryAccessParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerCheckRepositoryAccessResponse,
)
def create_logs_token(
self,
*,
runner_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerCreateLogsTokenResponse:
"""
Creates an access token for runner logs and debug information.
Generated tokens are valid for one hour and provide runner-specific access
permissions. The token is scoped to a specific runner and can be used to access
support bundles.
### Examples
- Generate runner logs token:
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
runner_id: runner_id specifies the runner for which the logs token should be created.
+required
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/CreateRunnerLogsToken",
body=maybe_transform({"runner_id": runner_id}, runner_create_logs_token_params.RunnerCreateLogsTokenParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerCreateLogsTokenResponse,
)
def create_runner_token(
self,
*,
runner_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerCreateRunnerTokenResponse:
"""
Creates a new authentication token for a runner.
Use this method to:
- Generate runner credentials
- Renew expired tokens
- Set up runner authentication
Note: This does not expire previously issued tokens.
### Examples
- Create token:
Creates a new token for runner authentication.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/CreateRunnerToken",
body=maybe_transform(
{"runner_id": runner_id}, runner_create_runner_token_params.RunnerCreateRunnerTokenParams
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerCreateRunnerTokenResponse,
)
def list_scm_organizations(
self,
*,
token: str | Omit = omit,
page_size: int | Omit = omit,
runner_id: str | Omit = omit,
scm_host: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerListScmOrganizationsResponse:
"""
Lists SCM organizations the user belongs to.
Use this method to:
- Get all organizations for a user on a specific SCM host
- Check organization admin permissions for webhook creation
### Examples
- List GitHub organizations:
Lists all organizations the user belongs to on GitHub.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmHost: "github.com"
```
Args:
scm_host: The SCM host to list organizations from (e.g., "github.com", "gitlab.com")
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/ListSCMOrganizations",
body=maybe_transform(
{
"runner_id": runner_id,
"scm_host": scm_host,
},
runner_list_scm_organizations_params.RunnerListScmOrganizationsParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"token": token,
"page_size": page_size,
},
runner_list_scm_organizations_params.RunnerListScmOrganizationsParams,
),
),
cast_to=RunnerListScmOrganizationsResponse,
)
def parse_context_url(
self,
*,
context_url: str | Omit = omit,
runner_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerParseContextURLResponse:
"""
Parses a context URL and returns the parsed result.
Use this method to:
- Validate context URLs
- Check repository access
- Verify branch existence
Returns:
- FAILED_PRECONDITION if authentication is required
- PERMISSION_DENIED if access is not allowed
- INVALID_ARGUMENT if URL is invalid
- NOT_FOUND if repository/branch doesn't exist
### Examples
- Parse URL:
Parses and validates a context URL.
```yaml
contextUrl: "https://github.com/org/repo/tree/main"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/ParseContextURL",
body=maybe_transform(
{
"context_url": context_url,
"runner_id": runner_id,
},
runner_parse_context_url_params.RunnerParseContextURLParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerParseContextURLResponse,
)
def search_repositories(
self,
*,
limit: int | Omit = omit,
pagination: runner_search_repositories_params.Pagination | Omit = omit,
runner_id: str | Omit = omit,
scm_host: str | Omit = omit,
search_mode: SearchMode | Omit = omit,
search_string: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerSearchRepositoriesResponse:
"""
Searches for repositories across all authenticated SCM hosts.
Use this method to:
- List available repositories
- Search repositories by name or content
- Discover repositories for environment creation
Returns repositories from all authenticated SCM hosts in natural sort order. If
no repositories are found, returns an empty list.
### Examples
- List all repositories:
Returns up to 25 repositories from all authenticated hosts.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
- Search repositories:
Searches for repositories matching the query across all hosts.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
searchString: "my-project"
limit: 10
```
Args:
limit:
Maximum number of repositories to return. Default: 25, Maximum: 100 Deprecated:
Use pagination.page_size instead
pagination: Pagination parameters for repository search
scm_host: The SCM's host to retrieve repositories from
search_mode: Search mode determines how search_string is interpreted
search_string: Search query - interpretation depends on search_mode
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerService/SearchRepositories",
body=maybe_transform(
{
"limit": limit,
"pagination": pagination,
"runner_id": runner_id,
"scm_host": scm_host,
"search_mode": search_mode,
"search_string": search_string,
},
runner_search_repositories_params.RunnerSearchRepositoriesParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=RunnerSearchRepositoriesResponse,
)
class AsyncRunnersResource(AsyncAPIResource):
@cached_property
def configurations(self) -> AsyncConfigurationsResource:
return AsyncConfigurationsResource(self._client)
@cached_property
def policies(self) -> AsyncPoliciesResource:
return AsyncPoliciesResource(self._client)
@cached_property
def with_raw_response(self) -> AsyncRunnersResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncRunnersResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncRunnersResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncRunnersResourceWithStreamingResponse(self)
async def create(
self,
*,
kind: RunnerKind | Omit = omit,
name: str | Omit = omit,
provider: RunnerProvider | Omit = omit,
runner_manager_id: str | Omit = omit,
spec: RunnerSpecParam | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> RunnerCreateResponse:
"""Creates a new runner registration with the server.
Registrations are very
short-lived and must be renewed every 30 seconds.
Use this method to:
- Register organization runners
- Set up runner configurations
- Initialize runner credentials
- Configure auto-updates
### Examples
- Create cloud runner:
Creates a new runner in AWS EC2.
```yaml
name: "Production Runner"
provider: RUNNER_PROVIDER_AWS_EC2
spec:
desiredPhase: RUNNER_PHASE_ACTIVE
configuration:
region: "us-west"
releaseChannel: RUNNER_RELEASE_CHANNEL_STABLE
autoUpdate: true
```
- Create local runner:
Creates a new local runner on Linux.
```yaml
name: "Local Development Runner"
provider: RUNNER_PROVIDER_LINUX_HOST
spec:
desiredPhase: RUNNER_PHASE_ACTIVE
configuration:
releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST
autoUpdate: true
```
Args:
kind: The runner's kind This field is optional and here for backwards-compatibility.
Use the provider field instead. If provider is set, the runner's kind will be
deduced from the provider. Only one of kind and provider must be set.
name: The runner name for humans
provider: The specific implementation type of the runner This field is optional for
backwards compatibility but will be required in the future. When specified, kind
must not be specified (will be deduced from provider)
runner_manager_id: The runner manager id specifies the runner manager for the managed runner. This
field is mandatory for managed runners, otheriwse should not be set.
extra_headers: Send extra headers