lib/ionoscloud/api/backup_units_api.rb in ionoscloud-6.0.0 vs lib/ionoscloud/api/backup_units_api.rb in ionoscloud-6.0.1

- old
+ new

@@ -23,11 +23,11 @@ # Remove the specified backup unit. This process will delete: 1) The backup plans inside the backup unit 2) All backups, associated with this backup unit 3) The backup user 4) The backup unit itself # @param backupunit_id [String] The unique ID of the backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true) # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on (default to 0) - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [nil] def backupunits_delete(backupunit_id, opts = {}) backupunits_delete_with_http_info(backupunit_id, opts) nil end @@ -36,11 +36,11 @@ # Remove the specified backup unit. This process will delete: 1) The backup plans inside the backup unit 2) All backups, associated with this backup unit 3) The backup user 4) The backup unit itself # @param backupunit_id [String] The unique ID of the backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def backupunits_delete_with_http_info(backupunit_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BackupUnitsApi.backupunits_delete ...' end @@ -103,11 +103,11 @@ # Retrieve the properties of the specified backup unit. # @param backupunit_id [String] The unique ID of the backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true) # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on (default to 0) - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [BackupUnit] def backupunits_find_by_id(backupunit_id, opts = {}) data, _status_code, _headers = backupunits_find_by_id_with_http_info(backupunit_id, opts) data end @@ -116,11 +116,11 @@ # Retrieve the properties of the specified backup unit. # @param backupunit_id [String] The unique ID of the backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers def backupunits_find_by_id_with_http_info(backupunit_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BackupUnitsApi.backupunits_find_by_id ...' end @@ -182,11 +182,11 @@ # List backup units # List all available backup units. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true) # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on (default to 0) - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [BackupUnits] def backupunits_get(opts = {}) data, _status_code, _headers = backupunits_get_with_http_info(opts) data end @@ -194,11 +194,11 @@ # List backup units # List all available backup units. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [Array<(BackupUnits, Integer, Hash)>] BackupUnits data, response status code and response headers def backupunits_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BackupUnitsApi.backupunits_get ...' end @@ -258,11 +258,11 @@ # @param backupunit_id [String] The unique ID of the backup unit. # @param backup_unit [BackupUnitProperties] The properties of the backup unit to be updated. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true) # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on (default to 0) - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [BackupUnit] def backupunits_patch(backupunit_id, backup_unit, opts = {}) data, _status_code, _headers = backupunits_patch_with_http_info(backupunit_id, backup_unit, opts) data end @@ -272,11 +272,11 @@ # @param backupunit_id [String] The unique ID of the backup unit. # @param backup_unit [BackupUnitProperties] The properties of the backup unit to be updated. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers def backupunits_patch_with_http_info(backupunit_id, backup_unit, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BackupUnitsApi.backupunits_patch ...' end @@ -345,11 +345,11 @@ # Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management. # @param backup_unit [BackupUnit] The backup unit to create. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true) # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on (default to 0) - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [BackupUnit] def backupunits_post(backup_unit, opts = {}) data, _status_code, _headers = backupunits_post_with_http_info(backup_unit, opts) data end @@ -358,11 +358,11 @@ # Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management. # @param backup_unit [BackupUnit] The backup unit to create. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers def backupunits_post_with_http_info(backup_unit, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BackupUnitsApi.backupunits_post ...' end @@ -428,11 +428,11 @@ # @param backupunit_id [String] The unique ID of the backup unit. # @param backup_unit [BackupUnit] The modified backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true) # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on (default to 0) - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [BackupUnit] def backupunits_put(backupunit_id, backup_unit, opts = {}) data, _status_code, _headers = backupunits_put_with_http_info(backupunit_id, backup_unit, opts) data end @@ -442,11 +442,11 @@ # @param backupunit_id [String] The unique ID of the backup unit. # @param backup_unit [BackupUnit] The modified backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). # @option opts [Integer] :depth Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;... and so on - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers def backupunits_put_with_http_info(backupunit_id, backup_unit, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BackupUnitsApi.backupunits_put ...' end @@ -514,11 +514,11 @@ # Retrieve BU single sign-on URLs # Retrieve a single sign-on URL for the specified backup unit. # @param backupunit_id [String] The unique ID of the backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true) - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [BackupUnitSSO] def backupunits_ssourl_get(backupunit_id, opts = {}) data, _status_code, _headers = backupunits_ssourl_get_with_http_info(backupunit_id, opts) data end @@ -526,10 +526,10 @@ # Retrieve BU single sign-on URLs # Retrieve a single sign-on URL for the specified backup unit. # @param backupunit_id [String] The unique ID of the backup unit. # @param [Hash] opts the optional parameters # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). - # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed. + # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed. # @return [Array<(BackupUnitSSO, Integer, Hash)>] BackupUnitSSO data, response status code and response headers def backupunits_ssourl_get_with_http_info(backupunit_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BackupUnitsApi.backupunits_ssourl_get ...' end