Class: IronWorker::GroupsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_ruby/api/groups_api.rb,
lib/worker_ruby/api/groups_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupsApi

Returns a new instance of GroupsApi.



30
31
32
 
# File 'lib/iron_ruby/api/groups_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/iron_ruby/api/groups_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#groups_get(opts = {}) ⇒ GroupsWrapper

Get all group names. Get a list of all the groups in the system.

Parameters:

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

    the optional parameters

Returns:



38
39
40
41
 
# File 'lib/iron_ruby/api/groups_api.rb', line 38

def groups_get(opts = {})
  data, _status_code, _headers = groups_get_with_http_info(opts)
  return data
end

#groups_get_with_http_info(opts = {}) ⇒ Array<(GroupsWrapper, Fixnum, Hash)>

Get all group names. Get a list of all the groups in the system.

Parameters:

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

    the optional parameters

Returns:

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

    GroupsWrapper data, response status code and response headers



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
85
 
# File 'lib/iron_ruby/api/groups_api.rb', line 47

def groups_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_get ..."
  end
  # resource path
  local_var_path = "/groups".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'GroupsWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#groups_name_get(name, opts = {}) ⇒ GroupWrapper

Get information for a group. This gives more details about a task group, such as statistics.

Parameters:

  • name —

    name of the group.

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/iron_ruby/api/groups_api.rb', line 92

def groups_name_get(name, opts = {})
  data, _status_code, _headers = groups_name_get_with_http_info(name, opts)
  return data
end

#groups_name_get_with_http_info(name, opts = {}) ⇒ Array<(GroupWrapper, Fixnum, Hash)>

Get information for a group. This gives more details about a task group, such as statistics.

Parameters:

  • name —

    name of the group.

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

    the optional parameters

Returns:

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

    GroupWrapper data, response status code and response headers



102
103
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
 
# File 'lib/iron_ruby/api/groups_api.rb', line 102

def groups_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_name_get ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling GroupsApi.groups_name_get" if name.nil?
  # resource path
  local_var_path = "/groups/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'GroupWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#groups_name_put(name, body, opts = {}) ⇒ GroupWrapper

Create/update a task group. You can set group level settings here.

Parameters:

  • name —

    name of the group.

  • body —

    Group to post.

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/iron_ruby/api/groups_api.rb', line 150

def groups_name_put(name, body, opts = {})
  data, _status_code, _headers = groups_name_put_with_http_info(name, body, opts)
  return data
end

#groups_name_put_with_http_info(name, body, opts = {}) ⇒ Array<(GroupWrapper, Fixnum, Hash)>

Create/update a task group. You can set group level settings here.

Parameters:

  • name —

    name of the group.

  • body —

    Group to post.

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

    the optional parameters

Returns:

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

    GroupWrapper data, response status code and response headers



161
162
163
164
165
166
167
168
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
 
# File 'lib/iron_ruby/api/groups_api.rb', line 161

def groups_name_put_with_http_info(name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_name_put ..."
  end
  # verify the required parameter 'name' is set
  fail ArgumentError, "Missing the required parameter 'name' when calling GroupsApi.groups_name_put" if name.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling GroupsApi.groups_name_put" if body.nil?
  # resource path
  local_var_path = "/groups/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_name_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#groups_post(body, opts = {}) ⇒ GroupWrapper

Post new group Insert a new task group

Parameters:

  • body —

    Group to post.

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/iron_ruby/api/groups_api.rb', line 210

def groups_post(body, opts = {})
  data, _status_code, _headers = groups_post_with_http_info(body, opts)
  return data
end

#groups_post_with_http_info(body, opts = {}) ⇒ Array<(GroupWrapper, Fixnum, Hash)>

Post new group Insert a new task group

Parameters:

  • body —

    Group to post.

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

    the optional parameters

Returns:

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

    GroupWrapper data, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/iron_ruby/api/groups_api.rb', line 220

def groups_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: GroupsApi.groups_post ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling GroupsApi.groups_post" if body.nil?
  # resource path
  local_var_path = "/groups".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GroupWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#groups_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end