Class: OpenapiClient::ResourceActionsApi
- Inherits:
-
Object
- Object
- OpenapiClient::ResourceActionsApi
- Defined in:
- lib/openapi_client/api/resource_actions_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_resource_action(proj_id, env_id, resource_id, resource_action_create, opts = {}) ⇒ ResourceActionRead
Create Resource Action Creates a new action that can affect the resource.
-
#create_resource_action_with_http_info(proj_id, env_id, resource_id, resource_action_create, opts = {}) ⇒ Array<(ResourceActionRead, Integer, Hash)>
Create Resource Action Creates a new action that can affect the resource.
-
#delete_resource_action(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ nil
Delete Resource Action Deletes the action and all its related data.
-
#delete_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Resource Action Deletes the action and all its related data.
-
#get_resource_action(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ ResourceActionRead
Get Resource Action Gets a single action defined on the resource, if such action exists.
-
#get_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ Array<(ResourceActionRead, Integer, Hash)>
Get Resource Action Gets a single action defined on the resource, if such action exists.
-
#initialize(api_client = ApiClient.default) ⇒ ResourceActionsApi
constructor
A new instance of ResourceActionsApi.
-
#list_resource_actions(proj_id, env_id, resource_id, opts = {}) ⇒ Array<ResourceActionRead>
List Resource Actions Lists all the actions defined on the resource.
-
#list_resource_actions_with_http_info(proj_id, env_id, resource_id, opts = {}) ⇒ Array<(Array<ResourceActionRead>, Integer, Hash)>
List Resource Actions Lists all the actions defined on the resource.
-
#update_resource_action(proj_id, env_id, resource_id, action_id, resource_action_update, opts = {}) ⇒ ResourceActionRead
Update Resource Action Partially updates the action defined on a resource.
-
#update_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, resource_action_update, opts = {}) ⇒ Array<(ResourceActionRead, Integer, Hash)>
Update Resource Action Partially updates the action defined on a resource.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ResourceActionsApi
Returns a new instance of ResourceActionsApi.
19 20 21 |
# File 'lib/openapi_client/api/resource_actions_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/openapi_client/api/resource_actions_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_resource_action(proj_id, env_id, resource_id, resource_action_create, opts = {}) ⇒ ResourceActionRead
Create Resource Action Creates a new action that can affect the resource.
30 31 32 33 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 30 def create_resource_action(proj_id, env_id, resource_id, resource_action_create, opts = {}) data, _status_code, _headers = create_resource_action_with_http_info(proj_id, env_id, resource_id, resource_action_create, opts) data end |
#create_resource_action_with_http_info(proj_id, env_id, resource_id, resource_action_create, opts = {}) ⇒ Array<(ResourceActionRead, Integer, Hash)>
Create Resource Action Creates a new action that can affect the resource.
43 44 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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 43 def create_resource_action_with_http_info(proj_id, env_id, resource_id, resource_action_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceActionsApi.create_resource_action ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourceActionsApi.create_resource_action" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourceActionsApi.create_resource_action" end # verify the required parameter 'resource_id' is set if @api_client.config.client_side_validation && resource_id.nil? fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourceActionsApi.create_resource_action" end # verify the required parameter 'resource_action_create' is set if @api_client.config.client_side_validation && resource_action_create.nil? fail ArgumentError, "Missing the required parameter 'resource_action_create' when calling ResourceActionsApi.create_resource_action" end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(resource_action_create) # return_type return_type = opts[:debug_return_type] || 'ResourceActionRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceActionsApi.create_resource_action", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ResourceActionsApi#create_resource_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_resource_action(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ nil
Delete Resource Action Deletes the action and all its related data. This includes any permissions granted to perform the action.
116 117 118 119 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 116 def delete_resource_action(proj_id, env_id, resource_id, action_id, opts = {}) delete_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts) nil end |
#delete_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Resource Action Deletes the action and all its related data. This includes any permissions granted to perform the action.
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 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 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 129 def delete_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceActionsApi.delete_resource_action ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourceActionsApi.delete_resource_action" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourceActionsApi.delete_resource_action" end # verify the required parameter 'resource_id' is set if @api_client.config.client_side_validation && resource_id.nil? fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourceActionsApi.delete_resource_action" end # verify the required parameter 'action_id' is set if @api_client.config.client_side_validation && action_id.nil? fail ArgumentError, "Missing the required parameter 'action_id' when calling ResourceActionsApi.delete_resource_action" end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions/{action_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s)).sub('{' + 'action_id' + '}', CGI.escape(action_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceActionsApi.delete_resource_action", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ResourceActionsApi#delete_resource_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_resource_action(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ ResourceActionRead
Get Resource Action Gets a single action defined on the resource, if such action exists.
197 198 199 200 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 197 def get_resource_action(proj_id, env_id, resource_id, action_id, opts = {}) data, _status_code, _headers = get_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts) data end |
#get_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts = {}) ⇒ Array<(ResourceActionRead, Integer, Hash)>
Get Resource Action Gets a single action defined on the resource, if such action exists.
210 211 212 213 214 215 216 217 218 219 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 261 262 263 264 265 266 267 268 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 210 def get_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceActionsApi.get_resource_action ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourceActionsApi.get_resource_action" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourceActionsApi.get_resource_action" end # verify the required parameter 'resource_id' is set if @api_client.config.client_side_validation && resource_id.nil? fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourceActionsApi.get_resource_action" end # verify the required parameter 'action_id' is set if @api_client.config.client_side_validation && action_id.nil? fail ArgumentError, "Missing the required parameter 'action_id' when calling ResourceActionsApi.get_resource_action" end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions/{action_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s)).sub('{' + 'action_id' + '}', CGI.escape(action_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ResourceActionRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceActionsApi.get_resource_action", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ResourceActionsApi#get_resource_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_resource_actions(proj_id, env_id, resource_id, opts = {}) ⇒ Array<ResourceActionRead>
List Resource Actions Lists all the actions defined on the resource.
279 280 281 282 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 279 def list_resource_actions(proj_id, env_id, resource_id, opts = {}) data, _status_code, _headers = list_resource_actions_with_http_info(proj_id, env_id, resource_id, opts) data end |
#list_resource_actions_with_http_info(proj_id, env_id, resource_id, opts = {}) ⇒ Array<(Array<ResourceActionRead>, Integer, Hash)>
List Resource Actions Lists all the actions defined on the resource.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 293 def list_resource_actions_with_http_info(proj_id, env_id, resource_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceActionsApi.list_resource_actions ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourceActionsApi.list_resource_actions" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourceActionsApi.list_resource_actions" end # verify the required parameter 'resource_id' is set if @api_client.config.client_side_validation && resource_id.nil? fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourceActionsApi.list_resource_actions" end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ResourceActionsApi.list_resource_actions, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ResourceActionsApi.list_resource_actions, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling ResourceActionsApi.list_resource_actions, must be greater than or equal to 1.' end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<ResourceActionRead>' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceActionsApi.list_resource_actions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ResourceActionsApi#list_resource_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_resource_action(proj_id, env_id, resource_id, action_id, resource_action_update, opts = {}) ⇒ ResourceActionRead
Update Resource Action Partially updates the action defined on a resource. Fields that will be provided will be completely overwritten.
372 373 374 375 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 372 def update_resource_action(proj_id, env_id, resource_id, action_id, resource_action_update, opts = {}) data, _status_code, _headers = update_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, resource_action_update, opts) data end |
#update_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, resource_action_update, opts = {}) ⇒ Array<(ResourceActionRead, Integer, Hash)>
Update Resource Action Partially updates the action defined on a resource. Fields that will be provided will be completely overwritten.
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/openapi_client/api/resource_actions_api.rb', line 386 def update_resource_action_with_http_info(proj_id, env_id, resource_id, action_id, resource_action_update, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceActionsApi.update_resource_action ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling ResourceActionsApi.update_resource_action" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling ResourceActionsApi.update_resource_action" end # verify the required parameter 'resource_id' is set if @api_client.config.client_side_validation && resource_id.nil? fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourceActionsApi.update_resource_action" end # verify the required parameter 'action_id' is set if @api_client.config.client_side_validation && action_id.nil? fail ArgumentError, "Missing the required parameter 'action_id' when calling ResourceActionsApi.update_resource_action" end # verify the required parameter 'resource_action_update' is set if @api_client.config.client_side_validation && resource_action_update.nil? fail ArgumentError, "Missing the required parameter 'resource_action_update' when calling ResourceActionsApi.update_resource_action" end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/actions/{action_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s)).sub('{' + 'action_id' + '}', CGI.escape(action_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(resource_action_update) # return_type return_type = opts[:debug_return_type] || 'ResourceActionRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceActionsApi.update_resource_action", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ResourceActionsApi#update_resource_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |