spinnaker-gate-ruby-client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +8 -0
  3. data/Gemfile.lock +85 -0
  4. data/LICENSE +201 -0
  5. data/README.md +240 -0
  6. data/Rakefile +8 -0
  7. data/docs/Account.md +14 -0
  8. data/docs/AccountDetails.md +19 -0
  9. data/docs/AmazonInfrastructureControllerApi.md +128 -0
  10. data/docs/ApplicationControllerApi.md +754 -0
  11. data/docs/ArtifactControllerApi.md +111 -0
  12. data/docs/AuthControllerApi.md +212 -0
  13. data/docs/BakeControllerApi.md +143 -0
  14. data/docs/BuildControllerApi.md +493 -0
  15. data/docs/ClusterControllerApi.md +475 -0
  16. data/docs/ConcourseControllerApi.md +161 -0
  17. data/docs/CredentialsControllerApi.md +129 -0
  18. data/docs/EcsServerGroupEventsControllerApi.md +66 -0
  19. data/docs/ExecutionsControllerApi.md +133 -0
  20. data/docs/FirewallControllerApi.md +171 -0
  21. data/docs/GrantedAuthority.md +8 -0
  22. data/docs/HashMapstringobject.md +7 -0
  23. data/docs/HttpEntity.md +8 -0
  24. data/docs/ImageControllerApi.md +178 -0
  25. data/docs/InstanceControllerApi.md +122 -0
  26. data/docs/JobControllerApi.md +69 -0
  27. data/docs/LoadBalancerControllerApi.md +217 -0
  28. data/docs/Mapstringstring.md +7 -0
  29. data/docs/NetworkControllerApi.md +105 -0
  30. data/docs/PipelineConfigControllerApi.md +144 -0
  31. data/docs/PipelineControllerApi.md +1074 -0
  32. data/docs/PipelineTemplateDependent.md +10 -0
  33. data/docs/PipelineTemplatesControllerApi.md +350 -0
  34. data/docs/ProjectControllerApi.md +196 -0
  35. data/docs/PubsubSubscriptionControllerApi.md +48 -0
  36. data/docs/ReorderPipelinesCommand.md +9 -0
  37. data/docs/ReorderPipelinesControllerApi.md +54 -0
  38. data/docs/ResponseEntity.md +10 -0
  39. data/docs/SearchControllerApi.md +68 -0
  40. data/docs/SecurityGroupControllerApi.md +171 -0
  41. data/docs/ServerGroupControllerApi.md +125 -0
  42. data/docs/ServerGroupManagerControllerApi.md +54 -0
  43. data/docs/SnapshotControllerApi.md +110 -0
  44. data/docs/SubnetControllerApi.md +58 -0
  45. data/docs/TaskControllerApi.md +291 -0
  46. data/docs/User.md +18 -0
  47. data/docs/V2CanaryConfigControllerApi.md +259 -0
  48. data/docs/V2CanaryControllerApi.md +356 -0
  49. data/docs/V2PipelineTemplatesControllerApi.md +356 -0
  50. data/docs/Version.md +8 -0
  51. data/docs/VersionControllerApi.md +48 -0
  52. data/docs/WebhookControllerApi.md +105 -0
  53. data/git_push.sh +55 -0
  54. data/lib/swagger_client.rb +85 -0
  55. data/lib/swagger_client/api/amazon_infrastructure_controller_api.rb +161 -0
  56. data/lib/swagger_client/api/application_controller_api.rb +868 -0
  57. data/lib/swagger_client/api/artifact_controller_api.rb +141 -0
  58. data/lib/swagger_client/api/auth_controller_api.rb +258 -0
  59. data/lib/swagger_client/api/bake_controller_api.rb +179 -0
  60. data/lib/swagger_client/api/build_controller_api.rb +588 -0
  61. data/lib/swagger_client/api/cluster_controller_api.rb +591 -0
  62. data/lib/swagger_client/api/concourse_controller_api.rb +209 -0
  63. data/lib/swagger_client/api/credentials_controller_api.rb +163 -0
  64. data/lib/swagger_client/api/ecs_server_group_events_controller_api.rb +101 -0
  65. data/lib/swagger_client/api/executions_controller_api.rb +169 -0
  66. data/lib/swagger_client/api/firewall_controller_api.rb +209 -0
  67. data/lib/swagger_client/api/image_controller_api.rb +222 -0
  68. data/lib/swagger_client/api/instance_controller_api.rb +160 -0
  69. data/lib/swagger_client/api/job_controller_api.rb +99 -0
  70. data/lib/swagger_client/api/load_balancer_controller_api.rb +258 -0
  71. data/lib/swagger_client/api/network_controller_api.rb +127 -0
  72. data/lib/swagger_client/api/pipeline_config_controller_api.rb +176 -0
  73. data/lib/swagger_client/api/pipeline_controller_api.rb +1268 -0
  74. data/lib/swagger_client/api/pipeline_templates_controller_api.rb +404 -0
  75. data/lib/swagger_client/api/project_controller_api.rb +234 -0
  76. data/lib/swagger_client/api/pubsub_subscription_controller_api.rb +69 -0
  77. data/lib/swagger_client/api/reorder_pipelines_controller_api.rb +75 -0
  78. data/lib/swagger_client/api/search_controller_api.rb +94 -0
  79. data/lib/swagger_client/api/security_group_controller_api.rb +209 -0
  80. data/lib/swagger_client/api/server_group_controller_api.rb +163 -0
  81. data/lib/swagger_client/api/server_group_manager_controller_api.rb +75 -0
  82. data/lib/swagger_client/api/snapshot_controller_api.rb +142 -0
  83. data/lib/swagger_client/api/subnet_controller_api.rb +78 -0
  84. data/lib/swagger_client/api/task_controller_api.rb +345 -0
  85. data/lib/swagger_client/api/v2_canary_config_controller_api.rb +300 -0
  86. data/lib/swagger_client/api/v2_canary_controller_api.rb +421 -0
  87. data/lib/swagger_client/api/v2_pipeline_templates_controller_api.rb +412 -0
  88. data/lib/swagger_client/api/version_controller_api.rb +69 -0
  89. data/lib/swagger_client/api/webhook_controller_api.rb +135 -0
  90. data/lib/swagger_client/api_client.rb +388 -0
  91. data/lib/swagger_client/api_error.rb +38 -0
  92. data/lib/swagger_client/configuration.rb +202 -0
  93. data/lib/swagger_client/models/account.rb +241 -0
  94. data/lib/swagger_client/models/account_details.rb +286 -0
  95. data/lib/swagger_client/models/granted_authority.rb +183 -0
  96. data/lib/swagger_client/models/hash_mapstringobject.rb +174 -0
  97. data/lib/swagger_client/models/http_entity.rb +183 -0
  98. data/lib/swagger_client/models/mapstringstring.rb +174 -0
  99. data/lib/swagger_client/models/pipeline_template_dependent.rb +201 -0
  100. data/lib/swagger_client/models/reorder_pipelines_command.rb +194 -0
  101. data/lib/swagger_client/models/response_entity.rb +235 -0
  102. data/lib/swagger_client/models/user.rb +279 -0
  103. data/lib/swagger_client/models/version.rb +183 -0
  104. data/lib/swagger_client/version.rb +15 -0
  105. data/spec/api/amazon_infrastructure_controller_api_spec.rb +65 -0
  106. data/spec/api/application_controller_api_spec.rb +218 -0
  107. data/spec/api/artifact_controller_api_spec.rb +60 -0
  108. data/spec/api/auth_controller_api_spec.rb +86 -0
  109. data/spec/api/bake_controller_api_spec.rb +68 -0
  110. data/spec/api/build_controller_api_spec.rb +155 -0
  111. data/spec/api/cluster_controller_api_spec.rb +155 -0
  112. data/spec/api/concourse_controller_api_spec.rb +73 -0
  113. data/spec/api/credentials_controller_api_spec.rb +70 -0
  114. data/spec/api/ecs_server_group_events_controller_api_spec.rb +50 -0
  115. data/spec/api/executions_controller_api_spec.rb +72 -0
  116. data/spec/api/firewall_controller_api_spec.rb +77 -0
  117. data/spec/api/image_controller_api_spec.rb +80 -0
  118. data/spec/api/instance_controller_api_spec.rb +64 -0
  119. data/spec/api/job_controller_api_spec.rb +51 -0
  120. data/spec/api/load_balancer_controller_api_spec.rb +87 -0
  121. data/spec/api/network_controller_api_spec.rb +58 -0
  122. data/spec/api/pipeline_config_controller_api_spec.rb +68 -0
  123. data/spec/api/pipeline_controller_api_spec.rb +296 -0
  124. data/spec/api/pipeline_templates_controller_api_spec.rb +118 -0
  125. data/spec/api/project_controller_api_spec.rb +81 -0
  126. data/spec/api/pubsub_subscription_controller_api_spec.rb +45 -0
  127. data/spec/api/reorder_pipelines_controller_api_spec.rb +46 -0
  128. data/spec/api/search_controller_api_spec.rb +52 -0
  129. data/spec/api/security_group_controller_api_spec.rb +77 -0
  130. data/spec/api/server_group_controller_api_spec.rb +66 -0
  131. data/spec/api/server_group_manager_controller_api_spec.rb +46 -0
  132. data/spec/api/snapshot_controller_api_spec.rb +60 -0
  133. data/spec/api/subnet_controller_api_spec.rb +47 -0
  134. data/spec/api/task_controller_api_spec.rb +103 -0
  135. data/spec/api/v2_canary_config_controller_api_spec.rb +96 -0
  136. data/spec/api/v2_canary_controller_api_spec.rb +123 -0
  137. data/spec/api/v2_pipeline_templates_controller_api_spec.rb +121 -0
  138. data/spec/api/version_controller_api_spec.rb +45 -0
  139. data/spec/api/webhook_controller_api_spec.rb +60 -0
  140. data/spec/api_client_spec.rb +226 -0
  141. data/spec/configuration_spec.rb +42 -0
  142. data/spec/models/account_details_spec.rb +107 -0
  143. data/spec/models/account_spec.rb +77 -0
  144. data/spec/models/granted_authority_spec.rb +41 -0
  145. data/spec/models/hash_mapstringobject_spec.rb +35 -0
  146. data/spec/models/http_entity_spec.rb +41 -0
  147. data/spec/models/mapstringstring_spec.rb +35 -0
  148. data/spec/models/pipeline_template_dependent_spec.rb +53 -0
  149. data/spec/models/reorder_pipelines_command_spec.rb +47 -0
  150. data/spec/models/response_entity_spec.rb +57 -0
  151. data/spec/models/user_spec.rb +101 -0
  152. data/spec/models/version_spec.rb +41 -0
  153. data/spec/spec_helper.rb +111 -0
  154. data/spinnaker_gate_ruby_client-1.0.0.gem +0 -0
  155. data/spinnaker_gate_ruby_client.gemspec +45 -0
  156. metadata +427 -0
@@ -0,0 +1,161 @@
1
+ # SwaggerClient::ConcourseControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**jobs_using_get**](ConcourseControllerApi.md#jobs_using_get) | **GET** /concourse/{buildMaster}/teams/{team}/pipelines/{pipeline}/jobs | Retrieve the list of job names for a given pipeline available to triggers
8
+ [**pipelines_using_get**](ConcourseControllerApi.md#pipelines_using_get) | **GET** /concourse/{buildMaster}/teams/{team}/pipelines | Retrieve the list of pipeline names for a given team available to triggers
9
+ [**resources_using_get**](ConcourseControllerApi.md#resources_using_get) | **GET** /concourse/{buildMaster}/teams/{team}/pipelines/{pipeline}/resources | Retrieve the list of resource names for a given pipeline available to the Concourse stage
10
+
11
+
12
+ # **jobs_using_get**
13
+ > Array<Object> jobs_using_get(build_master, team, pipeline)
14
+
15
+ Retrieve the list of job names for a given pipeline available to triggers
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'swagger_client'
21
+
22
+ api_instance = SwaggerClient::ConcourseControllerApi.new
23
+
24
+ build_master = 'build_master_example' # String | buildMaster
25
+
26
+ team = 'team_example' # String | team
27
+
28
+ pipeline = 'pipeline_example' # String | pipeline
29
+
30
+
31
+ begin
32
+ #Retrieve the list of job names for a given pipeline available to triggers
33
+ result = api_instance.jobs_using_get(build_master, team, pipeline)
34
+ p result
35
+ rescue SwaggerClient::ApiError => e
36
+ puts "Exception when calling ConcourseControllerApi->jobs_using_get: #{e}"
37
+ end
38
+ ```
39
+
40
+ ### Parameters
41
+
42
+ Name | Type | Description | Notes
43
+ ------------- | ------------- | ------------- | -------------
44
+ **build_master** | **String**| buildMaster |
45
+ **team** | **String**| team |
46
+ **pipeline** | **String**| pipeline |
47
+
48
+ ### Return type
49
+
50
+ **Array<Object>**
51
+
52
+ ### Authorization
53
+
54
+ No authorization required
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: application/json
59
+ - **Accept**: */*
60
+
61
+
62
+
63
+ # **pipelines_using_get**
64
+ > Array<Object> pipelines_using_get(build_master, team)
65
+
66
+ Retrieve the list of pipeline names for a given team available to triggers
67
+
68
+ ### Example
69
+ ```ruby
70
+ # load the gem
71
+ require 'swagger_client'
72
+
73
+ api_instance = SwaggerClient::ConcourseControllerApi.new
74
+
75
+ build_master = 'build_master_example' # String | buildMaster
76
+
77
+ team = 'team_example' # String | team
78
+
79
+
80
+ begin
81
+ #Retrieve the list of pipeline names for a given team available to triggers
82
+ result = api_instance.pipelines_using_get(build_master, team)
83
+ p result
84
+ rescue SwaggerClient::ApiError => e
85
+ puts "Exception when calling ConcourseControllerApi->pipelines_using_get: #{e}"
86
+ end
87
+ ```
88
+
89
+ ### Parameters
90
+
91
+ Name | Type | Description | Notes
92
+ ------------- | ------------- | ------------- | -------------
93
+ **build_master** | **String**| buildMaster |
94
+ **team** | **String**| team |
95
+
96
+ ### Return type
97
+
98
+ **Array<Object>**
99
+
100
+ ### Authorization
101
+
102
+ No authorization required
103
+
104
+ ### HTTP request headers
105
+
106
+ - **Content-Type**: application/json
107
+ - **Accept**: */*
108
+
109
+
110
+
111
+ # **resources_using_get**
112
+ > Array<Object> resources_using_get(build_master, team, pipeline)
113
+
114
+ Retrieve the list of resource names for a given pipeline available to the Concourse stage
115
+
116
+ ### Example
117
+ ```ruby
118
+ # load the gem
119
+ require 'swagger_client'
120
+
121
+ api_instance = SwaggerClient::ConcourseControllerApi.new
122
+
123
+ build_master = 'build_master_example' # String | buildMaster
124
+
125
+ team = 'team_example' # String | team
126
+
127
+ pipeline = 'pipeline_example' # String | pipeline
128
+
129
+
130
+ begin
131
+ #Retrieve the list of resource names for a given pipeline available to the Concourse stage
132
+ result = api_instance.resources_using_get(build_master, team, pipeline)
133
+ p result
134
+ rescue SwaggerClient::ApiError => e
135
+ puts "Exception when calling ConcourseControllerApi->resources_using_get: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ Name | Type | Description | Notes
142
+ ------------- | ------------- | ------------- | -------------
143
+ **build_master** | **String**| buildMaster |
144
+ **team** | **String**| team |
145
+ **pipeline** | **String**| pipeline |
146
+
147
+ ### Return type
148
+
149
+ **Array<Object>**
150
+
151
+ ### Authorization
152
+
153
+ No authorization required
154
+
155
+ ### HTTP request headers
156
+
157
+ - **Content-Type**: application/json
158
+ - **Accept**: */*
159
+
160
+
161
+
@@ -0,0 +1,129 @@
1
+ # SwaggerClient::CredentialsControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_account_using_get**](CredentialsControllerApi.md#get_account_using_get) | **GET** /credentials/{account} | Retrieve an account's details
8
+ [**get_accounts_using_get**](CredentialsControllerApi.md#get_accounts_using_get) | **GET** /credentials | Retrieve a list of accounts
9
+
10
+
11
+ # **get_account_using_get**
12
+ > AccountDetails get_account_using_get(account, opts)
13
+
14
+ Retrieve an account's details
15
+
16
+ ### Example
17
+ ```ruby
18
+ # load the gem
19
+ require 'swagger_client'
20
+
21
+ api_instance = SwaggerClient::CredentialsControllerApi.new
22
+
23
+ account = 'account_example' # String | account
24
+
25
+ opts = {
26
+ roles: ['roles_example'], # Array<String> |
27
+ allowed_accounts: ['allowed_accounts_example'], # Array<String> |
28
+ email: 'email_example', # String |
29
+ username: 'username_example', # String |
30
+ first_name: 'first_name_example', # String |
31
+ last_name: 'last_name_example', # String |
32
+ x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
33
+ }
34
+
35
+ begin
36
+ #Retrieve an account's details
37
+ result = api_instance.get_account_using_get(account, opts)
38
+ p result
39
+ rescue SwaggerClient::ApiError => e
40
+ puts "Exception when calling CredentialsControllerApi->get_account_using_get: #{e}"
41
+ end
42
+ ```
43
+
44
+ ### Parameters
45
+
46
+ Name | Type | Description | Notes
47
+ ------------- | ------------- | ------------- | -------------
48
+ **account** | **String**| account |
49
+ **roles** | [**Array&lt;String&gt;**](String.md)| | [optional]
50
+ **allowed_accounts** | [**Array&lt;String&gt;**](String.md)| | [optional]
51
+ **email** | **String**| | [optional]
52
+ **username** | **String**| | [optional]
53
+ **first_name** | **String**| | [optional]
54
+ **last_name** | **String**| | [optional]
55
+ **x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
56
+
57
+ ### Return type
58
+
59
+ [**AccountDetails**](AccountDetails.md)
60
+
61
+ ### Authorization
62
+
63
+ No authorization required
64
+
65
+ ### HTTP request headers
66
+
67
+ - **Content-Type**: application/json
68
+ - **Accept**: */*
69
+
70
+
71
+
72
+ # **get_accounts_using_get**
73
+ > Array&lt;Account&gt; get_accounts_using_get(opts)
74
+
75
+ Retrieve a list of accounts
76
+
77
+ ### Example
78
+ ```ruby
79
+ # load the gem
80
+ require 'swagger_client'
81
+
82
+ api_instance = SwaggerClient::CredentialsControllerApi.new
83
+
84
+ opts = {
85
+ roles: ['roles_example'], # Array<String> |
86
+ allowed_accounts: ['allowed_accounts_example'], # Array<String> |
87
+ email: 'email_example', # String |
88
+ username: 'username_example', # String |
89
+ first_name: 'first_name_example', # String |
90
+ last_name: 'last_name_example', # String |
91
+ expand: true # BOOLEAN | expand
92
+ }
93
+
94
+ begin
95
+ #Retrieve a list of accounts
96
+ result = api_instance.get_accounts_using_get(opts)
97
+ p result
98
+ rescue SwaggerClient::ApiError => e
99
+ puts "Exception when calling CredentialsControllerApi->get_accounts_using_get: #{e}"
100
+ end
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+ Name | Type | Description | Notes
106
+ ------------- | ------------- | ------------- | -------------
107
+ **roles** | [**Array&lt;String&gt;**](String.md)| | [optional]
108
+ **allowed_accounts** | [**Array&lt;String&gt;**](String.md)| | [optional]
109
+ **email** | **String**| | [optional]
110
+ **username** | **String**| | [optional]
111
+ **first_name** | **String**| | [optional]
112
+ **last_name** | **String**| | [optional]
113
+ **expand** | **BOOLEAN**| expand | [optional]
114
+
115
+ ### Return type
116
+
117
+ [**Array&lt;Account&gt;**](Account.md)
118
+
119
+ ### Authorization
120
+
121
+ No authorization required
122
+
123
+ ### HTTP request headers
124
+
125
+ - **Content-Type**: application/json
126
+ - **Accept**: */*
127
+
128
+
129
+
@@ -0,0 +1,66 @@
1
+ # SwaggerClient::EcsServerGroupEventsControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_events_using_get**](EcsServerGroupEventsControllerApi.md#get_events_using_get) | **GET** /applications/{application}/serverGroups/{account}/{serverGroupName}/events | Retrieves a list of events for a server group
8
+
9
+
10
+ # **get_events_using_get**
11
+ > Array&lt;Object&gt; get_events_using_get(application, account, server_group_name, region, provider)
12
+
13
+ Retrieves a list of events for a server group
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'swagger_client'
19
+
20
+ api_instance = SwaggerClient::EcsServerGroupEventsControllerApi.new
21
+
22
+ application = 'application_example' # String | application
23
+
24
+ account = 'account_example' # String | account
25
+
26
+ server_group_name = 'server_group_name_example' # String | serverGroupName
27
+
28
+ region = 'region_example' # String | region
29
+
30
+ provider = 'provider_example' # String | provider
31
+
32
+
33
+ begin
34
+ #Retrieves a list of events for a server group
35
+ result = api_instance.get_events_using_get(application, account, server_group_name, region, provider)
36
+ p result
37
+ rescue SwaggerClient::ApiError => e
38
+ puts "Exception when calling EcsServerGroupEventsControllerApi->get_events_using_get: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ Name | Type | Description | Notes
45
+ ------------- | ------------- | ------------- | -------------
46
+ **application** | **String**| application |
47
+ **account** | **String**| account |
48
+ **server_group_name** | **String**| serverGroupName |
49
+ **region** | **String**| region |
50
+ **provider** | **String**| provider |
51
+
52
+ ### Return type
53
+
54
+ **Array&lt;Object&gt;**
55
+
56
+ ### Authorization
57
+
58
+ No authorization required
59
+
60
+ ### HTTP request headers
61
+
62
+ - **Content-Type**: application/json
63
+ - **Accept**: */*
64
+
65
+
66
+
@@ -0,0 +1,133 @@
1
+ # SwaggerClient::ExecutionsControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_latest_executions_by_config_ids_using_get**](ExecutionsControllerApi.md#get_latest_executions_by_config_ids_using_get) | **GET** /executions | Retrieves an ad-hoc collection of executions based on a number of user-supplied parameters. Either executionIds or pipelineConfigIds must be supplied in order to return any results. If both are supplied, an exception will be thrown.
8
+ [**search_for_pipeline_executions_by_trigger_using_get**](ExecutionsControllerApi.md#search_for_pipeline_executions_by_trigger_using_get) | **GET** /applications/{application}/executions/search | Search for pipeline executions using a combination of criteria. The returned list is sorted by buildTime (trigger time) in reverse order so that newer executions are first in the list.
9
+
10
+
11
+ # **get_latest_executions_by_config_ids_using_get**
12
+ > Array&lt;Object&gt; get_latest_executions_by_config_ids_using_get(opts)
13
+
14
+ Retrieves an ad-hoc collection of executions based on a number of user-supplied parameters. Either executionIds or pipelineConfigIds must be supplied in order to return any results. If both are supplied, an exception will be thrown.
15
+
16
+ ### Example
17
+ ```ruby
18
+ # load the gem
19
+ require 'swagger_client'
20
+
21
+ api_instance = SwaggerClient::ExecutionsControllerApi.new
22
+
23
+ opts = {
24
+ pipeline_config_ids: 'pipeline_config_ids_example', # String | A comma-separated list of pipeline configuration IDs to retrieve recent executions for. Either this OR pipelineConfigIds must be supplied, but not both.
25
+ execution_ids: 'execution_ids_example', # String | A comma-separated list of executions to retrieve. Either this OR pipelineConfigIds must be supplied, but not both.
26
+ limit: 56, # Integer | The number of executions to return per pipeline configuration. Ignored if executionIds parameter is supplied. If this value is missing, it is defaulted to 1.
27
+ statuses: 'statuses_example', # String | A comma-separated list of execution statuses to filter by. Ignored if executionIds parameter is supplied. If this value is missing, it is defaulted to all statuses.
28
+ expand: true # BOOLEAN | Expands each execution object in the resulting list. If this value is missing, it is defaulted to true.
29
+ }
30
+
31
+ begin
32
+ #Retrieves an ad-hoc collection of executions based on a number of user-supplied parameters. Either executionIds or pipelineConfigIds must be supplied in order to return any results. If both are supplied, an exception will be thrown.
33
+ result = api_instance.get_latest_executions_by_config_ids_using_get(opts)
34
+ p result
35
+ rescue SwaggerClient::ApiError => e
36
+ puts "Exception when calling ExecutionsControllerApi->get_latest_executions_by_config_ids_using_get: #{e}"
37
+ end
38
+ ```
39
+
40
+ ### Parameters
41
+
42
+ Name | Type | Description | Notes
43
+ ------------- | ------------- | ------------- | -------------
44
+ **pipeline_config_ids** | **String**| A comma-separated list of pipeline configuration IDs to retrieve recent executions for. Either this OR pipelineConfigIds must be supplied, but not both. | [optional]
45
+ **execution_ids** | **String**| A comma-separated list of executions to retrieve. Either this OR pipelineConfigIds must be supplied, but not both. | [optional]
46
+ **limit** | **Integer**| The number of executions to return per pipeline configuration. Ignored if executionIds parameter is supplied. If this value is missing, it is defaulted to 1. | [optional]
47
+ **statuses** | **String**| A comma-separated list of execution statuses to filter by. Ignored if executionIds parameter is supplied. If this value is missing, it is defaulted to all statuses. | [optional]
48
+ **expand** | **BOOLEAN**| Expands each execution object in the resulting list. If this value is missing, it is defaulted to true. | [optional] [default to true]
49
+
50
+ ### Return type
51
+
52
+ **Array&lt;Object&gt;**
53
+
54
+ ### Authorization
55
+
56
+ No authorization required
57
+
58
+ ### HTTP request headers
59
+
60
+ - **Content-Type**: application/json
61
+ - **Accept**: */*
62
+
63
+
64
+
65
+ # **search_for_pipeline_executions_by_trigger_using_get**
66
+ > Array&lt;Object&gt; search_for_pipeline_executions_by_trigger_using_get(application, opts)
67
+
68
+ Search for pipeline executions using a combination of criteria. The returned list is sorted by buildTime (trigger time) in reverse order so that newer executions are first in the list.
69
+
70
+ ### Example
71
+ ```ruby
72
+ # load the gem
73
+ require 'swagger_client'
74
+
75
+ api_instance = SwaggerClient::ExecutionsControllerApi.new
76
+
77
+ application = 'application_example' # String | Only includes executions that are part of this application. If this value is \"*\", results will include executions of all applications.
78
+
79
+ opts = {
80
+ trigger_types: 'trigger_types_example', # String | Only includes executions that were triggered by a trigger with a type that is equal to a type provided in this field. The list of trigger types should be a comma-delimited string. If this value is missing, results will includes executions of all trigger types.
81
+ pipeline_name: 'pipeline_name_example', # String | Only includes executions that with this pipeline name.
82
+ event_id: 'event_id_example', # String | Only includes executions that were triggered by a trigger with this eventId.
83
+ trigger: 'trigger_example', # String | Only includes executions that were triggered by a trigger that matches the subset of fields provided by this value. This value should be a base64-encoded string of a JSON representation of a trigger object. The comparison succeeds if the execution trigger contains all the fields of the input trigger, the fields are of the same type, and each value of the field \"matches\". The term \"matches\" is specific for each field's type: - For Strings: A String value in the execution's trigger matches the input trigger's String value if the former equals the latter (case-insensitive) OR if the former matches the latter as a regular expression. - For Maps: A Map value in the execution's trigger matches the input trigger's Map value if the former contains all keys of the latter and their values match. - For Collections: A Collection value in the execution's trigger matches the input trigger's Collection value if the former has a unique element that matches each element of the latter. - Every other value is compared using the Java \"equals\" method (Groovy \"==\" operator)
84
+ trigger_time_start_boundary: 0, # Integer | Only includes executions that were built at or after the given time, represented as a Unix timestamp in ms (UTC). This value must be >= 0 and <= the value of [triggerTimeEndBoundary], if provided. If this value is missing, it is defaulted to 0.
85
+ trigger_time_end_boundary: 789, # Integer | Only includes executions that were built at or before the given time, represented as a Unix timestamp in ms (UTC). This value must be <= 9223372036854775807 (Long.MAX_VALUE) and >= the value of [triggerTimeStartBoundary], if provided. If this value is missing, it is defaulted to 9223372036854775807.
86
+ statuses: 'statuses_example', # String | Only includes executions with a status that is equal to a status provided in this field. The list of statuses should be given as a comma-delimited string. If this value is missing, includes executions of all statuses. Allowed statuses are: NOT_STARTED, RUNNING, PAUSED, SUSPENDED, SUCCEEDED, FAILED_CONTINUE, TERMINAL, CANCELED, REDIRECT, STOPPED, SKIPPED, BUFFERED.
87
+ start_index: 0, # Integer | Sets the first item of the resulting list for pagination. The list is 0-indexed. This value must be >= 0. If this value is missing, it is defaulted to 0.
88
+ size: 10, # Integer | Sets the size of the resulting list for pagination. This value must be > 0. If this value is missing, it is defaulted to 10.
89
+ reverse: false, # BOOLEAN | Reverses the resulting list before it is paginated. If this value is missing, it is defaulted to false.
90
+ expand: false # BOOLEAN | Expands each execution object in the resulting list. If this value is missing, it is defaulted to false.
91
+ }
92
+
93
+ begin
94
+ #Search for pipeline executions using a combination of criteria. The returned list is sorted by buildTime (trigger time) in reverse order so that newer executions are first in the list.
95
+ result = api_instance.search_for_pipeline_executions_by_trigger_using_get(application, opts)
96
+ p result
97
+ rescue SwaggerClient::ApiError => e
98
+ puts "Exception when calling ExecutionsControllerApi->search_for_pipeline_executions_by_trigger_using_get: #{e}"
99
+ end
100
+ ```
101
+
102
+ ### Parameters
103
+
104
+ Name | Type | Description | Notes
105
+ ------------- | ------------- | ------------- | -------------
106
+ **application** | **String**| Only includes executions that are part of this application. If this value is \&quot;*\&quot;, results will include executions of all applications. |
107
+ **trigger_types** | **String**| Only includes executions that were triggered by a trigger with a type that is equal to a type provided in this field. The list of trigger types should be a comma-delimited string. If this value is missing, results will includes executions of all trigger types. | [optional]
108
+ **pipeline_name** | **String**| Only includes executions that with this pipeline name. | [optional]
109
+ **event_id** | **String**| Only includes executions that were triggered by a trigger with this eventId. | [optional]
110
+ **trigger** | **String**| Only includes executions that were triggered by a trigger that matches the subset of fields provided by this value. This value should be a base64-encoded string of a JSON representation of a trigger object. The comparison succeeds if the execution trigger contains all the fields of the input trigger, the fields are of the same type, and each value of the field \&quot;matches\&quot;. The term \&quot;matches\&quot; is specific for each field&#39;s type: - For Strings: A String value in the execution&#39;s trigger matches the input trigger&#39;s String value if the former equals the latter (case-insensitive) OR if the former matches the latter as a regular expression. - For Maps: A Map value in the execution&#39;s trigger matches the input trigger&#39;s Map value if the former contains all keys of the latter and their values match. - For Collections: A Collection value in the execution&#39;s trigger matches the input trigger&#39;s Collection value if the former has a unique element that matches each element of the latter. - Every other value is compared using the Java \&quot;equals\&quot; method (Groovy \&quot;&#x3D;&#x3D;\&quot; operator) | [optional]
111
+ **trigger_time_start_boundary** | **Integer**| Only includes executions that were built at or after the given time, represented as a Unix timestamp in ms (UTC). This value must be &gt;&#x3D; 0 and &lt;&#x3D; the value of [triggerTimeEndBoundary], if provided. If this value is missing, it is defaulted to 0. | [optional] [default to 0]
112
+ **trigger_time_end_boundary** | **Integer**| Only includes executions that were built at or before the given time, represented as a Unix timestamp in ms (UTC). This value must be &lt;&#x3D; 9223372036854775807 (Long.MAX_VALUE) and &gt;&#x3D; the value of [triggerTimeStartBoundary], if provided. If this value is missing, it is defaulted to 9223372036854775807. | [optional]
113
+ **statuses** | **String**| Only includes executions with a status that is equal to a status provided in this field. The list of statuses should be given as a comma-delimited string. If this value is missing, includes executions of all statuses. Allowed statuses are: NOT_STARTED, RUNNING, PAUSED, SUSPENDED, SUCCEEDED, FAILED_CONTINUE, TERMINAL, CANCELED, REDIRECT, STOPPED, SKIPPED, BUFFERED. | [optional]
114
+ **start_index** | **Integer**| Sets the first item of the resulting list for pagination. The list is 0-indexed. This value must be &gt;&#x3D; 0. If this value is missing, it is defaulted to 0. | [optional] [default to 0]
115
+ **size** | **Integer**| Sets the size of the resulting list for pagination. This value must be &gt; 0. If this value is missing, it is defaulted to 10. | [optional] [default to 10]
116
+ **reverse** | **BOOLEAN**| Reverses the resulting list before it is paginated. If this value is missing, it is defaulted to false. | [optional] [default to false]
117
+ **expand** | **BOOLEAN**| Expands each execution object in the resulting list. If this value is missing, it is defaulted to false. | [optional] [default to false]
118
+
119
+ ### Return type
120
+
121
+ **Array&lt;Object&gt;**
122
+
123
+ ### Authorization
124
+
125
+ No authorization required
126
+
127
+ ### HTTP request headers
128
+
129
+ - **Content-Type**: application/json
130
+ - **Accept**: */*
131
+
132
+
133
+