comet_backup_ruby_sdk 2.7.0 → 2.9.0

data/lib/comet/models/destination_location.rb

@@ -10,11 +10,16 @@ require 'json'
 module Comet
 
   # DestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  # DestinationLocation describes the underlying storage location for a Storage Vault.
+# Prior to Comet 17.3.3 this was an embedded part of the DestinationConfig type.
+  # This type is available in Comet 17.3.3 and later.
   class DestinationLocation
 
+    # One of the DESTINATIONTYPE_ constants
     # @type [Number] destination_type
     attr_accessor :destination_type
 
+    # The URL for the target Comet Server Storage Role, including http/https and trailing slash
     # @type [String] comet_server
     attr_accessor :comet_server
 
@@ -45,6 +50,7 @@ module Comet
     # @type [String] s3custom_region
     attr_accessor :s3custom_region
 
+    # If true, use legacy v2 signing. If false (default), use modern v4 signing
     # @type [Boolean] s3uses_v2signing
     attr_accessor :s3uses_v2signing
 
@@ -60,21 +66,29 @@ module Comet
     # @type [String] sftpusername
     attr_accessor :sftpusername
 
+    # The directory on the SFTP server in which data is stored.
     # @type [String] sftpremote_path
     attr_accessor :sftpremote_path
 
+    # One of the DESTINATION_SFTP_AUTHMODE_ constants
     # @type [Number] sftpauth_mode
     attr_accessor :sftpauth_mode
 
+    # For use with DESTINATION_SFTP_AUTHMODE_PASSWORD only: the SSH password to connect with
     # @type [String] sftppassword
     attr_accessor :sftppassword
 
+    # For use with DESTINATION_SFTP_AUTHMODE_PRIVATEKEY only: the SSH private key to connect with, in
+    # OpenSSH format.
     # @type [String] sftpprivate_key
     attr_accessor :sftpprivate_key
 
+    # If true, then the SFTPCustomAuth_KnownHostsFile will be used to verify the remote SSH server's
+    # host key, using Trust On First Use (TOFU).
     # @type [Boolean] sftpcustom_auth__use_known_hosts_file
     attr_accessor :sftpcustom_auth__use_known_hosts_file
 
+    # If SFTPCustomAuth_UseKnownHostFile is true, the path to the SSH known_hosts file.
     # @type [String] sftpcustom_auth__known_hosts_file
     attr_accessor :sftpcustom_auth__known_hosts_file
 
@@ -87,18 +101,23 @@ module Comet
     # @type [String] ftppassword
     attr_accessor :ftppassword
 
+    # If true, store data in the default home directory given by the FTP server. If false, store data in
+    # the FTPCustomBaseDirectory path.
     # @type [Boolean] ftpbase_use_home_directory
     attr_accessor :ftpbase_use_home_directory
 
+    # If FTPBaseUseHomeDirectory is false, this field controls the path where data is stored.
     # @type [String] ftpcustom_base_directory
     attr_accessor :ftpcustom_base_directory
 
+    # Control whether this is plaintext FTP or secure FTPS by using one of the FTPS_MODE_ constants.
     # @type [Number] ftpsmode
     attr_accessor :ftpsmode
 
     # @type [Number] ftpport
     attr_accessor :ftpport
 
+    # If set to zero, uses a system default value that is not unlimited.
     # @type [Number] ftpmax_connections
     attr_accessor :ftpmax_connections
 
@@ -114,6 +133,7 @@ module Comet
     # @type [String] azbcontainer
     attr_accessor :azbcontainer
 
+    # The base URL for the Azure Blob Storage service. Leave blank to use the global default URL.
     # @type [String] azbrealm
     attr_accessor :azbrealm
 
@@ -123,12 +143,17 @@ module Comet
     # @type [String] localcopy_path
     attr_accessor :localcopy_path
 
+    # If logging in to a Windows network share (SMB/CIFS) is required, enter the username here.
     # @type [String] localcopy_win_smbusername
     attr_accessor :localcopy_win_smbusername
 
+    # If logging in to a Windows network share (SMB/CIFS) is required, enter the password here. The
+    # password may be hashed as per the LocalcopyWinSMBPasswordFormat field.
     # @type [String] localcopy_win_smbpassword
     attr_accessor :localcopy_win_smbpassword
 
+    # One of the PASSWORD_FORMAT_ constants. It controls the hash format of the LocalcopyWinSMBPassword
+    # field.
     # @type [Number] localcopy_win_smbpassword_format
     attr_accessor :localcopy_win_smbpassword_format
 
@@ -141,9 +166,20 @@ module Comet
     # @type [Comet::StorjDestinationLocation] storj
     attr_accessor :storj
 
+    # A list of underlying destinations, that will be combined and presented as one.
     # @type [Array<Comet::DestinationLocation>] span_targets
     attr_accessor :span_targets
 
+    # If true, this Spanned destination will use a consistent hashing scheme
+    # to immediately find specific files on exactly one of the target destinations.
+    # In the Static Slots mode, the span targets cannot be moved or merged, and
+    # the files must always remain in their original location.
+    #
+    # If false, the Spanned destination system will search all targets to find
+    # the requested file. This is slightly slower, but allows you to freely merge,
+    # split, and reorder the underlying destination locations.
+    #
+    # The default option is false.
     # @type [Boolean] span_use_static_slots
     attr_accessor :span_use_static_slots
 

data/lib/comet/models/destination_statistics.rb

@@ -21,9 +21,11 @@ module Comet
     # @type [String] last_successful_deep_verify__guid
     attr_accessor :last_successful_deep_verify__guid
 
+    # Unix timestamp in seconds
     # @type [Number] last_successful_deep_verify__start_time
     attr_accessor :last_successful_deep_verify__start_time
 
+    # Unix timestamp in seconds
     # @type [Number] last_successful_deep_verify__end_time
     attr_accessor :last_successful_deep_verify__end_time
 

data/lib/comet/models/device_config.rb

@@ -15,15 +15,20 @@ module Comet
     # @type [String] friendly_name
     attr_accessor :friendly_name
 
+    # Unix timestamp in seconds
     # @type [Number] registration_time
     attr_accessor :registration_time
 
+    # The operating system that the device uses.
     # @type [Comet::OSInfo] platform_version
     attr_accessor :platform_version
 
+    # Minimal information about the device's private Protected Items, so that other devices can safely
+    # run retention passes on a shared Storage Vault.
     # @type [Hash{String => Comet::SourceBasicInfo}] sources
     attr_accessor :sources
 
+    # The device's reported timezone in IANA format.
     # @type [String] device_timezone
     attr_accessor :device_timezone
 

data/lib/comet/models/dispatcher_admin_sources_response.rb

@@ -12,6 +12,7 @@ module Comet
   # DispatcherAdminSourcesResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class DispatcherAdminSourcesResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/dispatcher_stored_objects_response.rb

@@ -12,6 +12,7 @@ module Comet
   # DispatcherStoredObjectsResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class DispatcherStoredObjectsResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/dispatcher_vault_snapshots_response.rb

@@ -12,6 +12,7 @@ module Comet
   # DispatcherVaultSnapshotsResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class DispatcherVaultSnapshotsResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/dispatcher_windisk_snapshot_response.rb

@@ -12,6 +12,7 @@ module Comet
   # DispatcherWindiskSnapshotResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class DispatcherWindiskSnapshotResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/email_options.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [String] from_name
     attr_accessor :from_name
 
+    # One of the EMAIL_DELIVERY_ constants
     # @type [String] mode
     attr_accessor :mode
 

data/lib/comet/models/email_report_config.rb

@@ -12,12 +12,15 @@ module Comet
   # EmailReportConfig is a typed class wrapper around the underlying Comet Server API data structure.
   class EmailReportConfig
 
+    # One of the EMAILREPORTTYPE_ constants
     # @type [Number] report_type
     attr_accessor :report_type
 
+    # Used as a list of scheduled times to send
     # @type [Array<Comet::ScheduleConfig>] summary_frequency
     attr_accessor :summary_frequency
 
+    # Used to the determine the time bounds of a report
     # @type [Comet::TimeSpan] time_span
     attr_accessor :time_span
 

data/lib/comet/models/email_report_generated_preview.rb

@@ -12,6 +12,7 @@ module Comet
   # EmailReportGeneratedPreview is a typed class wrapper around the underlying Comet Server API data structure.
   class EmailReportGeneratedPreview
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/extra_file_exclusion.rb

@@ -12,12 +12,16 @@ module Comet
   # ExtraFileExclusion is a typed class wrapper around the underlying Comet Server API data structure.
   class ExtraFileExclusion
 
+    # The glob or regular expression to exclude from backup jobs
     # @type [String] exclude
     attr_accessor :exclude
 
+    # Choose whether the 'Exclude' parameter will be treated as a regular expression (true) or a glob
+    # (false)
     # @type [Boolean] regex
     attr_accessor :regex
 
+    # Either OS_ANY or one of the OS_ONLY constants
     # @type [Number] restrict_os
     attr_accessor :restrict_os
 

data/lib/comet/models/file_option.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2023 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # FileOption is a typed class wrapper around the underlying Comet Server API data structure.
+  # FileOption defines the configuration for Comet Server to log live events to a file. See the SEVT_
+# constants for more information.
+  # This type is available in Comet 23.3.7 and later.
+  class FileOption
+
+    # The prefix for the log filename. It will be stored in the same file location as the Comet Server
+    # log files
+    # @type [String] filename
+    attr_accessor :filename
+
+    # Configure a subset of allowed event types (see SEVT_ constants). If the array is empty, all events
+    # will be sent
+    # @type [Array<Number>] allow_event_types
+    attr_accessor :allow_event_types
+
+    # One of the STREAM_LEVEL_ constants. This controls how much data is logged into the file
+    # @type [String] level
+    attr_accessor :level
+
+    # Enables pruning of log files
+    # @type [Boolean] pruning_enabled
+    attr_accessor :pruning_enabled
+
+    # Limit in days to keep log files when PruningEnabled is set to true. If not set or 0, uses server's
+    # PruneLogsAfterDays
+    # @type [Number] pruning_limit
+    attr_accessor :pruning_limit
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @filename = ''
+      @allow_event_types = []
+      @level = ''
+      @pruning_limit = 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 'Filename'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @filename = v
+        when 'AllowEventTypes'
+          if v.nil?
+            @allow_event_types = []
+          else
+            @allow_event_types = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @allow_event_types[i1] = v1
+            end
+          end
+        when 'Level'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @level = v
+        when 'PruningEnabled'
+          @pruning_enabled = v
+        when 'PruningLimit'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @pruning_limit = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Filename'] = @filename
+      unless @allow_event_types.nil?
+        ret['AllowEventTypes'] = @allow_event_types
+      end
+      unless @level.nil?
+        ret['Level'] = @level
+      end
+      unless @pruning_enabled.nil?
+        ret['PruningEnabled'] = @pruning_enabled
+      end
+      unless @pruning_limit.nil?
+        ret['PruningLimit'] = @pruning_limit
+      end
+      @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/ftpdestination_location.rb

@@ -21,18 +21,23 @@ module Comet
     # @type [String] ftppassword
     attr_accessor :ftppassword
 
+    # If true, store data in the default home directory given by the FTP server. If false, store data in
+    # the FTPCustomBaseDirectory path.
     # @type [Boolean] ftpbase_use_home_directory
     attr_accessor :ftpbase_use_home_directory
 
+    # If FTPBaseUseHomeDirectory is false, this field controls the path where data is stored.
     # @type [String] ftpcustom_base_directory
     attr_accessor :ftpcustom_base_directory
 
+    # Control whether this is plaintext FTP or secure FTPS by using one of the FTPS_MODE_ constants.
     # @type [Number] ftpsmode
     attr_accessor :ftpsmode
 
     # @type [Number] ftpport
     attr_accessor :ftpport
 
+    # If set to zero, uses a system default value that is not unlimited.
     # @type [Number] ftpmax_connections
     attr_accessor :ftpmax_connections
 

data/lib/comet/models/get_group_policy_response.rb

@@ -12,6 +12,7 @@ module Comet
   # GetGroupPolicyResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class GetGroupPolicyResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/get_profile_and_hash_response_message.rb

@@ -12,12 +12,16 @@ module Comet
   # GetProfileAndHashResponseMessage is a typed class wrapper around the underlying Comet Server API data structure.
   class GetProfileAndHashResponseMessage
 
+    # 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
 
+    # A hash identifier for the current state of the user's profile. If you supply this in the
+    # AdminSetUserProfileHash API, the server can safely reject your change if another change has
+    # happened concurrently. This allows you to retry the request.
     # @type [String] profile_hash
     attr_accessor :profile_hash
 

data/lib/comet/models/get_profile_hash_response_message.rb

@@ -12,6 +12,7 @@ module Comet
   # GetProfileHashResponseMessage is a typed class wrapper around the underlying Comet Server API data structure.
   class GetProfileHashResponseMessage
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/group_policy.rb

@@ -21,12 +21,16 @@ module Comet
     # @type [Comet::UserPolicy] policy
     attr_accessor :policy
 
+    # DefaultUserPolicy marks that this UserPolicy should be applied to all new users. The Comet Server
+    # will ensure that only one policy can be set as default.
     # @type [Boolean] default_user_policy
     attr_accessor :default_user_policy
 
+    # Unix timestamp in seconds. May be zero for Policies created prior to Comet 23.3.3.
     # @type [Number] created_date
     attr_accessor :created_date
 
+    # Unix timestamp in seconds. May be zero for Policies created prior to Comet 23.3.3.
     # @type [Number] modified_date
     attr_accessor :modified_date
 

data/lib/comet/models/install_token_response.rb

@@ -12,6 +12,7 @@ module Comet
   # InstallTokenResponse is a typed class wrapper around the underlying Comet Server API data structure.
   class InstallTokenResponse
 
+    # If the operation was successful, the status will be in the 200-299 range.
     # @type [Number] status
     attr_accessor :status
 

data/lib/comet/models/job_entry.rb

@@ -13,9 +13,11 @@ module Comet
   # JobEntry is a single entry within a job report.
   class JobEntry
 
+    # Unix timestamp in seconds
     # @type [Number] time
     attr_accessor :time
 
+    # One of the SEVERITY_ constants.
     # @type [String] severity
     attr_accessor :severity
 

data/lib/comet/models/live_user_connection.rb

@@ -18,24 +18,35 @@ module Comet
     # @type [String] device_id
     attr_accessor :device_id
 
+    # The Comet Backup software version that this live-connected device reports that it is running. It
+    # takes the format "MAJOR.MINOR.PATCH", such as "23.2.0". See the APPLICATION_VERSION constant for
+    # more information.
     # @type [String] reported_version
     attr_accessor :reported_version
 
+    # The operating system of the device. It is one of the PLATFORM_ constants; then a forwardslash (/);
+    # then the device's GOARCH.
     # @type [String] reported_platform
     attr_accessor :reported_platform
 
+    # The operating system of the device, in extended detail.
     # @type [Comet::OSInfo] reported_platform_version
     attr_accessor :reported_platform_version
 
+    # The reported timezone of the device, in IANA format.
     # @type [String] device_time_zone
     attr_accessor :device_time_zone
 
+    # The live-connected device's remote IP address, as seen from the Comet Server.
     # @type [String] ipaddress
     attr_accessor :ipaddress
 
+    # Unix timestamp, in seconds.
     # @type [Number] connection_time
     attr_accessor :connection_time
 
+    # The current state of the "Allow administrator to view my files" client-side option. If this option
+    # is refused, some live-connected actions will be refused by the device.
     # @type [Boolean] allows_filenames
     attr_accessor :allows_filenames
 

data/lib/comet/models/local_destination_location.rb

@@ -15,12 +15,17 @@ module Comet
     # @type [String] localcopy_path
     attr_accessor :localcopy_path
 
+    # If logging in to a Windows network share (SMB/CIFS) is required, enter the username here.
     # @type [String] localcopy_win_smbusername
     attr_accessor :localcopy_win_smbusername
 
+    # If logging in to a Windows network share (SMB/CIFS) is required, enter the password here. The
+    # password may be hashed as per the LocalcopyWinSMBPasswordFormat field.
     # @type [String] localcopy_win_smbpassword
     attr_accessor :localcopy_win_smbpassword
 
+    # One of the PASSWORD_FORMAT_ constants. It controls the hash format of the LocalcopyWinSMBPassword
+    # field.
     # @type [Number] localcopy_win_smbpassword_format
     attr_accessor :localcopy_win_smbpassword_format
 

data/lib/comet/models/mac_oscode_sign_properties.rb

@@ -12,6 +12,7 @@ module Comet
   # MacOSCodeSignProperties is a typed class wrapper around the underlying Comet Server API data structure.
   class MacOSCodeSignProperties
 
+    # One of the MACOSCODESIGN_LEVEL_ constants
     # @type [Number] level
     attr_accessor :level
 

data/lib/comet/models/mongo_dbconnection.rb

@@ -27,6 +27,8 @@ module Comet
     # @type [String] authentication_db
     attr_accessor :authentication_db
 
+    # Prior to Comet 22.12.3, must be a filesystem path to `mongo` (n.b. not `mongosh`). In Comet >=
+    # 22.12.3, not used.
     # @type [String] mongo_shell_path
     # @deprecated This member has been deprecated since Comet version 22.12.3
     attr_accessor :mongo_shell_path

data/lib/comet/models/mssqllogin_args.rb

@@ -27,6 +27,8 @@ module Comet
     # @type [Boolean] method_is_oledb_32bit
     attr_accessor :method_is_oledb_32bit
 
+    # If this MSSQLLoginArgs structure is used for a restore job (RestoreJobAdvancedOptions) using
+    # RESTORETYPE_MSSQL, then, this field controls the RECOVERY / NO RECOVERY option state.
     # @type [Boolean] restore_no_recovery
     attr_accessor :restore_no_recovery
 

data/lib/comet/models/my_sqlconnection.rb

@@ -18,9 +18,11 @@ module Comet
     # @type [String] port
     attr_accessor :port
 
+    # Optional
     # @type [String] username
     attr_accessor :username
 
+    # Optional
     # @type [String] password
     attr_accessor :password
 

data/lib/comet/models/office_365custom_setting.rb

@@ -10,6 +10,9 @@ require 'json'
 module Comet
 
   # Office365CustomSetting is a typed class wrapper around the underlying Comet Server API data structure.
+  # Office365CustomSetting is used in the EngineProps for an Office 365 Protected Item (see
+# ENGINE_BUILTIN_MSOFFICE).
+# If present, it will be automatically converted to the replacement Office365CustomSettingV2 type.
   # @deprecated This type has been deprecated since Comet version 21.9.xx
   class Office365CustomSetting
 

data/lib/comet/models/office_365custom_setting_v2.rb

@@ -10,14 +10,23 @@ require 'json'
 module Comet
 
   # Office365CustomSettingV2 is a typed class wrapper around the underlying Comet Server API data structure.
+  # Office365CustomSettingV2 is used in the EngineProps for an Office 365 Protected Item (see
+# ENGINE_BUILTIN_MSOFFICE).
+  # 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.
     # @type [Boolean] organization
     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.
     # @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.
     # @type [Hash{String => Number}] member_backup_options
     attr_accessor :member_backup_options
 

data/lib/comet/models/office_365object_info.rb

@@ -21,6 +21,7 @@ module Comet
     # @type [String] type
     attr_accessor :type
 
+    # May be an email address or a SharePoint site URL
     # @type [String] value
     attr_accessor :value