lib/ionoscloud/api/flow_logs_api.rb in ionoscloud-6.0.0.beta.3 vs lib/ionoscloud/api/flow_logs_api.rb in ionoscloud-6.0.0.beta.4

- old
+ new

@@ -1,14 +1,14 @@ =begin #CLOUD API -#An enterprise-grade Infrastructure is provided as a Service (IaaS) solution that can be managed through a browser-based \"Data Center Designer\" (DCD) tool or via an easy to use API. The API allows you to perform a variety of management tasks such as spinning up additional servers, adding volumes, adjusting networking, and so forth. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive. +#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.1 +The version of the OpenAPI document: 6.0-SDK.3 Generated by: https://openapi-generator.tech -OpenAPI Generator version: 5.0.1-SNAPSHOT +OpenAPI Generator version: 5.2.1-SNAPSHOT =end require 'cgi' @@ -19,32 +19,32 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end # Delete a Flow Log # Removes the specified Flow Log. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the Server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @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/[ID] - 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 [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) # @return [nil] def datacenters_servers_nics_flowlogs_delete(datacenter_id, server_id, nic_id, flowlog_id, opts = {}) datacenters_servers_nics_flowlogs_delete_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, opts) nil end # Delete a Flow Log # Removes the specified Flow Log. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the Server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @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/[ID] - 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 [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 # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def datacenters_servers_nics_flowlogs_delete_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FlowLogsApi.datacenters_servers_nics_flowlogs_delete ...' end @@ -114,32 +114,32 @@ return data, status_code, headers end # Retrieve a Flow Log # Retrieves the attributes of a given Flow Log. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the Server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @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/[ID] - 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 [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) # @return [FlowLog] def datacenters_servers_nics_flowlogs_find_by_id(datacenter_id, server_id, nic_id, flowlog_id, opts = {}) data, _status_code, _headers = datacenters_servers_nics_flowlogs_find_by_id_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, opts) data end # Retrieve a Flow Log # Retrieves the attributes of a given Flow Log. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the Server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @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/[ID] - 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 [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 # @return [Array<(FlowLog, Integer, Hash)>] FlowLog data, response status code and response headers def datacenters_servers_nics_flowlogs_find_by_id_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FlowLogsApi.datacenters_servers_nics_flowlogs_find_by_id ...' end @@ -209,34 +209,34 @@ return data, status_code, headers end # List Flow Logs # Retrieves a list of Flow Logs associated with a particular network interface. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the Server # @param nic_id [String] The unique ID of the NIC # @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/[ID] - 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] :offset the first element (of the total list of 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 1000) + # @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] :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 1000) # @return [FlowLogs] def datacenters_servers_nics_flowlogs_get(datacenter_id, server_id, nic_id, opts = {}) data, _status_code, _headers = datacenters_servers_nics_flowlogs_get_with_http_info(datacenter_id, server_id, nic_id, opts) data end # List Flow Logs # Retrieves a list of Flow Logs associated with a particular network interface. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the Server # @param nic_id [String] The unique ID of the NIC # @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/[ID] - 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] :offset the first element (of the total list of 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 [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] :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). # @return [Array<(FlowLogs, Integer, Hash)>] FlowLogs data, response status code and response headers def datacenters_servers_nics_flowlogs_get_with_http_info(datacenter_id, server_id, nic_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FlowLogsApi.datacenters_servers_nics_flowlogs_get ...' end @@ -316,34 +316,34 @@ return data, status_code, headers end # Partially update a Flow Log # This will partially update a Flow Log record. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @param flowlog [FlowLogProperties] Modified Flow Log # @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/[ID] - 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 [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) # @return [FlowLog] def datacenters_servers_nics_flowlogs_patch(datacenter_id, server_id, nic_id, flowlog_id, flowlog, opts = {}) data, _status_code, _headers = datacenters_servers_nics_flowlogs_patch_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, flowlog, opts) data end # Partially update a Flow Log # This will partially update a Flow Log record. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @param flowlog [FlowLogProperties] Modified Flow Log # @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/[ID] - 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 [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 # @return [Array<(FlowLog, Integer, Hash)>] FlowLog data, response status code and response headers def datacenters_servers_nics_flowlogs_patch_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, flowlog, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FlowLogsApi.datacenters_servers_nics_flowlogs_patch ...' end @@ -419,32 +419,32 @@ return data, status_code, headers end # Create a Flow Log # This will add a Flow Log to the network interface. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the server # @param nic_id [String] The unique ID of the NIC # @param flowlog [FlowLog] Flow Log to be created # @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/[ID] - 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 [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) # @return [FlowLog] def datacenters_servers_nics_flowlogs_post(datacenter_id, server_id, nic_id, flowlog, opts = {}) data, _status_code, _headers = datacenters_servers_nics_flowlogs_post_with_http_info(datacenter_id, server_id, nic_id, flowlog, opts) data end # Create a Flow Log # This will add a Flow Log to the network interface. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the server # @param nic_id [String] The unique ID of the NIC # @param flowlog [FlowLog] Flow Log to be created # @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/[ID] - 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 [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 # @return [Array<(FlowLog, Integer, Hash)>] FlowLog data, response status code and response headers def datacenters_servers_nics_flowlogs_post_with_http_info(datacenter_id, server_id, nic_id, flowlog, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FlowLogsApi.datacenters_servers_nics_flowlogs_post ...' end @@ -516,33 +516,33 @@ return data, status_code, headers end # Modify a Flow Log # This will update a Flow Log record. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @param flowlog [FlowLogPut] Modified Flow Log # @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/[ID] - 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 [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) # @return [FlowLog] def datacenters_servers_nics_flowlogs_put(datacenter_id, server_id, nic_id, flowlog_id, flowlog, opts = {}) data, _status_code, _headers = datacenters_servers_nics_flowlogs_put_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, flowlog, opts) data end # Modify a Flow Log # This will update a Flow Log record. - # @param datacenter_id [String] The unique ID of the datacenter + # @param datacenter_id [String] The unique ID of the data center. # @param server_id [String] The unique ID of the server # @param nic_id [String] The unique ID of the NIC # @param flowlog_id [String] The unique ID of the Flow Log # @param flowlog [FlowLogPut] Modified Flow Log # @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/[ID] - 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 [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 # @return [Array<(FlowLog, Integer, Hash)>] FlowLog data, response status code and response headers def datacenters_servers_nics_flowlogs_put_with_http_info(datacenter_id, server_id, nic_id, flowlog_id, flowlog, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FlowLogsApi.datacenters_servers_nics_flowlogs_put ...' end