comet_backup_ruby_sdk 2.40.0 → 2.42.0

data/lib/comet/models/block_info.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BlockInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class BlockInfo
+
+    # @type [String] device_id
+    attr_accessor :device_id
+
+    # @type [String] disk_node_name
+    attr_accessor :disk_node_name
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @device_id = ''
+      @disk_node_name = ''
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'DeviceID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device_id = v
+        when 'DiskNodeName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @disk_node_name = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['DeviceID'] = @device_id
+      ret['DiskNodeName'] = @disk_node_name
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_proxmox_nodes_response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseProxmoxNodesResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseProxmoxNodesResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<String>] nodes
+    attr_accessor :nodes
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @nodes = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Nodes'
+          if v.nil?
+            @nodes = []
+          else
+            @nodes = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @nodes[i1] = v1
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Nodes'] = @nodes
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_proxmox_response.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseProxmoxResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseProxmoxResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::PVEVM>] vms
+    attr_accessor :vms
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @vms = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'VMs'
+          if v.nil?
+            @vms = []
+          else
+            @vms = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @vms[i1] = Comet::PVEVM.new
+              @vms[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['VMs'] = @vms
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_proxmox_storage_response.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseProxmoxStorageResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class BrowseProxmoxStorageResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::PVEStorageName>] storage
+    attr_accessor :storage
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @storage = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Storage'
+          if v.nil?
+            @storage = []
+          else
+            @storage = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @storage[i1] = Comet::PVEStorageName.new
+              @storage[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Storage'] = @storage
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_vmware_datacenters_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseVMwareDatacentersResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareDatacentersResponse contains a list of VMware Datacenters when remotely browsing a
+# VMware vSphere connection.
+  class BrowseVMwareDatacentersResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::VMwareDatacenterInfo>] datacenters
+    attr_accessor :datacenters
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @datacenters = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Datacenters'
+          if v.nil?
+            @datacenters = []
+          else
+            @datacenters = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @datacenters[i1] = Comet::VMwareDatacenterInfo.new
+              @datacenters[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Datacenters'] = @datacenters
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_vmware_datastores_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseVMwareDatastoresResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareHostsResponse contains a list of VMware Datastores for a specific VMware Datacenter,
+# when remotely browsing a VMware vSphere connection.
+  class BrowseVMwareDatastoresResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::VMwareDatastoreInfo>] datastores
+    attr_accessor :datastores
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @datastores = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Datastores'
+          if v.nil?
+            @datastores = []
+          else
+            @datastores = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @datastores[i1] = Comet::VMwareDatastoreInfo.new
+              @datastores[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Datastores'] = @datastores
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end

data/lib/comet/models/browse_vmware_hosts_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2025 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # BrowseVMwareHostsResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareHostsResponse contains a list of VMware Hosts for a specific VMware Datacenter, when
+# remotely browsing a VMware vSphere connection.
+  class BrowseVMwareHostsResponse
+
+    # If the operation was successful, the status will be in the 200-299 range.
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::VMwareHostInfo>] hosts
+    attr_accessor :hosts
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @hosts = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
+
+      from_hash(JSON.parse(json_string))
+    end
+
+    # @param [Hash] obj The complete object as a Ruby hash
+    def from_hash(obj)
+      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'Hosts'
+          if v.nil?
+            @hosts = []
+          else
+            @hosts = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @hosts[i1] = Comet::VMwareHostInfo.new
+              @hosts[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Status'] = @status
+      ret['Message'] = @message
+      ret['Hosts'] = @hosts
+      @unknown_json_fields.each do |k, v|
+        ret[k] = v
+      end
+      ret
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_h
+      to_hash
+    end
+
+    # @return [String] The complete object as a JSON string
+    def to_json(options = {})
+      to_hash.to_json(options)
+    end
+  end
+end