Class: Apcera::UtilitiesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/apcera/api/utilities_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = nil) ⇒ UtilitiesApi

Returns a new instance of UtilitiesApi.



7
8
9
 
# File 'lib/apcera/api/utilities_api.rb', line 7

def initialize(api_client = nil)
  @api_client = api_client || Configuration.api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/apcera/api/utilities_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#info_get(opts = {}) ⇒ Info

Returns information about the API server. Returns information about the API server.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/apcera/api/utilities_api.rb', line 16

def info_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: UtilitiesApi#info_get ..."
  end
  
  
  # resource path
  path = "/info".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Info')
  if Configuration.debugging
    Configuration.logger.debug "API called: UtilitiesApi#info_get. Result: #{result.inspect}"
  end
  return result
end

#namespace_default_get(opts = {}) ⇒ Namespace

Returns the default namespace for the currently logged-in user. Returns the default namespace for the currently logged-in user.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/apcera/api/utilities_api.rb', line 67

def namespace_default_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: UtilitiesApi#namespace_default_get ..."
  end
  
  
  # resource path
  path = "/namespace/default".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Namespace')
  if Configuration.debugging
    Configuration.logger.debug "API called: UtilitiesApi#namespace_default_get. Result: #{result.inspect}"
  end
  return result
end

#runtimes_get(opts = {}) ⇒ Array<Runtime>

Lists supported workload runtimes. Lists file names and patterns used by APC to determine the appropriate staging pipeline to stage a given workload.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/apcera/api/utilities_api.rb', line 118

def runtimes_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: UtilitiesApi#runtimes_get ..."
  end
  
  
  # resource path
  path = "/runtimes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Runtime>')
  if Configuration.debugging
    Configuration.logger.debug "API called: UtilitiesApi#runtimes_get. Result: #{result.inspect}"
  end
  return result
end

#version_get(opts = {}) ⇒ VersionInfo

Returns Apcera cluster version information and APC download links. Returns Apcera cluster version information, and links to download compatible versions of APC for supported platforms.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/apcera/api/utilities_api.rb', line 169

def version_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: UtilitiesApi#version_get ..."
  end
  
  
  # resource path
  path = "/version".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VersionInfo')
  if Configuration.debugging
    Configuration.logger.debug "API called: UtilitiesApi#version_get. Result: #{result.inspect}"
  end
  return result
end