class Ionoscloud::BackupUnitApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/ionoscloud/api/backup_unit_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

backupunits_delete(backupunit_id, opts = {}) click to toggle source

Delete a Backup Unit NOTE: Running through the deletion process will delete: - the backup plans inside the Backup Unit. - all backups associated with the Backup Unit. - the backup user and finally also the unit @param backupunit_id [String] The unique ID of the backup Unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0) @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Object]

# File lib/ionoscloud/api/backup_unit_api.rb, line 30
def backupunits_delete(backupunit_id, opts = {})
  data, _status_code, _headers = backupunits_delete_with_http_info(backupunit_id, opts)
  data
end
backupunits_delete_with_http_info(backupunit_id, opts = {}) click to toggle source

Delete a Backup Unit NOTE: Running through the deletion process will delete: - the backup plans inside the Backup Unit. - all backups associated with the Backup Unit. - the backup user and finally also the unit @param backupunit_id [String] The unique ID of the backup Unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/ionoscloud/api/backup_unit_api.rb, line 43
def backupunits_delete_with_http_info(backupunit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupUnitApi.backupunits_delete ...'
  end
  # verify the required parameter 'backupunit_id' is set
  if @api_client.config.client_side_validation && backupunit_id.nil?
    fail ArgumentError, "Missing the required parameter 'backupunit_id' when calling BackupUnitApi.backupunits_delete"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_delete, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_delete, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/backupunits/{backupunitId}'.sub('{' + 'backupunitId' + '}', CGI.escape(backupunit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"BackupUnitApi.backupunits_delete",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackupUnitApi#backupunits_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
backupunits_find_by_id(backupunit_id, opts = {}) click to toggle source

Returns the specified backup Unit You can retrieve the details of an specific 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 response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [BackupUnit]

# File lib/ionoscloud/api/backup_unit_api.rb, line 110
def backupunits_find_by_id(backupunit_id, opts = {})
  data, _status_code, _headers = backupunits_find_by_id_with_http_info(backupunit_id, opts)
  data
end
backupunits_find_by_id_with_http_info(backupunit_id, opts = {}) click to toggle source

Returns the specified backup Unit You can retrieve the details of an specific 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 response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers

# File lib/ionoscloud/api/backup_unit_api.rb, line 123
def backupunits_find_by_id_with_http_info(backupunit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupUnitApi.backupunits_find_by_id ...'
  end
  # verify the required parameter 'backupunit_id' is set
  if @api_client.config.client_side_validation && backupunit_id.nil?
    fail ArgumentError, "Missing the required parameter 'backupunit_id' when calling BackupUnitApi.backupunits_find_by_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_find_by_id, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_find_by_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/backupunits/{backupunitId}'.sub('{' + 'backupunitId' + '}', CGI.escape(backupunit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BackupUnit'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"BackupUnitApi.backupunits_find_by_id",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackupUnitApi#backupunits_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
backupunits_get(opts = {}) click to toggle source

List Backup Units You can retrieve a complete list of backup Units that you have access to. @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [BackupUnits]

# File lib/ionoscloud/api/backup_unit_api.rb, line 189
def backupunits_get(opts = {})
  data, _status_code, _headers = backupunits_get_with_http_info(opts)
  data
end
backupunits_get_with_http_info(opts = {}) click to toggle source

List Backup Units You can retrieve a complete list of backup Units that you have access to. @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(BackupUnits, Integer, Hash)>] BackupUnits data, response status code and response headers

# File lib/ionoscloud/api/backup_unit_api.rb, line 201
def backupunits_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupUnitApi.backupunits_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_get, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_get, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/backupunits'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BackupUnits'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"BackupUnitApi.backupunits_get",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackupUnitApi#backupunits_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
backupunits_patch(backupunit_id, backup_unit_properties, opts = {}) click to toggle source

Partially modify a Backup Unit You can use update a backup Unit properties @param backupunit_id [String] The unique ID of the backup unit @param backup_unit_properties [BackupUnitProperties] Modified backup Unit properties @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [BackupUnit]

# File lib/ionoscloud/api/backup_unit_api.rb, line 265
def backupunits_patch(backupunit_id, backup_unit_properties, opts = {})
  data, _status_code, _headers = backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts)
  data
end
backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts = {}) click to toggle source

Partially modify a Backup Unit You can use update a backup Unit properties @param backupunit_id [String] The unique ID of the backup unit @param backup_unit_properties [BackupUnitProperties] Modified backup Unit properties @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers

# File lib/ionoscloud/api/backup_unit_api.rb, line 279
def backupunits_patch_with_http_info(backupunit_id, backup_unit_properties, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupUnitApi.backupunits_patch ...'
  end
  # verify the required parameter 'backupunit_id' is set
  if @api_client.config.client_side_validation && backupunit_id.nil?
    fail ArgumentError, "Missing the required parameter 'backupunit_id' when calling BackupUnitApi.backupunits_patch"
  end
  # verify the required parameter 'backup_unit_properties' is set
  if @api_client.config.client_side_validation && backup_unit_properties.nil?
    fail ArgumentError, "Missing the required parameter 'backup_unit_properties' when calling BackupUnitApi.backupunits_patch"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_patch, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_patch, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/backupunits/{backupunitId}'.sub('{' + 'backupunitId' + '}', CGI.escape(backupunit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(backup_unit_properties)

  # return_type
  return_type = opts[:debug_return_type] || 'BackupUnit'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"BackupUnitApi.backupunits_patch",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackupUnitApi#backupunits_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
backupunits_post(backup_unit, opts = {}) click to toggle source

Create a Backup Unit Create a Backup Unit. A Backup Unit is considered a resource like a virtual datacenter, IP Block, snapshot, etc. It shall be shareable via groups inside our User Management Feature @param backup_unit [BackupUnit] Payload containing data to create a new Backup Unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [BackupUnit]

# File lib/ionoscloud/api/backup_unit_api.rb, line 352
def backupunits_post(backup_unit, opts = {})
  data, _status_code, _headers = backupunits_post_with_http_info(backup_unit, opts)
  data
end
backupunits_post_with_http_info(backup_unit, opts = {}) click to toggle source

Create a Backup Unit Create a Backup Unit. A Backup Unit is considered a resource like a virtual datacenter, IP Block, snapshot, etc. It shall be shareable via groups inside our User Management Feature @param backup_unit [BackupUnit] Payload containing data to create a new Backup Unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers

# File lib/ionoscloud/api/backup_unit_api.rb, line 365
def backupunits_post_with_http_info(backup_unit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupUnitApi.backupunits_post ...'
  end
  # verify the required parameter 'backup_unit' is set
  if @api_client.config.client_side_validation && backup_unit.nil?
    fail ArgumentError, "Missing the required parameter 'backup_unit' when calling BackupUnitApi.backupunits_post"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_post, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_post, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/backupunits'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(backup_unit)

  # return_type
  return_type = opts[:debug_return_type] || 'BackupUnit'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"BackupUnitApi.backupunits_post",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackupUnitApi#backupunits_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
backupunits_put(backupunit_id, backup_unit, opts = {}) click to toggle source

Modify a Backup Unit You can use update a backup Unit properties @param backupunit_id [String] The unique ID of the backup unit @param backup_unit [BackupUnit] Modified backup Unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [BackupUnit]

# File lib/ionoscloud/api/backup_unit_api.rb, line 435
def backupunits_put(backupunit_id, backup_unit, opts = {})
  data, _status_code, _headers = backupunits_put_with_http_info(backupunit_id, backup_unit, opts)
  data
end
backupunits_put_with_http_info(backupunit_id, backup_unit, opts = {}) click to toggle source

Modify a Backup Unit You can use update a backup Unit properties @param backupunit_id [String] The unique ID of the backup unit @param backup_unit [BackupUnit] Modified backup Unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(BackupUnit, Integer, Hash)>] BackupUnit data, response status code and response headers

# File lib/ionoscloud/api/backup_unit_api.rb, line 449
def backupunits_put_with_http_info(backupunit_id, backup_unit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupUnitApi.backupunits_put ...'
  end
  # verify the required parameter 'backupunit_id' is set
  if @api_client.config.client_side_validation && backupunit_id.nil?
    fail ArgumentError, "Missing the required parameter 'backupunit_id' when calling BackupUnitApi.backupunits_put"
  end
  # verify the required parameter 'backup_unit' is set
  if @api_client.config.client_side_validation && backup_unit.nil?
    fail ArgumentError, "Missing the required parameter 'backup_unit' when calling BackupUnitApi.backupunits_put"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_put, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling BackupUnitApi.backupunits_put, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/backupunits/{backupunitId}'.sub('{' + 'backupunitId' + '}', CGI.escape(backupunit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(backup_unit)

  # return_type
  return_type = opts[:debug_return_type] || 'BackupUnit'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"BackupUnitApi.backupunits_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackupUnitApi#backupunits_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
backupunits_ssourl_get(backupunit_id, opts = {}) click to toggle source

Returns a single signon URL for the specified backup Unit. Returns a single signon URL for the specified backup Unit. @param backupunit_id [String] The unique UUID of the backup unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true) @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed @return [BackupUnitSSO]

# File lib/ionoscloud/api/backup_unit_api.rb, line 521
def backupunits_ssourl_get(backupunit_id, opts = {})
  data, _status_code, _headers = backupunits_ssourl_get_with_http_info(backupunit_id, opts)
  data
end
backupunits_ssourl_get_with_http_info(backupunit_id, opts = {}) click to toggle source

Returns a single signon URL for the specified backup Unit. Returns a single signon URL for the specified backup Unit. @param backupunit_id [String] The unique UUID of the backup unit @param [Hash] opts the optional parameters @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed @return [Array<(BackupUnitSSO, Integer, Hash)>] BackupUnitSSO data, response status code and response headers

# File lib/ionoscloud/api/backup_unit_api.rb, line 533
def backupunits_ssourl_get_with_http_info(backupunit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupUnitApi.backupunits_ssourl_get ...'
  end
  # verify the required parameter 'backupunit_id' is set
  if @api_client.config.client_side_validation && backupunit_id.nil?
    fail ArgumentError, "Missing the required parameter 'backupunit_id' when calling BackupUnitApi.backupunits_ssourl_get"
  end
  # resource path
  local_var_path = '/backupunits/{backupunitId}/ssourl'.sub('{' + 'backupunitId' + '}', CGI.escape(backupunit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BackupUnitSSO'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"BackupUnitApi.backupunits_ssourl_get",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BackupUnitApi#backupunits_ssourl_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end