lib/ionoscloud/api/volumes_api.rb in ionoscloud-6.0.0 vs lib/ionoscloud/api/volumes_api.rb in ionoscloud-6.0.1
- old
+ new
@@ -24,11 +24,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @option opts [String] :name Snapshot name
# @option opts [String] :description Snapshot description
# @option opts [Boolean] :sec_auth_protection Flag for enabling extra protection for this snapshot, such as two-step verification.
# @option opts [String] :licence_type The OS type for this snapshot.
# @return [Snapshot]
@@ -42,11 +42,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @option opts [String] :name Snapshot name
# @option opts [String] :description Snapshot description
# @option opts [Boolean] :sec_auth_protection Flag for enabling extra protection for this snapshot, such as two-step verification.
# @option opts [String] :licence_type The OS type for this snapshot.
# @return [Array<(Snapshot, Integer, Hash)>] Snapshot data, response status code and response headers
@@ -68,11 +68,11 @@
if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling VolumesApi.datacenters_volumes_create_snapshot_post, must be greater than or equal to 0.'
end
- allowable_values = ["UNKNOWN", "WINDOWS", "WINDOWS2016", "LINUX", "OTHER"]
+ allowable_values = ["UNKNOWN", "WINDOWS", "WINDOWS2016", "WINDOWS2022", "LINUX", "OTHER"]
if @api_client.config.client_side_validation && opts[:'licence_type'] && !allowable_values.include?(opts[:'licence_type'])
fail ArgumentError, "invalid value for \"licence_type\", must be one of #{allowable_values}"
end
# resource path
local_var_path = '/datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot'.sub('{' + 'datacenterId' + '}', CGI.escape(datacenter_id.to_s)).sub('{' + 'volumeId' + '}', CGI.escape(volume_id.to_s))
@@ -128,11 +128,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @return [nil]
def datacenters_volumes_delete(datacenter_id, volume_id, opts = {})
datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts)
nil
end
@@ -142,11 +142,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :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 datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: VolumesApi.datacenters_volumes_delete ...'
end
@@ -214,11 +214,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @return [Volume]
def datacenters_volumes_find_by_id(datacenter_id, volume_id, opts = {})
data, _status_code, _headers = datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts)
data
end
@@ -228,11 +228,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @return [Array<(Volume, Integer, Hash)>] Volume data, response status code and response headers
def datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: VolumesApi.datacenters_volumes_find_by_id ...'
end
@@ -299,12 +299,12 @@
# List all the volumes within the data center.
# @param datacenter_id [String] The unique ID of the data center.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for 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 (used together with <b><i>limit</i></b> for pagination). (default to 0)
# @option opts [Integer] :limit The maximum number of elements to return (use together with offset for pagination). (default to 1000)
# @return [Volumes]
def datacenters_volumes_get(datacenter_id, opts = {})
data, _status_code, _headers = datacenters_volumes_get_with_http_info(datacenter_id, opts)
data
@@ -314,12 +314,12 @@
# List all the volumes within the data center.
# @param datacenter_id [String] The unique ID of the data center.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for 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 (used together with <b><i>limit</i></b> for pagination).
# @option opts [Integer] :limit The maximum number of elements to return (use together with offset for pagination).
# @return [Array<(Volumes, Integer, Hash)>] Volumes data, response status code and response headers
def datacenters_volumes_get_with_http_info(datacenter_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: VolumesApi.datacenters_volumes_get ...'
@@ -399,11 +399,11 @@
# @param volume_id [String] The unique ID of the volume.
# @param volume [VolumeProperties] The properties of the volume 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.
+ # @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 [Volume]
def datacenters_volumes_patch(datacenter_id, volume_id, volume, opts = {})
data, _status_code, _headers = datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts)
data
end
@@ -414,11 +414,11 @@
# @param volume_id [String] The unique ID of the volume.
# @param volume [VolumeProperties] The properties of the volume 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.
+ # @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<(Volume, Integer, Hash)>] Volume data, response status code and response headers
def datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: VolumesApi.datacenters_volumes_patch ...'
end
@@ -492,11 +492,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume [Volume] The volume 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=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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @return [Volume]
def datacenters_volumes_post(datacenter_id, volume, opts = {})
data, _status_code, _headers = datacenters_volumes_post_with_http_info(datacenter_id, volume, opts)
data
end
@@ -506,11 +506,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume [Volume] The volume 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=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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @return [Array<(Volume, Integer, Hash)>] Volume data, response status code and response headers
def datacenters_volumes_post_with_http_info(datacenter_id, volume, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: VolumesApi.datacenters_volumes_post ...'
end
@@ -581,11 +581,11 @@
# @param volume_id [String] The unique ID of the volume.
# @param volume [Volume] The modified volume
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @return [Volume]
def datacenters_volumes_put(datacenter_id, volume_id, volume, opts = {})
data, _status_code, _headers = datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts)
data
end
@@ -596,11 +596,11 @@
# @param volume_id [String] The unique ID of the volume.
# @param volume [Volume] The modified volume
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @return [Array<(Volume, Integer, Hash)>] Volume data, response status code and response headers
def datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: VolumesApi.datacenters_volumes_put ...'
end
@@ -674,11 +674,11 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @option opts [String] :snapshot_id The unique ID of the snapshot.
# @return [nil]
def datacenters_volumes_restore_snapshot_post(datacenter_id, volume_id, opts = {})
datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
nil
@@ -689,10 +689,10 @@
# @param datacenter_id [String] The unique ID of the data center.
# @param volume_id [String] The unique ID of the volume.
# @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] :x_contract_number Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
# @option opts [String] :snapshot_id The unique ID of the snapshot.
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: VolumesApi.datacenters_volumes_restore_snapshot_post ...'