comet_backup_ruby_sdk 2.39.0 → 2.41.0

data/lib/comet/models/policy_options.rb

@@ -0,0 +1,80 @@
+# 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
+
+  # PolicyOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class PolicyOptions
+
+    # @type [Array<String>] delete_sources
+    attr_accessor :delete_sources
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @delete_sources = []
+      @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 'DeleteSources'
+          if v.nil?
+            @delete_sources = []
+          else
+            @delete_sources = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @delete_sources[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['DeleteSources'] = @delete_sources
+      @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/restore_job_advanced_options.rb

@@ -107,6 +107,16 @@ module Comet
     # @type [Comet::MSSQLLoginArgs] ms_sql_connection
     attr_accessor :ms_sql_connection
 
+    # For RESTORETYPE_VMHOST
+    # This field is available in Comet 24.12.x and later.
+    # @type [Comet::VMwareRestoreTargetOptions] vmware_connection
+    attr_accessor :vmware_connection
+
+    # For RESTORETYPE_VMHOST
+    # This field is available in Comet 24.12.x and later.
+    # @type [Comet::HyperVRestoreTargetOptions] hyper_vconnection
+    attr_accessor :hyper_vconnection
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -128,6 +138,8 @@ module Comet
       @ssl_crt_file = ''
       @ssl_key_file = ''
       @ms_sql_connection = Comet::MSSQLLoginArgs.new
+      @vmware_connection = Comet::VMwareRestoreTargetOptions.new
+      @hyper_vconnection = Comet::HyperVRestoreTargetOptions.new
       @unknown_json_fields = {}
     end
 
@@ -219,6 +231,12 @@ module Comet
         when 'MsSqlConnection'
           @ms_sql_connection = Comet::MSSQLLoginArgs.new
           @ms_sql_connection.from_hash(v)
+        when 'VMwareConnection'
+          @vmware_connection = Comet::VMwareRestoreTargetOptions.new
+          @vmware_connection.from_hash(v)
+        when 'HyperVConnection'
+          @hyper_vconnection = Comet::HyperVRestoreTargetOptions.new
+          @hyper_vconnection.from_hash(v)
         else
           @unknown_json_fields[k] = v
         end
@@ -254,6 +272,12 @@ module Comet
       unless @ms_sql_connection.nil?
         ret['MsSqlConnection'] = @ms_sql_connection
       end
+      unless @vmware_connection.nil?
+        ret['VMwareConnection'] = @vmware_connection
+      end
+      unless @hyper_vconnection.nil?
+        ret['HyperVConnection'] = @hyper_vconnection
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/vmdisk_info.rb

@@ -0,0 +1,105 @@
+# 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
+
+  # VMDiskInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.12.x and later.
+  class VMDiskInfo
+
+    # Relative path within this backup job snapshot to root disk files
+    # @type [String] path
+    attr_accessor :path
+
+    # The virtual size of the virtual disk
+    # @type [Number] size
+    attr_accessor :size
+
+    # Controller number where the disk is associated to
+    # @type [Number] controller
+    attr_accessor :controller
+
+    # Device number within the controller
+    # @type [Number] device_num
+    attr_accessor :device_num
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @path = ''
+      @size = 0
+      @controller = 0
+      @device_num = 0
+      @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 'Path'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path = v
+        when 'Size'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @size = v
+        when 'Controller'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @controller = v
+        when 'DeviceNum'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @device_num = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Path'] = @path
+      ret['Size'] = @size
+      ret['Controller'] = @controller
+      ret['DeviceNum'] = @device_num
+      @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/vminfo.rb

@@ -0,0 +1,137 @@
+# 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
+
+  # VMInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.12.x and later.
+  class VMInfo
+
+    # @type [String] id
+    attr_accessor :id
+
+    # @type [String] name
+    attr_accessor :name
+
+    # @type [Number] cpucores
+    attr_accessor :cpucores
+
+    # Bytes
+    # @type [Number] ram_bytes
+    attr_accessor :ram_bytes
+
+    # The BIOS mode of this machine e.g. "Legacy"|"UEFI"
+    # @type [String] firmware_type
+    attr_accessor :firmware_type
+
+    # Relative path to config file or directory, if supported by this Protected Item type
+    # @type [String] config_path
+    attr_accessor :config_path
+
+    # @type [Array<Comet::VMDiskInfo>] disks
+    attr_accessor :disks
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @id = ''
+      @name = ''
+      @cpucores = 0
+      @ram_bytes = 0
+      @firmware_type = ''
+      @config_path = ''
+      @disks = []
+      @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 'ID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @id = v
+        when 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @name = v
+        when 'CPUCores'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @cpucores = v
+        when 'RamBytes'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @ram_bytes = v
+        when 'FirmwareType'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @firmware_type = v
+        when 'ConfigPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @config_path = v
+        when 'Disks'
+          if v.nil?
+            @disks = []
+          else
+            @disks = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @disks[i1] = Comet::VMDiskInfo.new
+              @disks[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['ID'] = @id
+      ret['Name'] = @name
+      ret['CPUCores'] = @cpucores
+      ret['RamBytes'] = @ram_bytes
+      ret['FirmwareType'] = @firmware_type
+      ret['ConfigPath'] = @config_path
+      ret['Disks'] = @disks
+      @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/vminfo_list.rb

@@ -0,0 +1,80 @@
+# 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
+
+  # VMInfoList is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 24.12.x and later.
+  class VMInfoList
+
+    # @type [Array<Comet::VMInfo>] 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
+      @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 'VMs'
+          if v.nil?
+            @vms = []
+          else
+            @vms = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @vms[i1] = Comet::VMInfo.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['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/vmware_datacenter_info.rb

@@ -0,0 +1,74 @@
+# 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
+
+  # VMwareDatacenterInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # VMwareDatacenterInfo describes a single VMware datacenter.
+  class VMwareDatacenterInfo
+
+    # @type [String] name
+    attr_accessor :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
+      @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 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @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['Name'] = @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/vmware_datastore_info.rb

@@ -0,0 +1,74 @@
+# 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
+
+  # VMwareDatastoreInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # VMwareDatastoreInfo describes a single VMware datastore within a VMware datacenter.
+  class VMwareDatastoreInfo
+
+    # @type [String] name
+    attr_accessor :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
+      @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 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @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['Name'] = @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/vmware_host_info.rb

@@ -0,0 +1,74 @@
+# 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
+
+  # VMwareHostInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # VMwareHostInfo describes a single VMware host within a VMware datacenter.
+  class VMwareHostInfo
+
+    # @type [String] name
+    attr_accessor :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
+      @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 'Name'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @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['Name'] = @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/vmware_machine_info.rb

@@ -10,6 +10,7 @@ require 'json'
 module Comet
 
   # VMwareMachineInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  # VMwareMachineInfo describes a single VMware virtual machine.
   class VMwareMachineInfo
 
     # @type [String] name