comet_backup_ruby_sdk 2.40.0 → 2.42.0

data/lib/comet/models/browse_vmware_networks_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
+
+  # BrowseVMwareNetworksResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareHostsResponse contains a list of VMware Networks for a specific VMware Datacenter,
+# when remotely browsing a VMware vSphere connection.
+  class BrowseVMwareNetworksResponse
+
+    # 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::VMwareNetworkInfo>] networks
+    attr_accessor :networks
+
+    # @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 = ''
+      @networks = []
+      @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 'Networks'
+          if v.nil?
+            @networks = []
+          else
+            @networks = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @networks[i1] = Comet::VMwareNetworkInfo.new
+              @networks[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['Networks'] = @networks
+      @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_response.rb

@@ -10,6 +10,8 @@ require 'json'
 module Comet
 
   # BrowseVMwareResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  # BrowseVMwareResponse contains a list of Virtual Machines when remotely browsing a VMware vSphere
+# connection.
   class BrowseVMwareResponse
 
     # If the operation was successful, the status will be in the 200-299 range.

data/lib/comet/models/disk_drive.rb

@@ -59,6 +59,10 @@ module Comet
     # @type [Number] sector_size
     attr_accessor :sector_size
 
+    # Used to indicate the partition conflicts on the disk.
+    # @type [Array<Comet::PartitionConflict>] partition_conflicts
+    attr_accessor :partition_conflicts
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -80,6 +84,7 @@ module Comet
       @heads = 0
       @sectors = 0
       @sector_size = 0
+      @partition_conflicts = []
       @unknown_json_fields = {}
     end
 
@@ -161,6 +166,16 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @sector_size = v
+        when 'PartitionConflicts'
+          if v.nil?
+            @partition_conflicts = []
+          else
+            @partition_conflicts = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @partition_conflicts[i1] = Comet::PartitionConflict.new
+              @partition_conflicts[i1].from_hash(v1)
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -183,6 +198,7 @@ module Comet
       ret['Heads'] = @heads
       ret['Sectors'] = @sectors
       ret['SectorSize'] = @sector_size
+      ret['PartitionConflicts'] = @partition_conflicts
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/dispatcher_list_snapshot_virtual_machines_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
+
+  # DispatcherListSnapshotVirtualMachinesResponse 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 DispatcherListSnapshotVirtualMachinesResponse
+
+    # 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::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
+      @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::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['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/external_authentication_source.rb

@@ -18,15 +18,15 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] remote_address
     attr_accessor :remote_address
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] username
     attr_accessor :username
 
-    # For use with Comet Server (Storage Role / Auth Role)
+    # For use with Comet Server (Storage Gateway / Management Console)
     # @type [String] password
     attr_accessor :password
 

data/lib/comet/models/hyper_vmachine_info.rb

@@ -18,6 +18,26 @@ module Comet
     # @type [String] display_name
     attr_accessor :display_name
 
+    # This field is available in Comet 24.12.x and later.
+    # @type [Number] memory_limit_mb
+    attr_accessor :memory_limit_mb
+
+    # This field is available in Comet 24.12.x and later.
+    # @type [Number] cpucores
+    attr_accessor :cpucores
+
+    # This field is available in Comet 24.12.x and later.
+    # @type [Array<String>] hard_drives
+    attr_accessor :hard_drives
+
+    # This field is available in Comet 24.12.x and later.
+    # @type [Number] generation
+    attr_accessor :generation
+
+    # This field is available in Comet 24.12.x and later.
+    # @type [String] config_file_path
+    attr_accessor :config_file_path
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -28,6 +48,11 @@ module Comet
     def clear
       @id = ''
       @display_name = ''
+      @memory_limit_mb = 0
+      @cpucores = 0
+      @hard_drives = []
+      @generation = 0
+      @config_file_path = ''
       @unknown_json_fields = {}
     end
 
@@ -52,6 +77,33 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @display_name = v
+        when 'MemoryLimitMB'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @memory_limit_mb = v
+        when 'CPUCores'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @cpucores = v
+        when 'HardDrives'
+          if v.nil?
+            @hard_drives = []
+          else
+            @hard_drives = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @hard_drives[i1] = v1
+            end
+          end
+        when 'Generation'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @generation = v
+        when 'ConfigFilePath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @config_file_path = v
         else
           @unknown_json_fields[k] = v
         end
@@ -63,6 +115,11 @@ module Comet
       ret = {}
       ret['ID'] = @id
       ret['Name'] = @display_name
+      ret['MemoryLimitMB'] = @memory_limit_mb
+      ret['CPUCores'] = @cpucores
+      ret['HardDrives'] = @hard_drives
+      ret['Generation'] = @generation
+      ret['ConfigFilePath'] = @config_file_path
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/hyper_vrestore_target_options.rb

@@ -0,0 +1,73 @@
+# 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
+
+  # HyperVRestoreTargetOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class HyperVRestoreTargetOptions
+
+    # @type [String] disk_storage_path
+    attr_accessor :disk_storage_path
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @disk_storage_path = ''
+      @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 'DiskStoragePath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @disk_storage_path = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['DiskStoragePath'] = @disk_storage_path
+      @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/office_365custom_setting_v2.rb

@@ -15,21 +15,39 @@ module Comet
   # This type is available in Comet 21.9.xx and later.
   class Office365CustomSettingV2
 
-    # If true, then backup the entire Office 365 Tenant except the selected members. If false, backup
-    # the selected members only.
+    # If true, then backup everything except the selected users (group members are still included)
     # @type [Boolean] organization
+    # @deprecated This member has been deprecated since Comet version 24.12.2
     attr_accessor :organization
 
-    # Key can be the ID of user, group or SharePoint
-    # Value is a bitset of the SERVICE_ constants, to select which services to back up for this member.
+    # If true, exclude all filtered IDs and Members. Backup everything else
+    # @type [Boolean] filter_mode
+    attr_accessor :filter_mode
+
+    # If true, backup everything, ignoring selection and filter options
+    # @type [Boolean] whole_org
+    attr_accessor :whole_org
+
+    # Key is the ID of User, Group, or Site
+    # Value is a bitset of the SERVICE_ constants, to select which services to backup for accounts
     # @type [Hash{String => Number}] backup_options
     attr_accessor :backup_options
 
-    # Key must be a group ID
-    # Value is a bitset of the SERVICE_ constants, to select which services to back up for this member.
+    # Key is the ID of a Group or Team Site
+    # Value is a bitset of the SERVICE_ constants, to select which services to backup for members
     # @type [Hash{String => Number}] member_backup_options
     attr_accessor :member_backup_options
 
+    # Key is the ID of a User, Group, or Site
+    # Value is a bitset of the SERVICE_ constants, to select which services to not backup for accounts
+    # @type [Hash{String => Number}] filter_options
+    attr_accessor :filter_options
+
+    # Key is the ID of a Group or Team Site
+    # Value is a bitset of the SERVICE_ constants, to select which services to not backup for members
+    # @type [Hash{String => Number}] filter_member_options
+    attr_accessor :filter_member_options
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -40,6 +58,8 @@ module Comet
     def clear
       @backup_options = {}
       @member_backup_options = {}
+      @filter_options = {}
+      @filter_member_options = {}
       @unknown_json_fields = {}
     end
 
@@ -58,6 +78,10 @@ module Comet
         case k
         when 'Organization'
           @organization = v
+        when 'FilterMode'
+          @filter_mode = v
+        when 'WholeOrg'
+          @whole_org = v
         when 'BackupOptions'
           @backup_options = {}
           if v.nil?
@@ -80,6 +104,28 @@ module Comet
               @member_backup_options[k1] = v1
             end
           end
+        when 'FilterOptions'
+          @filter_options = {}
+          if v.nil?
+            @filter_options = {}
+          else
+            v.each do |k1, v1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @filter_options[k1] = v1
+            end
+          end
+        when 'FilterMemberOptions'
+          @filter_member_options = {}
+          if v.nil?
+            @filter_member_options = {}
+          else
+            v.each do |k1, v1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @filter_member_options[k1] = v1
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -90,12 +136,24 @@ module Comet
     def to_hash
       ret = {}
       ret['Organization'] = @organization
+      unless @filter_mode.nil?
+        ret['FilterMode'] = @filter_mode
+      end
+      unless @whole_org.nil?
+        ret['WholeOrg'] = @whole_org
+      end
       unless @backup_options.nil?
         ret['BackupOptions'] = @backup_options
       end
       unless @member_backup_options.nil?
         ret['MemberBackupOptions'] = @member_backup_options
       end
+      unless @filter_options.nil?
+        ret['FilterOptions'] = @filter_options
+      end
+      unless @filter_member_options.nil?
+        ret['FilterMemberOptions'] = @filter_member_options
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/office_365mixed_virtual_account.rb

@@ -24,6 +24,9 @@ module Comet
     # @type [Number] enabled_service_option
     attr_accessor :enabled_service_option
 
+    # @type [Boolean] has_license
+    attr_accessor :has_license
+
     # @type [String] id
     attr_accessor :id
 
@@ -57,9 +60,6 @@ module Comet
     # @type [Number] member_service_options
     attr_accessor :member_service_options
 
-    # @type [Boolean] has_license
-    attr_accessor :has_license
-
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -112,6 +112,8 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @enabled_service_option = v
+        when 'hasLicense'
+          @has_license = v
         when 'id'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -163,8 +165,6 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @member_service_options = v
-        when 'hasLicense'
-          @has_license = v
         else
           @unknown_json_fields[k] = v
         end
@@ -186,6 +186,9 @@ module Comet
       unless @enabled_service_option.nil?
         ret['EnabledServiceOption'] = @enabled_service_option
       end
+      unless @has_license.nil?
+        ret['hasLicense'] = @has_license
+      end
       ret['id'] = @id
       unless @job_title.nil?
         ret['JobTitle'] = @job_title
@@ -217,9 +220,6 @@ module Comet
       unless @member_service_options.nil?
         ret['MemberServiceOptions'] = @member_service_options
       end
-      unless @has_license.nil?
-        ret['hasLicense'] = @has_license
-      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/partition.rb

@@ -15,6 +15,14 @@ module Comet
     # @type [String] device_name
     attr_accessor :device_name
 
+    # The partition's MBR or GPT id, if any
+    # @type [String] partition_guid
+    attr_accessor :partition_guid
+
+    # The partition's offset within the physical disk
+    # @type [Number] partition_offset
+    attr_accessor :partition_offset
+
     # The name of the filesystem used on this partition (e.g. "NTFS")
     # @type [String] filesystem
     attr_accessor :filesystem
@@ -59,6 +67,8 @@ module Comet
 
     def clear
       @device_name = ''
+      @partition_guid = ''
+      @partition_offset = 0
       @filesystem = ''
       @volume_name = ''
       @volume_guid = ''
@@ -89,6 +99,14 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @device_name = v
+        when 'PartitionGuid'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @partition_guid = v
+        when 'PartitionOffset'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @partition_offset = v
         when 'Filesystem'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -146,6 +164,8 @@ module Comet
     def to_hash
       ret = {}
       ret['DeviceName'] = @device_name
+      ret['PartitionGuid'] = @partition_guid
+      ret['PartitionOffset'] = @partition_offset
       ret['Filesystem'] = @filesystem
       ret['VolumeName'] = @volume_name
       ret['VolumeGuid'] = @volume_guid