spinnaker_gate_ruby_client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) 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.gemspec +45 -0
  155. metadata +426 -0
@@ -0,0 +1,48 @@
1
+ # SwaggerClient::PubsubSubscriptionControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**all_using_get4**](PubsubSubscriptionControllerApi.md#all_using_get4) | **GET** /pubsub/subscriptions | Retrieve the list of pub/sub subscriptions configured in Echo.
8
+
9
+
10
+ # **all_using_get4**
11
+ > Array<Mapstringstring> all_using_get4
12
+
13
+ Retrieve the list of pub/sub subscriptions configured in Echo.
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'swagger_client'
19
+
20
+ api_instance = SwaggerClient::PubsubSubscriptionControllerApi.new
21
+
22
+ begin
23
+ #Retrieve the list of pub/sub subscriptions configured in Echo.
24
+ result = api_instance.all_using_get4
25
+ p result
26
+ rescue SwaggerClient::ApiError => e
27
+ puts "Exception when calling PubsubSubscriptionControllerApi->all_using_get4: #{e}"
28
+ end
29
+ ```
30
+
31
+ ### Parameters
32
+ This endpoint does not need any parameter.
33
+
34
+ ### Return type
35
+
36
+ [**Array<Mapstringstring>**](Mapstringstring.md)
37
+
38
+ ### Authorization
39
+
40
+ No authorization required
41
+
42
+ ### HTTP request headers
43
+
44
+ - **Content-Type**: application/json
45
+ - **Accept**: */*
46
+
47
+
48
+
@@ -0,0 +1,9 @@
1
+ # SwaggerClient::ReorderPipelinesCommand
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **application** | **String** | | [optional]
7
+ **ids_to_indices** | **Hash<String, Integer>** | | [optional]
8
+
9
+
@@ -0,0 +1,54 @@
1
+ # SwaggerClient::ReorderPipelinesControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**reorder_pipelines_using_post**](ReorderPipelinesControllerApi.md#reorder_pipelines_using_post) | **POST** /actions/pipelines/reorder | Re-order pipelines
8
+
9
+
10
+ # **reorder_pipelines_using_post**
11
+ > Object reorder_pipelines_using_post(reorder_pipelines_command)
12
+
13
+ Re-order pipelines
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'swagger_client'
19
+
20
+ api_instance = SwaggerClient::ReorderPipelinesControllerApi.new
21
+
22
+ reorder_pipelines_command = SwaggerClient::ReorderPipelinesCommand.new # ReorderPipelinesCommand | reorderPipelinesCommand
23
+
24
+
25
+ begin
26
+ #Re-order pipelines
27
+ result = api_instance.reorder_pipelines_using_post(reorder_pipelines_command)
28
+ p result
29
+ rescue SwaggerClient::ApiError => e
30
+ puts "Exception when calling ReorderPipelinesControllerApi->reorder_pipelines_using_post: #{e}"
31
+ end
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ Name | Type | Description | Notes
37
+ ------------- | ------------- | ------------- | -------------
38
+ **reorder_pipelines_command** | [**ReorderPipelinesCommand**](ReorderPipelinesCommand.md)| reorderPipelinesCommand |
39
+
40
+ ### Return type
41
+
42
+ **Object**
43
+
44
+ ### Authorization
45
+
46
+ No authorization required
47
+
48
+ ### HTTP request headers
49
+
50
+ - **Content-Type**: application/json
51
+ - **Accept**: */*
52
+
53
+
54
+
@@ -0,0 +1,10 @@
1
+ # SwaggerClient::ResponseEntity
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **body** | **Object** | | [optional]
7
+ **status_code** | **String** | | [optional]
8
+ **status_code_value** | **Integer** | | [optional]
9
+
10
+
@@ -0,0 +1,68 @@
1
+ # SwaggerClient::SearchControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**search_using_get**](SearchControllerApi.md#search_using_get) | **GET** /search | Search infrastructure
8
+
9
+
10
+ # **search_using_get**
11
+ > Array<Object> search_using_get(type, opts)
12
+
13
+ Search infrastructure
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'swagger_client'
19
+
20
+ api_instance = SwaggerClient::SearchControllerApi.new
21
+
22
+ type = 'type_example' # String | type
23
+
24
+ opts = {
25
+ q: 'q_example', # String | q
26
+ platform: 'platform_example', # String | platform
27
+ page_size: 10000, # Integer | pageSize
28
+ page: 1, # Integer | page
29
+ allow_short_query: false, # BOOLEAN | allowShortQuery
30
+ x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
31
+ }
32
+
33
+ begin
34
+ #Search infrastructure
35
+ result = api_instance.search_using_get(type, opts)
36
+ p result
37
+ rescue SwaggerClient::ApiError => e
38
+ puts "Exception when calling SearchControllerApi->search_using_get: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ Name | Type | Description | Notes
45
+ ------------- | ------------- | ------------- | -------------
46
+ **type** | **String**| type |
47
+ **q** | **String**| q | [optional]
48
+ **platform** | **String**| platform | [optional]
49
+ **page_size** | **Integer**| pageSize | [optional] [default to 10000]
50
+ **page** | **Integer**| page | [optional] [default to 1]
51
+ **allow_short_query** | **BOOLEAN**| allowShortQuery | [optional] [default to false]
52
+ **x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
53
+
54
+ ### Return type
55
+
56
+ **Array<Object>**
57
+
58
+ ### Authorization
59
+
60
+ No authorization required
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: application/json
65
+ - **Accept**: */*
66
+
67
+
68
+
@@ -0,0 +1,171 @@
1
+ # SwaggerClient::SecurityGroupControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**all_by_account_using_get1**](SecurityGroupControllerApi.md#all_by_account_using_get1) | **GET** /securityGroups/{account} | Retrieve a list of security groups for a given account, grouped by region
8
+ [**all_using_get5**](SecurityGroupControllerApi.md#all_using_get5) | **GET** /securityGroups | Retrieve a list of security groups, grouped by account, cloud provider, and region
9
+ [**get_security_group_using_get1**](SecurityGroupControllerApi.md#get_security_group_using_get1) | **GET** /securityGroups/{account}/{region}/{name} | Retrieve a security group's details
10
+
11
+
12
+ # **all_by_account_using_get1**
13
+ > Object all_by_account_using_get1(account, opts)
14
+
15
+ Retrieve a list of security groups for a given account, grouped by region
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'swagger_client'
21
+
22
+ api_instance = SwaggerClient::SecurityGroupControllerApi.new
23
+
24
+ account = 'account_example' # String | account
25
+
26
+ opts = {
27
+ provider: 'aws', # String | provider
28
+ region: 'region_example', # String | region
29
+ x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
30
+ }
31
+
32
+ begin
33
+ #Retrieve a list of security groups for a given account, grouped by region
34
+ result = api_instance.all_by_account_using_get1(account, opts)
35
+ p result
36
+ rescue SwaggerClient::ApiError => e
37
+ puts "Exception when calling SecurityGroupControllerApi->all_by_account_using_get1: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **account** | **String**| account |
46
+ **provider** | **String**| provider | [optional] [default to aws]
47
+ **region** | **String**| region | [optional]
48
+ **x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
49
+
50
+ ### Return type
51
+
52
+ **Object**
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
+ # **all_using_get5**
66
+ > Object all_using_get5(opts)
67
+
68
+ Retrieve a list of security groups, grouped by account, cloud provider, and region
69
+
70
+ ### Example
71
+ ```ruby
72
+ # load the gem
73
+ require 'swagger_client'
74
+
75
+ api_instance = SwaggerClient::SecurityGroupControllerApi.new
76
+
77
+ opts = {
78
+ id: 'id_example', # String | id
79
+ x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
80
+ }
81
+
82
+ begin
83
+ #Retrieve a list of security groups, grouped by account, cloud provider, and region
84
+ result = api_instance.all_using_get5(opts)
85
+ p result
86
+ rescue SwaggerClient::ApiError => e
87
+ puts "Exception when calling SecurityGroupControllerApi->all_using_get5: #{e}"
88
+ end
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ Name | Type | Description | Notes
94
+ ------------- | ------------- | ------------- | -------------
95
+ **id** | **String**| id | [optional]
96
+ **x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
97
+
98
+ ### Return type
99
+
100
+ **Object**
101
+
102
+ ### Authorization
103
+
104
+ No authorization required
105
+
106
+ ### HTTP request headers
107
+
108
+ - **Content-Type**: application/json
109
+ - **Accept**: */*
110
+
111
+
112
+
113
+ # **get_security_group_using_get1**
114
+ > Object get_security_group_using_get1(account, region, name, opts)
115
+
116
+ Retrieve a security group's details
117
+
118
+ ### Example
119
+ ```ruby
120
+ # load the gem
121
+ require 'swagger_client'
122
+
123
+ api_instance = SwaggerClient::SecurityGroupControllerApi.new
124
+
125
+ account = 'account_example' # String | account
126
+
127
+ region = 'region_example' # String | region
128
+
129
+ name = 'name_example' # String | name
130
+
131
+ opts = {
132
+ provider: 'aws', # String | provider
133
+ vpc_id: 'vpc_id_example', # String | vpcId
134
+ x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
135
+ }
136
+
137
+ begin
138
+ #Retrieve a security group's details
139
+ result = api_instance.get_security_group_using_get1(account, region, name, opts)
140
+ p result
141
+ rescue SwaggerClient::ApiError => e
142
+ puts "Exception when calling SecurityGroupControllerApi->get_security_group_using_get1: #{e}"
143
+ end
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ Name | Type | Description | Notes
149
+ ------------- | ------------- | ------------- | -------------
150
+ **account** | **String**| account |
151
+ **region** | **String**| region |
152
+ **name** | **String**| name |
153
+ **provider** | **String**| provider | [optional] [default to aws]
154
+ **vpc_id** | **String**| vpcId | [optional]
155
+ **x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
156
+
157
+ ### Return type
158
+
159
+ **Object**
160
+
161
+ ### Authorization
162
+
163
+ No authorization required
164
+
165
+ ### HTTP request headers
166
+
167
+ - **Content-Type**: application/json
168
+ - **Accept**: */*
169
+
170
+
171
+
@@ -0,0 +1,125 @@
1
+ # SwaggerClient::ServerGroupControllerApi
2
+
3
+ All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_server_group_details_using_get**](ServerGroupControllerApi.md#get_server_group_details_using_get) | **GET** /applications/{applicationName}/serverGroups/{account}/{region}/{serverGroupName} | Retrieve a server group's details
8
+ [**get_server_groups_for_application_using_get**](ServerGroupControllerApi.md#get_server_groups_for_application_using_get) | **GET** /applications/{applicationName}/serverGroups | Retrieve a list of server groups for a given application
9
+
10
+
11
+ # **get_server_group_details_using_get**
12
+ > Object get_server_group_details_using_get(application_name, account, region, server_group_name, opts)
13
+
14
+ Retrieve a server group's details
15
+
16
+ ### Example
17
+ ```ruby
18
+ # load the gem
19
+ require 'swagger_client'
20
+
21
+ api_instance = SwaggerClient::ServerGroupControllerApi.new
22
+
23
+ application_name = 'application_name_example' # String | applicationName
24
+
25
+ account = 'account_example' # String | account
26
+
27
+ region = 'region_example' # String | region
28
+
29
+ server_group_name = 'server_group_name_example' # String | serverGroupName
30
+
31
+ opts = {
32
+ x_rate_limit_app: 'x_rate_limit_app_example', # String | X-RateLimit-App
33
+ include_details: 'true' # String | includeDetails
34
+ }
35
+
36
+ begin
37
+ #Retrieve a server group's details
38
+ result = api_instance.get_server_group_details_using_get(application_name, account, region, server_group_name, opts)
39
+ p result
40
+ rescue SwaggerClient::ApiError => e
41
+ puts "Exception when calling ServerGroupControllerApi->get_server_group_details_using_get: #{e}"
42
+ end
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+ Name | Type | Description | Notes
48
+ ------------- | ------------- | ------------- | -------------
49
+ **application_name** | **String**| applicationName |
50
+ **account** | **String**| account |
51
+ **region** | **String**| region |
52
+ **server_group_name** | **String**| serverGroupName |
53
+ **x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
54
+ **include_details** | **String**| includeDetails | [optional] [default to true]
55
+
56
+ ### Return type
57
+
58
+ **Object**
59
+
60
+ ### Authorization
61
+
62
+ No authorization required
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json
67
+ - **Accept**: */*
68
+
69
+
70
+
71
+ # **get_server_groups_for_application_using_get**
72
+ > Array<Object> get_server_groups_for_application_using_get(application_name, opts)
73
+
74
+ Retrieve a list of server groups for a given application
75
+
76
+ ### Example
77
+ ```ruby
78
+ # load the gem
79
+ require 'swagger_client'
80
+
81
+ api_instance = SwaggerClient::ServerGroupControllerApi.new
82
+
83
+ application_name = 'application_name_example' # String | applicationName
84
+
85
+ opts = {
86
+ expand: 'false', # String | expand
87
+ cloud_provider: 'cloud_provider_example', # String | cloudProvider
88
+ clusters: 'clusters_example', # String | clusters
89
+ x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
90
+ }
91
+
92
+ begin
93
+ #Retrieve a list of server groups for a given application
94
+ result = api_instance.get_server_groups_for_application_using_get(application_name, opts)
95
+ p result
96
+ rescue SwaggerClient::ApiError => e
97
+ puts "Exception when calling ServerGroupControllerApi->get_server_groups_for_application_using_get: #{e}"
98
+ end
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ Name | Type | Description | Notes
104
+ ------------- | ------------- | ------------- | -------------
105
+ **application_name** | **String**| applicationName |
106
+ **expand** | **String**| expand | [optional] [default to false]
107
+ **cloud_provider** | **String**| cloudProvider | [optional]
108
+ **clusters** | **String**| clusters | [optional]
109
+ **x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
110
+
111
+ ### Return type
112
+
113
+ **Array<Object>**
114
+
115
+ ### Authorization
116
+
117
+ No authorization required
118
+
119
+ ### HTTP request headers
120
+
121
+ - **Content-Type**: application/json
122
+ - **Accept**: */*
123
+
124
+
125
+