lib/ionoscloud/api/ip_blocks_api.rb in ionoscloud-6.0.0.beta.4 vs lib/ionoscloud/api/ip_blocks_api.rb in ionoscloud-6.0.0
- old
+ new
@@ -1,11 +1,11 @@
=begin
#CLOUD API
#IONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the \"Data Center Designer\" (DCD) browser-based tool. Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.
-The version of the OpenAPI document: 6.0-SDK.3
+The version of the OpenAPI document: 6.0
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 5.2.1-SNAPSHOT
=end
@@ -17,26 +17,26 @@
attr_accessor :api_client
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
- # Delete IP Block
- # Removes the specific IP Block.
- # @param ipblock_id [String]
+ # Delete IP blocks
+ # Remove the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
# @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=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [nil]
def ipblocks_delete(ipblock_id, opts = {})
ipblocks_delete_with_http_info(ipblock_id, opts)
nil
end
- # Delete IP Block
- # Removes the specific IP Block.
- # @param ipblock_id [String]
+ # Delete IP blocks
+ # Remove the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
# @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=0: Only direct properties are included; children (servers and other elements) 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
# @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -97,26 +97,26 @@
@api_client.config.logger.debug "API called: IPBlocksApi#ipblocks_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Retrieve an IP Block
- # Retrieves the attributes of a given IP Block.
- # @param ipblock_id [String]
+ # Retrieve IP blocks
+ # Retrieve the properties of the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
# @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=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [IpBlock]
def ipblocks_find_by_id(ipblock_id, opts = {})
data, _status_code, _headers = ipblocks_find_by_id_with_http_info(ipblock_id, opts)
data
end
- # Retrieve an IP Block
- # Retrieves the attributes of a given IP Block.
- # @param ipblock_id [String]
+ # Retrieve IP blocks
+ # Retrieve the properties of the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
# @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=0: Only direct properties are included; children (servers and other elements) 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
# @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers
@@ -177,32 +177,32 @@
@api_client.config.logger.debug "API called: IPBlocksApi#ipblocks_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # List IP Blocks
- # Retrieve a list of all reserved IP Blocks.
+ # List IP blocks
+ # List all reserved IP blocks.
# @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=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @option opts [Integer] :offset The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). (default to 0)
- # @option opts [Integer] :limit the maximum number of elements to return (use together with offset for pagination) (default to 100)
+ # @option opts [Integer] :limit The maximum number of elements to return (use together with offset for pagination). (default to 100)
# @return [IpBlocks]
def ipblocks_get(opts = {})
data, _status_code, _headers = ipblocks_get_with_http_info(opts)
data
end
- # List IP Blocks
- # Retrieve a list of all reserved IP Blocks.
+ # List IP blocks
+ # List all reserved IP blocks.
# @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=0: Only direct properties are included; children (servers and other elements) 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
# @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] :offset The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
- # @option opts [Integer] :limit the maximum number of elements to return (use together with offset for pagination)
+ # @option opts [Integer] :limit The maximum number of elements to return (use together with offset for pagination).
# @return [Array<(IpBlocks, Integer, Hash)>] IpBlocks data, response status code and response headers
def ipblocks_get_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: IPBlocksApi.ipblocks_get ...'
end
@@ -269,28 +269,28 @@
@api_client.config.logger.debug "API called: IPBlocksApi#ipblocks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Partially modify IP Block
- # You can use update attributes of a resource.
- # @param ipblock_id [String]
- # @param ipblock [IpBlockProperties] IP Block to be modified
+ # Partially modify IP blocks
+ # Update the properties of the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
+ # @param ipblock [IpBlockProperties] The properties of the IP block 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=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [IpBlock]
def ipblocks_patch(ipblock_id, ipblock, opts = {})
data, _status_code, _headers = ipblocks_patch_with_http_info(ipblock_id, ipblock, opts)
data
end
- # Partially modify IP Block
- # You can use update attributes of a resource.
- # @param ipblock_id [String]
- # @param ipblock [IpBlockProperties] IP Block to be modified
+ # Partially modify IP blocks
+ # Update the properties of the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
+ # @param ipblock [IpBlockProperties] The properties of the IP block 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=0: Only direct properties are included; children (servers and other elements) 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
# @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers
@@ -357,26 +357,26 @@
@api_client.config.logger.debug "API called: IPBlocksApi#ipblocks_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Reserve IP Block
- # This will reserve a new IP Block.
- # @param ipblock [IpBlock] IP Block to be reserved
+ # Reserve IP blocks
+ # Reserve a new IP block.
+ # @param ipblock [IpBlock] The IP block to be reserved.
# @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=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [IpBlock]
def ipblocks_post(ipblock, opts = {})
data, _status_code, _headers = ipblocks_post_with_http_info(ipblock, opts)
data
end
- # Reserve IP Block
- # This will reserve a new IP Block.
- # @param ipblock [IpBlock] IP Block to be reserved
+ # Reserve IP blocks
+ # Reserve a new IP block.
+ # @param ipblock [IpBlock] The IP block to be reserved.
# @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=0: Only direct properties are included; children (servers and other elements) 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
# @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers
@@ -439,27 +439,27 @@
@api_client.config.logger.debug "API called: IPBlocksApi#ipblocks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Modify IP Block
- # You can use update attributes of a resource.
- # @param ipblock_id [String]
- # @param ipblock [IpBlock] IP Block to be modified
+ # Modify IP blocks
+ # Modify the properties of the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
+ # @param ipblock [IpBlock] The modified IP block.
# @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=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [IpBlock]
def ipblocks_put(ipblock_id, ipblock, opts = {})
data, _status_code, _headers = ipblocks_put_with_http_info(ipblock_id, ipblock, opts)
data
end
- # Modify IP Block
- # You can use update attributes of a resource.
- # @param ipblock_id [String]
- # @param ipblock [IpBlock] IP Block to be modified
+ # Modify IP blocks
+ # Modify the properties of the specified IP block.
+ # @param ipblock_id [String] The unique ID of the IP block.
+ # @param ipblock [IpBlock] The modified IP block.
# @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=0: Only direct properties are included; children (servers and other elements) 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
# @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(IpBlock, Integer, Hash)>] IpBlock data, response status code and response headers