Class: OpenapiClient::ResourceInstancesApi
- Inherits:
-
Object
- Object
- OpenapiClient::ResourceInstancesApi
- Defined in:
- lib/openapi_client/api/resource_instances_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_resource_instance(proj_id, env_id, resource_instance_create, opts = {}) ⇒ ResourceInstanceRead
Create Resource Instance Creates a new instance inside the Permit.io system.
-
#create_resource_instance_with_http_info(proj_id, env_id, resource_instance_create, opts = {}) ⇒ Array<(ResourceInstanceRead, Integer, Hash)>
Create Resource Instance Creates a new instance inside the Permit.io system.
-
#delete_resource_instance(proj_id, env_id, instance_id, opts = {}) ⇒ nil
Delete Resource Instance Deletes the instance and all its related data.
-
#delete_resource_instance_with_http_info(proj_id, env_id, instance_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Resource Instance Deletes the instance and all its related data.
-
#get_resource_instance(proj_id, env_id, instance_id, opts = {}) ⇒ ResourceInstanceRead
Get Resource Instance Gets a instance, if such instance exists.
-
#get_resource_instance_with_http_info(proj_id, env_id, instance_id, opts = {}) ⇒ Array<(ResourceInstanceRead, Integer, Hash)>
Get Resource Instance Gets a instance, if such instance exists.
-
#initialize(api_client = ApiClient.default) ⇒ ResourceInstancesApi
constructor
A new instance of ResourceInstancesApi.
-
#list_resource_instances(proj_id, env_id, opts = {}) ⇒ Array<ResourceInstanceRead>
List Resource Instances Lists all the resource instances defined within an environment.
-
#list_resource_instances_with_http_info(proj_id, env_id, opts = {}) ⇒ Array<(Array<ResourceInstanceRead>, Integer, Hash)>
List Resource Instances Lists all the resource instances defined within an environment.
-
#update_resource_instance(proj_id, env_id, instance_id, resource_instance_update, opts = {}) ⇒ ResourceInstanceRead
Update Resource Instance Partially updates the instance definition.
-
#update_resource_instance_with_http_info(proj_id, env_id, instance_id, resource_instance_update, opts = {}) ⇒ Array<(ResourceInstanceRead, Integer, Hash)>
Update Resource Instance Partially updates the instance definition.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ResourceInstancesApi
Returns a new instance of ResourceInstancesApi.
19 20 21 |
# File 'lib/openapi_client/api/resource_instances_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_instances_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_resource_instance(proj_id, env_id, resource_instance_create, opts = {}) ⇒ ResourceInstanceRead
Create Resource Instance Creates a new instance inside the Permit.io system. If the instance is already created: will return 200 instead of 201, and will return the existing instance object in the response body.
29 30 31 32 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 29 def create_resource_instance(proj_id, env_id, resource_instance_create, opts = {}) data, _status_code, _headers = create_resource_instance_with_http_info(proj_id, env_id, resource_instance_create, opts) data end |
#create_resource_instance_with_http_info(proj_id, env_id, resource_instance_create, opts = {}) ⇒ Array<(ResourceInstanceRead, Integer, Hash)>
Create Resource Instance Creates a new instance inside the Permit.io system. If the instance is already created: will return 200 instead of 201, and will return the existing instance object in the response body.
41 42 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 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 41 def create_resource_instance_with_http_info(proj_id, env_id, resource_instance_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceInstancesApi.create_resource_instance ...' 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 ResourceInstancesApi.create_resource_instance" 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 ResourceInstancesApi.create_resource_instance" end # verify the required parameter 'resource_instance_create' is set if @api_client.config.client_side_validation && resource_instance_create.nil? fail ArgumentError, "Missing the required parameter 'resource_instance_create' when calling ResourceInstancesApi.create_resource_instance" end # resource path local_var_path = '/v2/facts/{proj_id}/{env_id}/resource_instances'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_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_instance_create) # return_type return_type = opts[:debug_return_type] || 'ResourceInstanceRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceInstancesApi.create_resource_instance", :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: ResourceInstancesApi#create_resource_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_resource_instance(proj_id, env_id, instance_id, opts = {}) ⇒ nil
Delete Resource Instance Deletes the instance and all its related data.
109 110 111 112 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 109 def delete_resource_instance(proj_id, env_id, instance_id, opts = {}) delete_resource_instance_with_http_info(proj_id, env_id, instance_id, opts) nil end |
#delete_resource_instance_with_http_info(proj_id, env_id, instance_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Resource Instance Deletes the instance and all its related data.
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 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 121 def delete_resource_instance_with_http_info(proj_id, env_id, instance_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceInstancesApi.delete_resource_instance ...' 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 ResourceInstancesApi.delete_resource_instance" 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 ResourceInstancesApi.delete_resource_instance" end # verify the required parameter 'instance_id' is set if @api_client.config.client_side_validation && instance_id.nil? fail ArgumentError, "Missing the required parameter 'instance_id' when calling ResourceInstancesApi.delete_resource_instance" end # resource path local_var_path = '/v2/facts/{proj_id}/{env_id}/resource_instances/{instance_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'instance_id' + '}', CGI.escape(instance_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 => :"ResourceInstancesApi.delete_resource_instance", :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: ResourceInstancesApi#delete_resource_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_resource_instance(proj_id, env_id, instance_id, opts = {}) ⇒ ResourceInstanceRead
Get Resource Instance Gets a instance, if such instance exists. Otherwise returns 404.
184 185 186 187 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 184 def get_resource_instance(proj_id, env_id, instance_id, opts = {}) data, _status_code, _headers = get_resource_instance_with_http_info(proj_id, env_id, instance_id, opts) data end |
#get_resource_instance_with_http_info(proj_id, env_id, instance_id, opts = {}) ⇒ Array<(ResourceInstanceRead, Integer, Hash)>
Get Resource Instance Gets a instance, if such instance exists. Otherwise returns 404.
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 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 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 196 def get_resource_instance_with_http_info(proj_id, env_id, instance_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceInstancesApi.get_resource_instance ...' 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 ResourceInstancesApi.get_resource_instance" 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 ResourceInstancesApi.get_resource_instance" end # verify the required parameter 'instance_id' is set if @api_client.config.client_side_validation && instance_id.nil? fail ArgumentError, "Missing the required parameter 'instance_id' when calling ResourceInstancesApi.get_resource_instance" end # resource path local_var_path = '/v2/facts/{proj_id}/{env_id}/resource_instances/{instance_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'instance_id' + '}', CGI.escape(instance_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] || 'ResourceInstanceRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceInstancesApi.get_resource_instance", :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: ResourceInstancesApi#get_resource_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_resource_instances(proj_id, env_id, opts = {}) ⇒ Array<ResourceInstanceRead>
List Resource Instances Lists all the resource instances defined within an environment.
260 261 262 263 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 260 def list_resource_instances(proj_id, env_id, opts = {}) data, _status_code, _headers = list_resource_instances_with_http_info(proj_id, env_id, opts) data end |
#list_resource_instances_with_http_info(proj_id, env_id, opts = {}) ⇒ Array<(Array<ResourceInstanceRead>, Integer, Hash)>
List Resource Instances Lists all the resource instances defined within an environment.
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 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 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 273 def list_resource_instances_with_http_info(proj_id, env_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceInstancesApi.list_resource_instances ...' 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 ResourceInstancesApi.list_resource_instances" 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 ResourceInstancesApi.list_resource_instances" end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ResourceInstancesApi.list_resource_instances, 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 ResourceInstancesApi.list_resource_instances, 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 ResourceInstancesApi.list_resource_instances, must be greater than or equal to 1.' end # resource path local_var_path = '/v2/facts/{proj_id}/{env_id}/resource_instances'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_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<ResourceInstanceRead>' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceInstancesApi.list_resource_instances", :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: ResourceInstancesApi#list_resource_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_resource_instance(proj_id, env_id, instance_id, resource_instance_update, opts = {}) ⇒ ResourceInstanceRead
Update Resource Instance Partially updates the instance definition. Fields that will be provided will be completely overwritten.
347 348 349 350 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 347 def update_resource_instance(proj_id, env_id, instance_id, resource_instance_update, opts = {}) data, _status_code, _headers = update_resource_instance_with_http_info(proj_id, env_id, instance_id, resource_instance_update, opts) data end |
#update_resource_instance_with_http_info(proj_id, env_id, instance_id, resource_instance_update, opts = {}) ⇒ Array<(ResourceInstanceRead, Integer, Hash)>
Update Resource Instance Partially updates the instance definition. Fields that will be provided will be completely overwritten.
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 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 |
# File 'lib/openapi_client/api/resource_instances_api.rb', line 360 def update_resource_instance_with_http_info(proj_id, env_id, instance_id, resource_instance_update, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ResourceInstancesApi.update_resource_instance ...' 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 ResourceInstancesApi.update_resource_instance" 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 ResourceInstancesApi.update_resource_instance" end # verify the required parameter 'instance_id' is set if @api_client.config.client_side_validation && instance_id.nil? fail ArgumentError, "Missing the required parameter 'instance_id' when calling ResourceInstancesApi.update_resource_instance" end # verify the required parameter 'resource_instance_update' is set if @api_client.config.client_side_validation && resource_instance_update.nil? fail ArgumentError, "Missing the required parameter 'resource_instance_update' when calling ResourceInstancesApi.update_resource_instance" end # resource path local_var_path = '/v2/facts/{proj_id}/{env_id}/resource_instances/{instance_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'instance_id' + '}', CGI.escape(instance_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_instance_update) # return_type return_type = opts[:debug_return_type] || 'ResourceInstanceRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"ResourceInstancesApi.update_resource_instance", :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: ResourceInstancesApi#update_resource_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |