Class: SwaggerClient::ImageControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/api/image_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ImageControllerApi

Returns a new instance of ImageControllerApi.



19
20
21
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#find_images_using_get(opts = {}) ⇒ Array<Object>

Retrieve a list of images, filtered by cloud provider, region, and account The query parameter ‘q` filters the list of images by image name

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :provider (String) —

    provider (default to aws)

  • :q (String) —

    q

  • :region (String) —

    region

  • :account (String) —

    account

  • :count (Integer) —

    count

Returns:

  • (Array<Object>) 


31
32
33
34
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 31

def find_images_using_get(opts = {})
  data, _status_code, _headers = find_images_using_get_with_http_info(opts)
  data
end

#find_images_using_get_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Retrieve a list of images, filtered by cloud provider, region, and account The query parameter &#x60;q&#x60; filters the list of images by image name

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :provider (String) —

    provider

  • :q (String) —

    q

  • :region (String) —

    region

  • :account (String) —

    account

  • :count (Integer) —

    count

Returns:

  • (Array<(Array<Object>, Fixnum, Hash)>) —

    Array<Object> data, response status code and response headers



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
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 45

def find_images_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImageControllerApi.find_images_using_get ...'
  end
  # resource path
  local_var_path = '/images/find'

  # query parameters
  query_params = {}
  query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'region'] = opts[:'region'] if !opts[:'region'].nil?
  query_params[:'account'] = opts[:'account'] if !opts[:'account'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImageControllerApi#find_images_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#find_tags_using_get(account, repository, opts = {}) ⇒ Array<Object>

Find tags

Parameters:

  • account —

    account

  • repository —

    repository

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :provider (String) —

    provider (default to aws)

  • :x_rate_limit_app (String) —

    X-RateLimit-App

Returns:

  • (Array<Object>) 


92
93
94
95
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 92

def find_tags_using_get(, repository, opts = {})
  data, _status_code, _headers = find_tags_using_get_with_http_info(, repository, opts)
  data
end

#find_tags_using_get_with_http_info(account, repository, opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Find tags

Parameters:

  • account —

    account

  • repository —

    repository

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :provider (String) —

    provider

  • :x_rate_limit_app (String) —

    X-RateLimit-App

Returns:

  • (Array<(Array<Object>, Fixnum, Hash)>) —

    Array<Object> data, response status code and response headers



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
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 104

def find_tags_using_get_with_http_info(, repository, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImageControllerApi.find_tags_using_get ...'
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling ImageControllerApi.find_tags_using_get"
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling ImageControllerApi.find_tags_using_get"
  end
  # resource path
  local_var_path = '/images/tags'

  # query parameters
  query_params = {}
  query_params[:'account'] = 
  query_params[:'repository'] = repository
  query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-RateLimit-App'] = opts[:'x_rate_limit_app'] if !opts[:'x_rate_limit_app'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImageControllerApi#find_tags_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image_details_using_get(account, region, image_id, opts = {}) ⇒ Array<Object>

Get image details

Parameters:

  • account —

    account

  • region —

    region

  • image_id —

    imageId

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :provider (String) —

    provider (default to aws)

  • :x_rate_limit_app (String) —

    X-RateLimit-App

Returns:

  • (Array<Object>) 


159
160
161
162
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 159

def get_image_details_using_get(, region, image_id, opts = {})
  data, _status_code, _headers = get_image_details_using_get_with_http_info(, region, image_id, opts)
  data
end

#get_image_details_using_get_with_http_info(account, region, image_id, opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Get image details

Parameters:

  • account —

    account

  • region —

    region

  • image_id —

    imageId

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :provider (String) —

    provider

  • :x_rate_limit_app (String) —

    X-RateLimit-App

Returns:

  • (Array<(Array<Object>, Fixnum, Hash)>) —

    Array<Object> data, response status code and response headers



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
 
# File 'lib/swagger_client/api/image_controller_api.rb', line 172

def get_image_details_using_get_with_http_info(, region, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImageControllerApi.get_image_details_using_get ...'
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling ImageControllerApi.get_image_details_using_get"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ImageControllerApi.get_image_details_using_get"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling ImageControllerApi.get_image_details_using_get"
  end
  # resource path
  local_var_path = '/images/{account}/{region}/{imageId}'.sub('{' + 'account' + '}', .to_s).sub('{' + 'region' + '}', region.to_s).sub('{' + 'imageId' + '}', image_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-RateLimit-App'] = opts[:'x_rate_limit_app'] if !opts[:'x_rate_limit_app'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImageControllerApi#get_image_details_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end