spinnaker-gate-ruby-client 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +85 -0
- data/LICENSE +201 -0
- data/README.md +240 -0
- data/Rakefile +8 -0
- data/docs/Account.md +14 -0
- data/docs/AccountDetails.md +19 -0
- data/docs/AmazonInfrastructureControllerApi.md +128 -0
- data/docs/ApplicationControllerApi.md +754 -0
- data/docs/ArtifactControllerApi.md +111 -0
- data/docs/AuthControllerApi.md +212 -0
- data/docs/BakeControllerApi.md +143 -0
- data/docs/BuildControllerApi.md +493 -0
- data/docs/ClusterControllerApi.md +475 -0
- data/docs/ConcourseControllerApi.md +161 -0
- data/docs/CredentialsControllerApi.md +129 -0
- data/docs/EcsServerGroupEventsControllerApi.md +66 -0
- data/docs/ExecutionsControllerApi.md +133 -0
- data/docs/FirewallControllerApi.md +171 -0
- data/docs/GrantedAuthority.md +8 -0
- data/docs/HashMapstringobject.md +7 -0
- data/docs/HttpEntity.md +8 -0
- data/docs/ImageControllerApi.md +178 -0
- data/docs/InstanceControllerApi.md +122 -0
- data/docs/JobControllerApi.md +69 -0
- data/docs/LoadBalancerControllerApi.md +217 -0
- data/docs/Mapstringstring.md +7 -0
- data/docs/NetworkControllerApi.md +105 -0
- data/docs/PipelineConfigControllerApi.md +144 -0
- data/docs/PipelineControllerApi.md +1074 -0
- data/docs/PipelineTemplateDependent.md +10 -0
- data/docs/PipelineTemplatesControllerApi.md +350 -0
- data/docs/ProjectControllerApi.md +196 -0
- data/docs/PubsubSubscriptionControllerApi.md +48 -0
- data/docs/ReorderPipelinesCommand.md +9 -0
- data/docs/ReorderPipelinesControllerApi.md +54 -0
- data/docs/ResponseEntity.md +10 -0
- data/docs/SearchControllerApi.md +68 -0
- data/docs/SecurityGroupControllerApi.md +171 -0
- data/docs/ServerGroupControllerApi.md +125 -0
- data/docs/ServerGroupManagerControllerApi.md +54 -0
- data/docs/SnapshotControllerApi.md +110 -0
- data/docs/SubnetControllerApi.md +58 -0
- data/docs/TaskControllerApi.md +291 -0
- data/docs/User.md +18 -0
- data/docs/V2CanaryConfigControllerApi.md +259 -0
- data/docs/V2CanaryControllerApi.md +356 -0
- data/docs/V2PipelineTemplatesControllerApi.md +356 -0
- data/docs/Version.md +8 -0
- data/docs/VersionControllerApi.md +48 -0
- data/docs/WebhookControllerApi.md +105 -0
- data/git_push.sh +55 -0
- data/lib/swagger_client.rb +85 -0
- data/lib/swagger_client/api/amazon_infrastructure_controller_api.rb +161 -0
- data/lib/swagger_client/api/application_controller_api.rb +868 -0
- data/lib/swagger_client/api/artifact_controller_api.rb +141 -0
- data/lib/swagger_client/api/auth_controller_api.rb +258 -0
- data/lib/swagger_client/api/bake_controller_api.rb +179 -0
- data/lib/swagger_client/api/build_controller_api.rb +588 -0
- data/lib/swagger_client/api/cluster_controller_api.rb +591 -0
- data/lib/swagger_client/api/concourse_controller_api.rb +209 -0
- data/lib/swagger_client/api/credentials_controller_api.rb +163 -0
- data/lib/swagger_client/api/ecs_server_group_events_controller_api.rb +101 -0
- data/lib/swagger_client/api/executions_controller_api.rb +169 -0
- data/lib/swagger_client/api/firewall_controller_api.rb +209 -0
- data/lib/swagger_client/api/image_controller_api.rb +222 -0
- data/lib/swagger_client/api/instance_controller_api.rb +160 -0
- data/lib/swagger_client/api/job_controller_api.rb +99 -0
- data/lib/swagger_client/api/load_balancer_controller_api.rb +258 -0
- data/lib/swagger_client/api/network_controller_api.rb +127 -0
- data/lib/swagger_client/api/pipeline_config_controller_api.rb +176 -0
- data/lib/swagger_client/api/pipeline_controller_api.rb +1268 -0
- data/lib/swagger_client/api/pipeline_templates_controller_api.rb +404 -0
- data/lib/swagger_client/api/project_controller_api.rb +234 -0
- data/lib/swagger_client/api/pubsub_subscription_controller_api.rb +69 -0
- data/lib/swagger_client/api/reorder_pipelines_controller_api.rb +75 -0
- data/lib/swagger_client/api/search_controller_api.rb +94 -0
- data/lib/swagger_client/api/security_group_controller_api.rb +209 -0
- data/lib/swagger_client/api/server_group_controller_api.rb +163 -0
- data/lib/swagger_client/api/server_group_manager_controller_api.rb +75 -0
- data/lib/swagger_client/api/snapshot_controller_api.rb +142 -0
- data/lib/swagger_client/api/subnet_controller_api.rb +78 -0
- data/lib/swagger_client/api/task_controller_api.rb +345 -0
- data/lib/swagger_client/api/v2_canary_config_controller_api.rb +300 -0
- data/lib/swagger_client/api/v2_canary_controller_api.rb +421 -0
- data/lib/swagger_client/api/v2_pipeline_templates_controller_api.rb +412 -0
- data/lib/swagger_client/api/version_controller_api.rb +69 -0
- data/lib/swagger_client/api/webhook_controller_api.rb +135 -0
- data/lib/swagger_client/api_client.rb +388 -0
- data/lib/swagger_client/api_error.rb +38 -0
- data/lib/swagger_client/configuration.rb +202 -0
- data/lib/swagger_client/models/account.rb +241 -0
- data/lib/swagger_client/models/account_details.rb +286 -0
- data/lib/swagger_client/models/granted_authority.rb +183 -0
- data/lib/swagger_client/models/hash_mapstringobject.rb +174 -0
- data/lib/swagger_client/models/http_entity.rb +183 -0
- data/lib/swagger_client/models/mapstringstring.rb +174 -0
- data/lib/swagger_client/models/pipeline_template_dependent.rb +201 -0
- data/lib/swagger_client/models/reorder_pipelines_command.rb +194 -0
- data/lib/swagger_client/models/response_entity.rb +235 -0
- data/lib/swagger_client/models/user.rb +279 -0
- data/lib/swagger_client/models/version.rb +183 -0
- data/lib/swagger_client/version.rb +15 -0
- data/spec/api/amazon_infrastructure_controller_api_spec.rb +65 -0
- data/spec/api/application_controller_api_spec.rb +218 -0
- data/spec/api/artifact_controller_api_spec.rb +60 -0
- data/spec/api/auth_controller_api_spec.rb +86 -0
- data/spec/api/bake_controller_api_spec.rb +68 -0
- data/spec/api/build_controller_api_spec.rb +155 -0
- data/spec/api/cluster_controller_api_spec.rb +155 -0
- data/spec/api/concourse_controller_api_spec.rb +73 -0
- data/spec/api/credentials_controller_api_spec.rb +70 -0
- data/spec/api/ecs_server_group_events_controller_api_spec.rb +50 -0
- data/spec/api/executions_controller_api_spec.rb +72 -0
- data/spec/api/firewall_controller_api_spec.rb +77 -0
- data/spec/api/image_controller_api_spec.rb +80 -0
- data/spec/api/instance_controller_api_spec.rb +64 -0
- data/spec/api/job_controller_api_spec.rb +51 -0
- data/spec/api/load_balancer_controller_api_spec.rb +87 -0
- data/spec/api/network_controller_api_spec.rb +58 -0
- data/spec/api/pipeline_config_controller_api_spec.rb +68 -0
- data/spec/api/pipeline_controller_api_spec.rb +296 -0
- data/spec/api/pipeline_templates_controller_api_spec.rb +118 -0
- data/spec/api/project_controller_api_spec.rb +81 -0
- data/spec/api/pubsub_subscription_controller_api_spec.rb +45 -0
- data/spec/api/reorder_pipelines_controller_api_spec.rb +46 -0
- data/spec/api/search_controller_api_spec.rb +52 -0
- data/spec/api/security_group_controller_api_spec.rb +77 -0
- data/spec/api/server_group_controller_api_spec.rb +66 -0
- data/spec/api/server_group_manager_controller_api_spec.rb +46 -0
- data/spec/api/snapshot_controller_api_spec.rb +60 -0
- data/spec/api/subnet_controller_api_spec.rb +47 -0
- data/spec/api/task_controller_api_spec.rb +103 -0
- data/spec/api/v2_canary_config_controller_api_spec.rb +96 -0
- data/spec/api/v2_canary_controller_api_spec.rb +123 -0
- data/spec/api/v2_pipeline_templates_controller_api_spec.rb +121 -0
- data/spec/api/version_controller_api_spec.rb +45 -0
- data/spec/api/webhook_controller_api_spec.rb +60 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_details_spec.rb +107 -0
- data/spec/models/account_spec.rb +77 -0
- data/spec/models/granted_authority_spec.rb +41 -0
- data/spec/models/hash_mapstringobject_spec.rb +35 -0
- data/spec/models/http_entity_spec.rb +41 -0
- data/spec/models/mapstringstring_spec.rb +35 -0
- data/spec/models/pipeline_template_dependent_spec.rb +53 -0
- data/spec/models/reorder_pipelines_command_spec.rb +47 -0
- data/spec/models/response_entity_spec.rb +57 -0
- data/spec/models/user_spec.rb +101 -0
- data/spec/models/version_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- data/spinnaker_gate_ruby_client-1.0.0.gem +0 -0
- data/spinnaker_gate_ruby_client.gemspec +45 -0
- metadata +427 -0
@@ -0,0 +1,171 @@
|
|
1
|
+
# SwaggerClient::FirewallControllerApi
|
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_get**](FirewallControllerApi.md#all_by_account_using_get) | **GET** /firewalls/{account} | Retrieve a list of firewalls for a given account, grouped by region
|
8
|
+
[**all_using_get1**](FirewallControllerApi.md#all_using_get1) | **GET** /firewalls | Retrieve a list of firewalls, grouped by account, cloud provider, and region
|
9
|
+
[**get_security_group_using_get**](FirewallControllerApi.md#get_security_group_using_get) | **GET** /firewalls/{account}/{region}/{name} | Retrieve a firewall's details
|
10
|
+
|
11
|
+
|
12
|
+
# **all_by_account_using_get**
|
13
|
+
> Object all_by_account_using_get(account, opts)
|
14
|
+
|
15
|
+
Retrieve a list of firewalls 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::FirewallControllerApi.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 firewalls for a given account, grouped by region
|
34
|
+
result = api_instance.all_by_account_using_get(account, opts)
|
35
|
+
p result
|
36
|
+
rescue SwaggerClient::ApiError => e
|
37
|
+
puts "Exception when calling FirewallControllerApi->all_by_account_using_get: #{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_get1**
|
66
|
+
> Object all_using_get1(opts)
|
67
|
+
|
68
|
+
Retrieve a list of firewalls, 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::FirewallControllerApi.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 firewalls, grouped by account, cloud provider, and region
|
84
|
+
result = api_instance.all_using_get1(opts)
|
85
|
+
p result
|
86
|
+
rescue SwaggerClient::ApiError => e
|
87
|
+
puts "Exception when calling FirewallControllerApi->all_using_get1: #{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_get**
|
114
|
+
> Object get_security_group_using_get(account, region, name, opts)
|
115
|
+
|
116
|
+
Retrieve a firewall's details
|
117
|
+
|
118
|
+
### Example
|
119
|
+
```ruby
|
120
|
+
# load the gem
|
121
|
+
require 'swagger_client'
|
122
|
+
|
123
|
+
api_instance = SwaggerClient::FirewallControllerApi.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 firewall's details
|
139
|
+
result = api_instance.get_security_group_using_get(account, region, name, opts)
|
140
|
+
p result
|
141
|
+
rescue SwaggerClient::ApiError => e
|
142
|
+
puts "Exception when calling FirewallControllerApi->get_security_group_using_get: #{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
|
+
|
data/docs/HttpEntity.md
ADDED
@@ -0,0 +1,178 @@
|
|
1
|
+
# SwaggerClient::ImageControllerApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**find_images_using_get**](ImageControllerApi.md#find_images_using_get) | **GET** /images/find | Retrieve a list of images, filtered by cloud provider, region, and account
|
8
|
+
[**find_tags_using_get**](ImageControllerApi.md#find_tags_using_get) | **GET** /images/tags | Find tags
|
9
|
+
[**get_image_details_using_get**](ImageControllerApi.md#get_image_details_using_get) | **GET** /images/{account}/{region}/{imageId} | Get image details
|
10
|
+
|
11
|
+
|
12
|
+
# **find_images_using_get**
|
13
|
+
> Array<Object> find_images_using_get(opts)
|
14
|
+
|
15
|
+
Retrieve a list of images, filtered by cloud provider, region, and account
|
16
|
+
|
17
|
+
The query parameter `q` filters the list of images by image name
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'swagger_client'
|
23
|
+
|
24
|
+
api_instance = SwaggerClient::ImageControllerApi.new
|
25
|
+
|
26
|
+
opts = {
|
27
|
+
provider: 'aws', # String | provider
|
28
|
+
q: 'q_example', # String | q
|
29
|
+
region: 'region_example', # String | region
|
30
|
+
account: 'account_example', # String | account
|
31
|
+
count: 56 # Integer | count
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Retrieve a list of images, filtered by cloud provider, region, and account
|
36
|
+
result = api_instance.find_images_using_get(opts)
|
37
|
+
p result
|
38
|
+
rescue SwaggerClient::ApiError => e
|
39
|
+
puts "Exception when calling ImageControllerApi->find_images_using_get: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**provider** | **String**| provider | [optional] [default to aws]
|
48
|
+
**q** | **String**| q | [optional]
|
49
|
+
**region** | **String**| region | [optional]
|
50
|
+
**account** | **String**| account | [optional]
|
51
|
+
**count** | **Integer**| count | [optional]
|
52
|
+
|
53
|
+
### Return type
|
54
|
+
|
55
|
+
**Array<Object>**
|
56
|
+
|
57
|
+
### Authorization
|
58
|
+
|
59
|
+
No authorization required
|
60
|
+
|
61
|
+
### HTTP request headers
|
62
|
+
|
63
|
+
- **Content-Type**: application/json
|
64
|
+
- **Accept**: */*
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
# **find_tags_using_get**
|
69
|
+
> Array<Object> find_tags_using_get(account, repository, opts)
|
70
|
+
|
71
|
+
Find tags
|
72
|
+
|
73
|
+
### Example
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'swagger_client'
|
77
|
+
|
78
|
+
api_instance = SwaggerClient::ImageControllerApi.new
|
79
|
+
|
80
|
+
account = 'account_example' # String | account
|
81
|
+
|
82
|
+
repository = 'repository_example' # String | repository
|
83
|
+
|
84
|
+
opts = {
|
85
|
+
provider: 'aws', # String | provider
|
86
|
+
x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
|
87
|
+
}
|
88
|
+
|
89
|
+
begin
|
90
|
+
#Find tags
|
91
|
+
result = api_instance.find_tags_using_get(account, repository, opts)
|
92
|
+
p result
|
93
|
+
rescue SwaggerClient::ApiError => e
|
94
|
+
puts "Exception when calling ImageControllerApi->find_tags_using_get: #{e}"
|
95
|
+
end
|
96
|
+
```
|
97
|
+
|
98
|
+
### Parameters
|
99
|
+
|
100
|
+
Name | Type | Description | Notes
|
101
|
+
------------- | ------------- | ------------- | -------------
|
102
|
+
**account** | **String**| account |
|
103
|
+
**repository** | **String**| repository |
|
104
|
+
**provider** | **String**| provider | [optional] [default to aws]
|
105
|
+
**x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
**Array<Object>**
|
110
|
+
|
111
|
+
### Authorization
|
112
|
+
|
113
|
+
No authorization required
|
114
|
+
|
115
|
+
### HTTP request headers
|
116
|
+
|
117
|
+
- **Content-Type**: application/json
|
118
|
+
- **Accept**: */*
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
# **get_image_details_using_get**
|
123
|
+
> Array<Object> get_image_details_using_get(account, region, image_id, opts)
|
124
|
+
|
125
|
+
Get image details
|
126
|
+
|
127
|
+
### Example
|
128
|
+
```ruby
|
129
|
+
# load the gem
|
130
|
+
require 'swagger_client'
|
131
|
+
|
132
|
+
api_instance = SwaggerClient::ImageControllerApi.new
|
133
|
+
|
134
|
+
account = 'account_example' # String | account
|
135
|
+
|
136
|
+
region = 'region_example' # String | region
|
137
|
+
|
138
|
+
image_id = 'image_id_example' # String | imageId
|
139
|
+
|
140
|
+
opts = {
|
141
|
+
provider: 'aws', # String | provider
|
142
|
+
x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
|
143
|
+
}
|
144
|
+
|
145
|
+
begin
|
146
|
+
#Get image details
|
147
|
+
result = api_instance.get_image_details_using_get(account, region, image_id, opts)
|
148
|
+
p result
|
149
|
+
rescue SwaggerClient::ApiError => e
|
150
|
+
puts "Exception when calling ImageControllerApi->get_image_details_using_get: #{e}"
|
151
|
+
end
|
152
|
+
```
|
153
|
+
|
154
|
+
### Parameters
|
155
|
+
|
156
|
+
Name | Type | Description | Notes
|
157
|
+
------------- | ------------- | ------------- | -------------
|
158
|
+
**account** | **String**| account |
|
159
|
+
**region** | **String**| region |
|
160
|
+
**image_id** | **String**| imageId |
|
161
|
+
**provider** | **String**| provider | [optional] [default to aws]
|
162
|
+
**x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
|
163
|
+
|
164
|
+
### Return type
|
165
|
+
|
166
|
+
**Array<Object>**
|
167
|
+
|
168
|
+
### Authorization
|
169
|
+
|
170
|
+
No authorization required
|
171
|
+
|
172
|
+
### HTTP request headers
|
173
|
+
|
174
|
+
- **Content-Type**: application/json
|
175
|
+
- **Accept**: */*
|
176
|
+
|
177
|
+
|
178
|
+
|
@@ -0,0 +1,122 @@
|
|
1
|
+
# SwaggerClient::InstanceControllerApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://gate-spinnaker.devint.gcp.openx.org*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_console_output_using_get**](InstanceControllerApi.md#get_console_output_using_get) | **GET** /instances/{account}/{region}/{instanceId}/console | Retrieve an instance's console output
|
8
|
+
[**get_instance_details_using_get**](InstanceControllerApi.md#get_instance_details_using_get) | **GET** /instances/{account}/{region}/{instanceId} | Retrieve an instance's details
|
9
|
+
|
10
|
+
|
11
|
+
# **get_console_output_using_get**
|
12
|
+
> Object get_console_output_using_get(account, region, instance_id, opts)
|
13
|
+
|
14
|
+
Retrieve an instance's console output
|
15
|
+
|
16
|
+
### Example
|
17
|
+
```ruby
|
18
|
+
# load the gem
|
19
|
+
require 'swagger_client'
|
20
|
+
|
21
|
+
api_instance = SwaggerClient::InstanceControllerApi.new
|
22
|
+
|
23
|
+
account = 'account_example' # String | account
|
24
|
+
|
25
|
+
region = 'region_example' # String | region
|
26
|
+
|
27
|
+
instance_id = 'instance_id_example' # String | instanceId
|
28
|
+
|
29
|
+
opts = {
|
30
|
+
provider: 'aws', # String | provider
|
31
|
+
x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Retrieve an instance's console output
|
36
|
+
result = api_instance.get_console_output_using_get(account, region, instance_id, opts)
|
37
|
+
p result
|
38
|
+
rescue SwaggerClient::ApiError => e
|
39
|
+
puts "Exception when calling InstanceControllerApi->get_console_output_using_get: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**account** | **String**| account |
|
48
|
+
**region** | **String**| region |
|
49
|
+
**instance_id** | **String**| instanceId |
|
50
|
+
**provider** | **String**| provider | [optional] [default to aws]
|
51
|
+
**x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
|
52
|
+
|
53
|
+
### Return type
|
54
|
+
|
55
|
+
**Object**
|
56
|
+
|
57
|
+
### Authorization
|
58
|
+
|
59
|
+
No authorization required
|
60
|
+
|
61
|
+
### HTTP request headers
|
62
|
+
|
63
|
+
- **Content-Type**: application/json
|
64
|
+
- **Accept**: */*
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
# **get_instance_details_using_get**
|
69
|
+
> Object get_instance_details_using_get(account, region, instance_id, opts)
|
70
|
+
|
71
|
+
Retrieve an instance's details
|
72
|
+
|
73
|
+
### Example
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'swagger_client'
|
77
|
+
|
78
|
+
api_instance = SwaggerClient::InstanceControllerApi.new
|
79
|
+
|
80
|
+
account = 'account_example' # String | account
|
81
|
+
|
82
|
+
region = 'region_example' # String | region
|
83
|
+
|
84
|
+
instance_id = 'instance_id_example' # String | instanceId
|
85
|
+
|
86
|
+
opts = {
|
87
|
+
x_rate_limit_app: 'x_rate_limit_app_example' # String | X-RateLimit-App
|
88
|
+
}
|
89
|
+
|
90
|
+
begin
|
91
|
+
#Retrieve an instance's details
|
92
|
+
result = api_instance.get_instance_details_using_get(account, region, instance_id, opts)
|
93
|
+
p result
|
94
|
+
rescue SwaggerClient::ApiError => e
|
95
|
+
puts "Exception when calling InstanceControllerApi->get_instance_details_using_get: #{e}"
|
96
|
+
end
|
97
|
+
```
|
98
|
+
|
99
|
+
### Parameters
|
100
|
+
|
101
|
+
Name | Type | Description | Notes
|
102
|
+
------------- | ------------- | ------------- | -------------
|
103
|
+
**account** | **String**| account |
|
104
|
+
**region** | **String**| region |
|
105
|
+
**instance_id** | **String**| instanceId |
|
106
|
+
**x_rate_limit_app** | **String**| X-RateLimit-App | [optional]
|
107
|
+
|
108
|
+
### Return type
|
109
|
+
|
110
|
+
**Object**
|
111
|
+
|
112
|
+
### Authorization
|
113
|
+
|
114
|
+
No authorization required
|
115
|
+
|
116
|
+
### HTTP request headers
|
117
|
+
|
118
|
+
- **Content-Type**: application/json
|
119
|
+
- **Accept**: */*
|
120
|
+
|
121
|
+
|
122
|
+
|