ibm_cloud_resource_controller 1.0.1

data/docs/ResourceInstance.md

@@ -0,0 +1,81 @@
+# IbmCloudResourceController::ResourceInstance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID associated with the instance. | [optional] 
+**guid** | **String** | When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the instance. | [optional] 
+**crn** | **String** | The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see [Cloud Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn). | [optional] 
+**url** | **String** | When you provision a new resource, a relative URL path is created identifying the location of the instance. | [optional] 
+**name** | **String** | The human-readable name of the instance. | [optional] 
+**account_id** | **String** | An alpha-numeric value identifying the account ID. | [optional] 
+**resource_group_id** | **String** | The short ID of the resource group. | [optional] 
+**resource_group_crn** | **String** | The long ID (full CRN) of the resource group. | [optional] 
+**resource_id** | **String** | The unique ID of the offering. This value is provided by and stored in the global catalog. | [optional] 
+**resource_plan_id** | **String** | The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog. | [optional] 
+**target_crn** | **String** | The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned. | [optional] 
+**parameters** | **Hash<String, Object>** | The current configuration parameters of the instance. | [optional] 
+**state** | **String** | The current state of the instance. For example, if the instance is deleted, it will return removed. | [optional] 
+**type** | **String** | The type of the instance, e.g. `service_instance`. | [optional] 
+**sub_type** | **String** | The sub-type of instance, e.g. `cfaas`. | [optional] 
+**allow_cleanup** | **Boolean** | A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call. | [optional] 
+**locked** | **Boolean** | A boolean that dictates if the resource instance is locked or not. | [optional] 
+**last_operation** | **Hash<String, Object>** | The status of the last operation requested on the instance. | [optional] 
+**dashboard_url** | **String** | The resource-broker-provided URL to access administrative features of the instance. | [optional] 
+**plan_history** | [**Array<PlanHistoryItem>**](PlanHistoryItem.md) | The plan history of the instance. | [optional] 
+**resource_aliases_url** | **String** | The relative path to the resource aliases for the instance. | [optional] 
+**resource_bindings_url** | **String** | The relative path to the resource bindings for the instance. | [optional] 
+**resource_keys_url** | **String** | The relative path to the resource keys for the instance. | [optional] 
+**created_at** | **DateTime** | The date when the instance was created. | [optional] 
+**created_by** | **String** | The subject who created the instance. | [optional] 
+**updated_at** | **DateTime** | The date when the instance was last updated. | [optional] 
+**updated_by** | **String** | The subject who updated the instance. | [optional] 
+**deleted_at** | **DateTime** | The date when the instance was deleted. | [optional] 
+**deleted_by** | **String** | The subject who deleted the instance. | [optional] 
+**scheduled_reclaim_at** | **DateTime** | The date when the instance was scheduled for reclamation. | [optional] 
+**scheduled_reclaim_by** | **String** | The subject who initiated the instance reclamation. | [optional] 
+**restored_at** | **DateTime** | The date when the instance under reclamation was restored. | [optional] 
+**restored_by** | **String** | The subject who restored the instance back from reclamation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceInstance.new(id: null,
+                                 guid: null,
+                                 crn: null,
+                                 url: null,
+                                 name: null,
+                                 account_id: null,
+                                 resource_group_id: null,
+                                 resource_group_crn: null,
+                                 resource_id: null,
+                                 resource_plan_id: null,
+                                 target_crn: null,
+                                 parameters: null,
+                                 state: null,
+                                 type: null,
+                                 sub_type: null,
+                                 allow_cleanup: null,
+                                 locked: null,
+                                 last_operation: null,
+                                 dashboard_url: null,
+                                 plan_history: null,
+                                 resource_aliases_url: null,
+                                 resource_bindings_url: null,
+                                 resource_keys_url: null,
+                                 created_at: null,
+                                 created_by: null,
+                                 updated_at: null,
+                                 updated_by: null,
+                                 deleted_at: null,
+                                 deleted_by: null,
+                                 scheduled_reclaim_at: null,
+                                 scheduled_reclaim_by: null,
+                                 restored_at: null,
+                                 restored_by: null)
+```
+
+

data/docs/ResourceInstancePatch.md

@@ -0,0 +1,23 @@
+# IbmCloudResourceController::ResourceInstancePatch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The new name of the instance. Must be 180 characters or less and cannot include any special characters other than `(space) - . _ :`. | [optional] 
+**parameters** | **Hash<String, Object>** | The new configuration options for the instance. | [optional] 
+**resource_plan_id** | **String** | The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog. | [optional] 
+**allow_cleanup** | **Boolean** | A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceInstancePatch.new(name: my-new-instance-name,
+                                 parameters: null,
+                                 resource_plan_id: a8dff6d3-d287-4668-a81d-c87c55c2656d,
+                                 allow_cleanup: null)
+```
+
+

data/docs/ResourceInstancePost.md

@@ -0,0 +1,29 @@
+# IbmCloudResourceController::ResourceInstancePost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the instance. Must be 180 characters or less and cannot include any special characters other than `(space) - . _ :`. | 
+**target** | **String** | The deployment location where the instance should be hosted. | 
+**resource_group** | **String** | Short or long ID of resource group | 
+**resource_plan_id** | **String** | The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog. | 
+**tags** | **Array<String>** | Tags that are attached to the instance after provisioning. These tags can be searched and managed through the Tagging API in IBM Cloud. | [optional] 
+**allow_cleanup** | **Boolean** | A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call. | [optional] [default to false]
+**parameters** | **Hash<String, Object>** | Configuration options represented as key-value pairs that are passed through to the target resource brokers. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudResourceController'
+
+instance = IbmCloudResourceController::ResourceInstancePost.new(name: my-instance,
+                                 target: bluemix-us-south,
+                                 resource_group: 5c49eabc-f5e8-5881-a37e-2d100a33b3df,
+                                 resource_plan_id: cloudant-standard,
+                                 tags: null,
+                                 allow_cleanup: null,
+                                 parameters: null)
+```
+
+

data/docs/ResourceInstancesApi.md

@@ -0,0 +1,418 @@
+# IbmCloudResourceController::ResourceInstancesApi
+
+All URIs are relative to *https://resource-controller.cloud.ibm.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_resource_instance**](ResourceInstancesApi.md#create_resource_instance) | **POST** /v2/resource_instances | Create (provision) a new resource instance
+[**delete_resource_instance**](ResourceInstancesApi.md#delete_resource_instance) | **DELETE** /v2/resource_instances/{id} | Delete a resource instance
+[**get_resource_instance**](ResourceInstancesApi.md#get_resource_instance) | **GET** /v2/resource_instances/{id} | Get a resource instance
+[**list_resource_instances**](ResourceInstancesApi.md#list_resource_instances) | **GET** /v2/resource_instances | Get a list of all resource instances
+[**lock_resource_instance**](ResourceInstancesApi.md#lock_resource_instance) | **POST** /v2/resource_instances/{id}/lock | Lock a resource instance
+[**unlock_resource_instance**](ResourceInstancesApi.md#unlock_resource_instance) | **DELETE** /v2/resource_instances/{id}/lock | Unlock a resource instance
+[**update_resource_instance**](ResourceInstancesApi.md#update_resource_instance) | **PATCH** /v2/resource_instances/{id} | Update a resource instance
+
+
+
+## create_resource_instance
+
+> ResourceInstance create_resource_instance(resource_instance_post, opts)
+
+Create (provision) a new resource instance
+
+Provision a new resource in the specified location for the selected plan.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceInstancesApi.new
+resource_instance_post = IbmCloudResourceController::ResourceInstancePost.new # ResourceInstancePost | 
+opts = {
+  entity_lock: 'false' # String | Indicates if the resource instance is locked for further update or delete operations. It does not affect actions performed on child resources like aliases, bindings or keys. False by default.
+}
+
+begin
+  #Create (provision) a new resource instance
+  result = api_instance.create_resource_instance(resource_instance_post, opts)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceInstancesApi->create_resource_instance: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **resource_instance_post** | [**ResourceInstancePost**](ResourceInstancePost.md)|  | 
+ **entity_lock** | **String**| Indicates if the resource instance is locked for further update or delete operations. It does not affect actions performed on child resources like aliases, bindings or keys. False by default. | [optional] [default to 'false']
+
+### Return type
+
+[**ResourceInstance**](ResourceInstance.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_resource_instance
+
+> delete_resource_instance(id)
+
+Delete a resource instance
+
+Delete a resource instance by ID.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceInstancesApi.new
+id = 'id_example' # String | The short or long ID of the instance.
+
+begin
+  #Delete a resource instance
+  api_instance.delete_resource_instance(id)
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceInstancesApi->delete_resource_instance: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the instance. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_resource_instance
+
+> ResourceInstance get_resource_instance(id)
+
+Get a resource instance
+
+Retrieve a resource instance by ID.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceInstancesApi.new
+id = 'id_example' # String | The short or long ID of the instance.
+
+begin
+  #Get a resource instance
+  result = api_instance.get_resource_instance(id)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceInstancesApi->get_resource_instance: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the instance. | 
+
+### Return type
+
+[**ResourceInstance**](ResourceInstance.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_resource_instances
+
+> ResourceInstancesList list_resource_instances(opts)
+
+Get a list of all resource instances
+
+Get a list of all resource instances.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceInstancesApi.new
+opts = {
+  guid: 'guid_example', # String | When you provision a new resource in the specified location for the selected plan, a GUID (globally unique identifier) is created. This is a unique internal GUID managed by Resource controller that corresponds to the instance.
+  name: 'name_example', # String | The human-readable name of the instance.
+  resource_group_id: 'resource_group_id_example', # String | Short ID of a resource group.
+  resource_id: 'resource_id_example', # String | The unique ID of the offering. This value is provided by and stored in the global catalog.
+  resource_plan_id: 'resource_plan_id_example', # String | The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
+  type: 'type_example', # String | The type of the instance. For example, `service_instance`.
+  sub_type: 'sub_type_example', # String | The sub-type of instance, e.g. `cfaas`.
+  limit: 'limit_example', # String | Limit on how many items should be returned.
+  updated_from: '2019-01-08T00:00:00.000Z', # String | Start date inclusive filter.
+  updated_to: '2019-01-08T00:00:00.000Z' # String | End date inclusive filter.
+}
+
+begin
+  #Get a list of all resource instances
+  result = api_instance.list_resource_instances(opts)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceInstancesApi->list_resource_instances: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **guid** | **String**| When you provision a new resource in the specified location for the selected plan, a GUID (globally unique identifier) is created. This is a unique internal GUID managed by Resource controller that corresponds to the instance. | [optional] 
+ **name** | **String**| The human-readable name of the instance. | [optional] 
+ **resource_group_id** | **String**| Short ID of a resource group. | [optional] 
+ **resource_id** | **String**| The unique ID of the offering. This value is provided by and stored in the global catalog. | [optional] 
+ **resource_plan_id** | **String**| The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog. | [optional] 
+ **type** | **String**| The type of the instance. For example, `service_instance`. | [optional] 
+ **sub_type** | **String**| The sub-type of instance, e.g. `cfaas`. | [optional] 
+ **limit** | **String**| Limit on how many items should be returned. | [optional] 
+ **updated_from** | **String**| Start date inclusive filter. | [optional] 
+ **updated_to** | **String**| End date inclusive filter. | [optional] 
+
+### Return type
+
+[**ResourceInstancesList**](ResourceInstancesList.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## lock_resource_instance
+
+> ResourceInstance lock_resource_instance(id)
+
+Lock a resource instance
+
+Locks a resource instance by ID. A locked instance can not be updated or deleted. It does not affect actions performed on child resources like aliases, bindings or keys.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceInstancesApi.new
+id = 'id_example' # String | The short or long ID of the instance.
+
+begin
+  #Lock a resource instance
+  result = api_instance.lock_resource_instance(id)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceInstancesApi->lock_resource_instance: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the instance. | 
+
+### Return type
+
+[**ResourceInstance**](ResourceInstance.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## unlock_resource_instance
+
+> ResourceInstance unlock_resource_instance(id)
+
+Unlock a resource instance
+
+Unlocks a resource instance by ID.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceInstancesApi.new
+id = 'id_example' # String | The short or long ID of the instance.
+
+begin
+  #Unlock a resource instance
+  result = api_instance.unlock_resource_instance(id)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceInstancesApi->unlock_resource_instance: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the instance. | 
+
+### Return type
+
+[**ResourceInstance**](ResourceInstance.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_resource_instance
+
+> ResourceInstance update_resource_instance(id, resource_instance_patch)
+
+Update a resource instance
+
+Update a resource instance by ID.
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_resource_controller'
+# setup authorization
+IbmCloudResourceController.configure do |config|
+  # Configure API key authorization: IAM
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = IbmCloudResourceController::ResourceInstancesApi.new
+id = 'id_example' # String | The short or long ID of the instance.
+resource_instance_patch = IbmCloudResourceController::ResourceInstancePatch.new # ResourceInstancePatch | 
+
+begin
+  #Update a resource instance
+  result = api_instance.update_resource_instance(id, resource_instance_patch)
+  p result
+rescue IbmCloudResourceController::ApiError => e
+  puts "Exception when calling ResourceInstancesApi->update_resource_instance: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The short or long ID of the instance. | 
+ **resource_instance_patch** | [**ResourceInstancePatch**](ResourceInstancePatch.md)|  | 
+
+### Return type
+
+[**ResourceInstance**](ResourceInstance.md)
+
+### Authorization
+
+[IAM](../README.md#IAM)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+