class IbmCloudResourceController::ResourceControllerV2
The resource_controller V2 service.
Constants
- DEFAULT_SERVICE_NAME
- DEFAULT_SERVICE_URL
Public Class Methods
@!method initialize(args) Construct a new client for the resource_controller service.
@param args [Hash] The args to initialize with @option args service_url [String] The base service URL to use when contacting the service.
The base service_url may differ between IBM Cloud regions.
@option args authenticator [Object] The Authenticator instance to be configured for this service. @option args service_name [String] The name of the service to configure. Will be used as the key to load
any external configuration, if applicable.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 47 def initialize(args = {}) @__async_initialized__ = false defaults = {} defaults[:service_url] = DEFAULT_SERVICE_URL defaults[:service_name] = DEFAULT_SERVICE_NAME defaults[:authenticator] = nil user_service_url = args[:service_url] unless args[:service_url].nil? args = defaults.merge(args) super @service_url = user_service_url unless user_service_url.nil? end
Public Instance Methods
@!method create_resource_alias
(name:, source:, target:) Create a new resource alias. Alias a resource instance into a targeted environment's (name)space. @param name [String] The name of the alias. Must be 180 characters or less and cannot include any
special characters other than `(space) - . _ :`.
@param source [String] The short or long ID of resource instance. @param target [String] The CRN of target name(space) in a specific environment, e.g. space in Dallas YP,
CFEE instance etc.
@return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 772 def create_resource_alias(name:, source:, target:) raise ArgumentError.new("name must be provided") if name.nil? raise ArgumentError.new("source must be provided") if source.nil? raise ArgumentError.new("target must be provided") if target.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "create_resource_alias") headers.merge!(sdk_headers) data = { "name" => name, "source" => source, "target" => target } method_url = "/v2/resource_aliases" response = request( method: "POST", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method create_resource_binding
(source:, target:, name: nil, parameters: nil, role: nil) Create a new resource binding. Create a new resource binding. @param source [String] The short or long ID of resource alias. @param target [String] The CRN of application to bind to in a specific environment, e.g. Dallas YP, CFEE
instance.
@param name [String] The name of the binding. Must be 180 characters or less and cannot include any
special characters other than `(space) - . _ :`.
@param parameters [ResourceBindingPostParameters] Configuration options represented as key-value pairs. Service defined options are
passed through to the target resource brokers, whereas platform defined options are not.
@param role [String] The role name or it's CRN. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 599 def create_resource_binding(source:, target:, name: nil, parameters: nil, role: nil) raise ArgumentError.new("source must be provided") if source.nil? raise ArgumentError.new("target must be provided") if target.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "create_resource_binding") headers.merge!(sdk_headers) data = { "source" => source, "target" => target, "name" => name, "parameters" => parameters, "role" => role } method_url = "/v2/resource_bindings" response = request( method: "POST", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method create_resource_instance
(name:, target:, resource_group:, resource_plan_id:, tags: nil, allow_cleanup: nil, parameters: nil, entity_lock: nil) Create (provision) a new resource instance. Provision a new resource in the specified location for the selected plan. @param name [String] The name of the instance. Must be 180 characters or less and cannot include any
special characters other than `(space) - . _ :`.
@param target [String] The deployment location where the instance should be hosted. @param resource_group [String] Short or long ID of resource group. @param 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.
@param tags [Array] Tags that are attached to the instance after provisioning. These tags can be
searched and managed through the Tagging API in IBM Cloud.
@param 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.
@param parameters [Hash] Configuration options represented as key-value pairs that are passed through to
the target resource brokers.
@param entity_lock [Boolean] 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.
@return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 133 def create_resource_instance(name:, target:, resource_group:, resource_plan_id:, tags: nil, allow_cleanup: nil, parameters: nil, entity_lock: nil) raise ArgumentError.new("name must be provided") if name.nil? raise ArgumentError.new("target must be provided") if target.nil? raise ArgumentError.new("resource_group must be provided") if resource_group.nil? raise ArgumentError.new("resource_plan_id must be provided") if resource_plan_id.nil? headers = { "Entity-Lock" => entity_lock } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "create_resource_instance") headers.merge!(sdk_headers) data = { "name" => name, "target" => target, "resource_group" => resource_group, "resource_plan_id" => resource_plan_id, "tags" => tags, "allow_cleanup" => allow_cleanup, "parameters" => parameters } method_url = "/v2/resource_instances" response = request( method: "POST", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method create_resource_key
(name:, source:, parameters: nil, role: nil) Create a new resource key. Create a new resource key. @param name [String] The name of the key. @param source [String] The short or long ID of resource instance or alias. @param parameters [ResourceKeyPostParameters] Configuration options represented as key-value pairs. Service defined options are
passed through to the target resource brokers, whereas platform defined options are not.
@param role [String] The role name or it's CRN. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 425 def create_resource_key(name:, source:, parameters: nil, role: nil) raise ArgumentError.new("name must be provided") if name.nil? raise ArgumentError.new("source must be provided") if source.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "create_resource_key") headers.merge!(sdk_headers) data = { "name" => name, "source" => source, "parameters" => parameters, "role" => role } method_url = "/v2/resource_keys" response = request( method: "POST", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method delete_resource_alias
(id:) Delete a resource alias. Delete a resource alias by ID. @param id [String] The short or long ID of the alias. @return [nil]
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 833 def delete_resource_alias(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "delete_resource_alias") headers.merge!(sdk_headers) method_url = "/v2/resource_aliases/%s" % [ERB::Util.url_encode(id)] request( method: "DELETE", url: method_url, headers: headers, accept_json: false ) nil end
@!method delete_resource_binding
(id:) Delete a resource binding. Delete a resource binding by ID. @param id [String] The short or long ID of the binding. @return [nil]
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 660 def delete_resource_binding(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "delete_resource_binding") headers.merge!(sdk_headers) method_url = "/v2/resource_bindings/%s" % [ERB::Util.url_encode(id)] request( method: "DELETE", url: method_url, headers: headers, accept_json: false ) nil end
@!method delete_resource_instance
(id:, recursive: nil) Delete a resource instance. Delete a resource instance by ID. @param id [String] The short or long ID of the instance. @param recursive [Boolean] Will delete resource bindings, keys and aliases associated with the instance. @return [nil]
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 202 def delete_resource_instance(id:, recursive: nil) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "delete_resource_instance") headers.merge!(sdk_headers) params = { "recursive" => recursive } method_url = "/v2/resource_instances/%s" % [ERB::Util.url_encode(id)] request( method: "DELETE", url: method_url, headers: headers, params: params, accept_json: false ) nil end
@!method delete_resource_key
(id:) Delete a resource key by ID. Delete a resource key by ID. @param id [String] The short or long ID of the key. @return [nil]
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 485 def delete_resource_key(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "delete_resource_key") headers.merge!(sdk_headers) method_url = "/v2/resource_keys/%s" % [ERB::Util.url_encode(id)] request( method: "DELETE", url: method_url, headers: headers, accept_json: false ) nil end
@!method get_resource_alias
(id:) Get a resource alias. Retrieve a resource alias by ID. @param id [String] The short or long ID of the alias. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 808 def get_resource_alias(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "get_resource_alias") headers.merge!(sdk_headers) method_url = "/v2/resource_aliases/%s" % [ERB::Util.url_encode(id)] response = request( method: "GET", url: method_url, headers: headers, accept_json: true ) response end
@!method get_resource_binding
(id:) Get a resource binding. Retrieve a resource binding by ID. @param id [String] The short or long ID of the binding. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 635 def get_resource_binding(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "get_resource_binding") headers.merge!(sdk_headers) method_url = "/v2/resource_bindings/%s" % [ERB::Util.url_encode(id)] response = request( method: "GET", url: method_url, headers: headers, accept_json: true ) response end
@!method get_resource_instance
(id:) Get a resource instance. Retrieve a resource instance by ID. @param id [String] The short or long ID of the instance. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 176 def get_resource_instance(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "get_resource_instance") headers.merge!(sdk_headers) method_url = "/v2/resource_instances/%s" % [ERB::Util.url_encode(id)] response = request( method: "GET", url: method_url, headers: headers, accept_json: true ) response end
@!method get_resource_key
(id:) Get resource key by ID. Get resource key by ID. @param id [String] The short or long ID of the key. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 460 def get_resource_key(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "get_resource_key") headers.merge!(sdk_headers) method_url = "/v2/resource_keys/%s" % [ERB::Util.url_encode(id)] response = request( method: "GET", url: method_url, headers: headers, accept_json: true ) response end
@!method list_reclamations
(account_id: nil, resource_instance_id: nil) Get a list of all reclamations. Get a list of all reclamations. @param account_id [String] An alpha-numeric value identifying the account ID. @param resource_instance_id [String] The short ID of the resource instance. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 921 def list_reclamations(account_id: nil, resource_instance_id: nil) headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_reclamations") headers.merge!(sdk_headers) params = { "account_id" => account_id, "resource_instance_id" => resource_instance_id } method_url = "/v1/reclamations" response = request( method: "GET", url: method_url, headers: headers, params: params, accept_json: true ) response end
@!method list_resource_aliases
(guid: nil, name: nil, resource_instance_id: nil, region_instance_id: nil, resource_id: nil, resource_group_id: nil, limit: nil, updated_from: nil, updated_to: nil) Get a list of all resource aliases. Get a list of all resource aliases. @param guid [String] Short ID of the alias. @param name [String] The human-readable name of the alias. @param resource_instance_id [String] Resource instance short ID. @param region_instance_id [String] Short ID of the instance in a specific targeted environment. For example,
`service_instance_id` in a given IBM Cloud environment.
@param resource_id [String] The unique ID of the offering (service name). This value is provided by and stored
in the global catalog.
@param resource_group_id [String] Short ID of Resource group. @param limit [String] Limit on how many items should be returned. @param updated_from [String] Start date inclusive filter. @param updated_to [String] End date inclusive filter. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 732 def list_resource_aliases(guid: nil, name: nil, resource_instance_id: nil, region_instance_id: nil, resource_id: nil, resource_group_id: nil, limit: nil, updated_from: nil, updated_to: nil) headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_resource_aliases") headers.merge!(sdk_headers) params = { "guid" => guid, "name" => name, "resource_instance_id" => resource_instance_id, "region_instance_id" => region_instance_id, "resource_id" => resource_id, "resource_group_id" => resource_group_id, "limit" => limit, "updated_from" => updated_from, "updated_to" => updated_to } method_url = "/v2/resource_aliases" response = request( method: "GET", url: method_url, headers: headers, params: params, accept_json: true ) response end
@!method list_resource_aliases_for_instance
(id:) Get a list of all resource aliases for the instance. Get a list of all resource aliases for the instance. @param id [String] The short or long ID of the instance. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 272 def list_resource_aliases_for_instance(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_resource_aliases_for_instance") headers.merge!(sdk_headers) method_url = "/v2/resource_instances/%s/resource_aliases" % [ERB::Util.url_encode(id)] response = request( method: "GET", url: method_url, headers: headers, accept_json: true ) response end
@!method list_resource_bindings
(guid: nil, name: nil, resource_group_id: nil, resource_id: nil, region_binding_id: nil, limit: nil, updated_from: nil, updated_to: nil) Get a list of all resource bindings. Get a list of all resource bindings. @param guid [String] The short ID of the binding. @param name [String] The human-readable name of the binding. @param resource_group_id [String] Short ID of the resource group. @param resource_id [String] The unique ID of the offering (service name). This value is provided by and stored
in the global catalog.
@param region_binding_id [String] Short ID of the binding in the specific targeted environment, e.g.
service_binding_id in a given IBM Cloud environment.
@param limit [String] Limit on how many items should be returned. @param updated_from [String] Start date inclusive filter. @param updated_to [String] End date inclusive filter. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 556 def list_resource_bindings(guid: nil, name: nil, resource_group_id: nil, resource_id: nil, region_binding_id: nil, limit: nil, updated_from: nil, updated_to: nil) headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_resource_bindings") headers.merge!(sdk_headers) params = { "guid" => guid, "name" => name, "resource_group_id" => resource_group_id, "resource_id" => resource_id, "region_binding_id" => region_binding_id, "limit" => limit, "updated_from" => updated_from, "updated_to" => updated_to } method_url = "/v2/resource_bindings" response = request( method: "GET", url: method_url, headers: headers, params: params, accept_json: true ) response end
@!method list_resource_bindings_for_alias
(id:) Get a list of all resource bindings for the alias. Get a list of all resource bindings for the alias. @param id [String] The short or long ID of the alias. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 892 def list_resource_bindings_for_alias(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_resource_bindings_for_alias") headers.merge!(sdk_headers) method_url = "/v2/resource_aliases/%s/resource_bindings" % [ERB::Util.url_encode(id)] response = request( method: "GET", url: method_url, headers: headers, accept_json: true ) response end
@!method list_resource_instances
(guid: nil, name: nil, resource_group_id: nil, resource_id: nil, resource_plan_id: nil, type: nil, sub_type: nil, limit: nil, updated_from: nil, updated_to: nil) Get a list of all resource instances. Get a list of all resource instances. @param 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.
@param name [String] The human-readable name of the instance. @param resource_group_id [String] Short ID of a resource group. @param resource_id [String] The unique ID of the offering. This value is provided by and stored in the global
catalog.
@param 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.
@param type [String] The type of the instance. For example, `service_instance`. @param sub_type [String] The sub-type of instance, e.g. `cfaas`. @param limit [String] Limit on how many items should be returned. @param updated_from [String] Start date inclusive filter. @param updated_to [String] End date inclusive filter. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 82 def list_resource_instances(guid: nil, name: nil, resource_group_id: nil, resource_id: nil, resource_plan_id: nil, type: nil, sub_type: nil, limit: nil, updated_from: nil, updated_to: nil) headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_resource_instances") headers.merge!(sdk_headers) params = { "guid" => guid, "name" => name, "resource_group_id" => resource_group_id, "resource_id" => resource_id, "resource_plan_id" => resource_plan_id, "type" => type, "sub_type" => sub_type, "limit" => limit, "updated_from" => updated_from, "updated_to" => updated_to } method_url = "/v2/resource_instances" response = request( method: "GET", url: method_url, headers: headers, params: params, accept_json: true ) response end
@!method list_resource_keys
(guid: nil, name: nil, resource_group_id: nil, resource_id: nil, limit: nil, updated_from: nil, updated_to: nil) Get a list of all of the resource keys. List all resource keys. @param guid [String] When you create a new key, a GUID (globally unique identifier) is assigned. This
is a unique internal GUID managed by Resource controller that corresponds to the key.
@param name [String] The human-readable name of the key. @param resource_group_id [String] The short ID of the resource group. @param resource_id [String] The unique ID of the offering. This value is provided by and stored in the global
catalog.
@param limit [String] Limit on how many items should be returned. @param updated_from [String] Start date inclusive filter. @param updated_to [String] End date inclusive filter. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 386 def list_resource_keys(guid: nil, name: nil, resource_group_id: nil, resource_id: nil, limit: nil, updated_from: nil, updated_to: nil) headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_resource_keys") headers.merge!(sdk_headers) params = { "guid" => guid, "name" => name, "resource_group_id" => resource_group_id, "resource_id" => resource_id, "limit" => limit, "updated_from" => updated_from, "updated_to" => updated_to } method_url = "/v2/resource_keys" response = request( method: "GET", url: method_url, headers: headers, params: params, accept_json: true ) response end
@!method list_resource_keys_for_instance
(id:) Get a list of all the resource keys for the instance. Get a list of all the resource keys for the instance. @param id [String] The short or long ID of the instance. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 297 def list_resource_keys_for_instance(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "list_resource_keys_for_instance") headers.merge!(sdk_headers) method_url = "/v2/resource_instances/%s/resource_keys" % [ERB::Util.url_encode(id)] response = request( method: "GET", url: method_url, headers: headers, accept_json: true ) response end
@!method 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.
@param id [String] The short or long ID of the instance. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 324 def lock_resource_instance(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "lock_resource_instance") headers.merge!(sdk_headers) method_url = "/v2/resource_instances/%s/lock" % [ERB::Util.url_encode(id)] response = request( method: "POST", url: method_url, headers: headers, accept_json: true ) response end
@!method run_reclamation_action
(id:, action_name:, request_by: nil, comment: nil) Perform a reclamation action. Reclaim (provisionally delete) a resource so that it can no longer be used, or
restore a resource so that it's usable again.
@param id [String] The ID associated with the reclamation. @param action_name [String] The reclamation action name. Specify `reclaim` to delete a resource, or `restore`
to restore a resource.
@param request_by [String] The request initiator, if different from the request token. @param comment [String] A comment to describe the action. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 955 def run_reclamation_action(id:, action_name:, request_by: nil, comment: nil) raise ArgumentError.new("id must be provided") if id.nil? raise ArgumentError.new("action_name must be provided") if action_name.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "run_reclamation_action") headers.merge!(sdk_headers) data = { "request_by" => request_by, "comment" => comment } method_url = "/v1/reclamations/%s/actions/%s" % [ERB::Util.url_encode(id), ERB::Util.url_encode(action_name)] response = request( method: "POST", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method unlock_resource_instance
(id:) Unlock a resource instance. Unlocks a resource instance by ID. @param id [String] The short or long ID of the instance. @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 349 def unlock_resource_instance(id:) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "unlock_resource_instance") headers.merge!(sdk_headers) method_url = "/v2/resource_instances/%s/lock" % [ERB::Util.url_encode(id)] response = request( method: "DELETE", url: method_url, headers: headers, accept_json: true ) response end
@!method update_resource_alias
(id:, name:) Update a resource alias. Update a resource alias by ID. @param id [String] The short or long ID of the alias. @param name [String] The new name of the alias. Must be 180 characters or less and cannot include any
special characters other than `(space) - . _ :`.
@return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 860 def update_resource_alias(id:, name:) raise ArgumentError.new("id must be provided") if id.nil? raise ArgumentError.new("name must be provided") if name.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "update_resource_alias") headers.merge!(sdk_headers) data = { "name" => name } method_url = "/v2/resource_aliases/%s" % [ERB::Util.url_encode(id)] response = request( method: "PATCH", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method update_resource_binding
(id:, name:) Update a resource binding. Update a resource binding by ID. @param id [String] The short or long ID of the binding. @param name [String] The new name of the binding. Must be 180 characters or less and cannot include any
special characters other than `(space) - . _ :`.
@return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 687 def update_resource_binding(id:, name:) raise ArgumentError.new("id must be provided") if id.nil? raise ArgumentError.new("name must be provided") if name.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "update_resource_binding") headers.merge!(sdk_headers) data = { "name" => name } method_url = "/v2/resource_bindings/%s" % [ERB::Util.url_encode(id)] response = request( method: "PATCH", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method update_resource_instance
(id:, name: nil, parameters: nil, resource_plan_id: nil, allow_cleanup: nil) Update a resource instance. Update a resource instance by ID. @param id [String] The short or long ID of the instance. @param name [String] The new name of the instance. Must be 180 characters or less and cannot include
any special characters other than `(space) - . _ :`.
@param parameters [Hash] The new configuration options for the instance. @param 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.
@param 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.
@return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 239 def update_resource_instance(id:, name: nil, parameters: nil, resource_plan_id: nil, allow_cleanup: nil) raise ArgumentError.new("id must be provided") if id.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "update_resource_instance") headers.merge!(sdk_headers) data = { "name" => name, "parameters" => parameters, "resource_plan_id" => resource_plan_id, "allow_cleanup" => allow_cleanup } method_url = "/v2/resource_instances/%s" % [ERB::Util.url_encode(id)] response = request( method: "PATCH", url: method_url, headers: headers, json: data, accept_json: true ) response end
@!method update_resource_key
(id:, name:) Update a resource key. Update a resource key by ID. @param id [String] The short or long ID of the key. @param name [String] The new name of the key. Must be 180 characters or less and cannot include any
special characters other than `(space) - . _ :`.
@return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
# File lib/ibm_cloud_resource_controller/resource_controller_v2.rb, line 512 def update_resource_key(id:, name:) raise ArgumentError.new("id must be provided") if id.nil? raise ArgumentError.new("name must be provided") if name.nil? headers = { } sdk_headers = Common.new.get_sdk_headers("resource_controller", "V2", "update_resource_key") headers.merge!(sdk_headers) data = { "name" => name } method_url = "/v2/resource_keys/%s" % [ERB::Util.url_encode(id)] response = request( method: "PATCH", url: method_url, headers: headers, json: data, accept_json: true ) response end