comet_backup_ruby_sdk 2.7.0 → 2.9.0

data/lib/comet/models/add_bucket_response_message.rb

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

data/lib/comet/models/admin_resource_response.rb

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

data/lib/comet/models/azure_destination_location.rb

@@ -10,6 +10,8 @@ require 'json'
 module Comet
 
   # AzureDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  # AzureDestinationLocation allows configuring connection settings for storage locations using the
+# Azure Blob Storage API (DESTINATIONTYPE_AZURE).
   class AzureDestinationLocation
 
     # @type [String] azbaccount_name
@@ -21,6 +23,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
 

data/lib/comet/models/b2destination_location.rb

@@ -10,11 +10,15 @@ require 'json'
 module Comet
 
   # B2DestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  # B2DestinationLocation allows configuring connection settings for storage locations using the
+# Backblaze B2 native API (DESTINATIONTYPE_B2).
   class B2DestinationLocation
 
+    # Key ID
     # @type [String] account_id
     attr_accessor :account_id
 
+    # Application Key
     # @type [String] key
     attr_accessor :key
 
@@ -28,6 +32,9 @@ module Comet
     # @deprecated This member has been deprecated since Comet version 21.9.7
     attr_accessor :max_connections
 
+    # Hide files instead of deleting them. This can be used for ransomware protection if (A) the B2
+    # credentials have the hideFile permission but not the deleteFile permission, and (B) you use the
+    # Backblaze B2 server-side lifecycle policies to clean up old hidden files.
     # @type [Boolean] hide_deleted_files
     attr_accessor :hide_deleted_files
 

data/lib/comet/models/backup_job_advanced_options.rb

@@ -10,26 +10,35 @@ require 'json'
 module Comet
 
   # BackupJobAdvancedOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  # BackupJobAdvancedOptions control additional advanced options for running a backup job. They can be
+# specified as part of a schedule in the BackupRuleConfig type, or supplied immediately when running
+# a job.
   class BackupJobAdvancedOptions
 
     # @type [Boolean] skip_already_running
     attr_accessor :skip_already_running
 
+    # If Zero: disabled
     # @type [Number] stop_after
     attr_accessor :stop_after
 
+    # If Zero: disabled
     # @type [Number] limit_vault_speed_bps
     attr_accessor :limit_vault_speed_bps
 
+    # Default disabled
     # @type [Boolean] reduce_disk_concurrency
     attr_accessor :reduce_disk_concurrency
 
+    # Default disabled
     # @type [Boolean] use_on_disk_indexes
     attr_accessor :use_on_disk_indexes
 
+    # Default disabled
     # @type [Boolean] allow_zero_files_success
     attr_accessor :allow_zero_files_success
 
+    # If Zero: default Automatic (BACKUPJOBAUTORETENTION_AUTOMATIC)
     # @type [Number] auto_retention_level
     attr_accessor :auto_retention_level
 

data/lib/comet/models/backup_job_detail.rb

@@ -24,15 +24,19 @@ module Comet
     # @type [Number] status
     attr_accessor :status
 
+    # Unix timestamp in seconds
     # @type [Number] start_time
     attr_accessor :start_time
 
+    # Unix timestamp in seconds. Will be zero if the job is still running.
     # @type [Number] end_time
     attr_accessor :end_time
 
+    # The Protected Item that this job is for
     # @type [String] source_guid
     attr_accessor :source_guid
 
+    # The Storage Vault that this job is for
     # @type [String] destination_guid
     attr_accessor :destination_guid
 
@@ -63,33 +67,44 @@ module Comet
     # @type [Number] download_size
     attr_accessor :download_size
 
+    # For Hyper-V and VMware backup jobs, the total number of virtual machines.
     # @type [Number] total_vm_count
     attr_accessor :total_vm_count
 
+    # For Office 365 backup jobs, the total number of mailboxes.
     # @type [Number] total_mails_count
     attr_accessor :total_mails_count
 
+    # For Office 365 backup jobs, the total number of SharePoint sites.
     # @type [Number] total_sites_count
     attr_accessor :total_sites_count
 
+    # For Office 365 backup jobs, the calculated effective number of protected accounts.
     # @type [Number] total_accounts_count
     attr_accessor :total_accounts_count
 
+    # For Office 365 backup jobs, the number of licensed mailboxes.
     # @type [Number] total_licensed_mails_count
     attr_accessor :total_licensed_mails_count
 
+    # For Office 365 backup jobs, the number of unlicensed mailboxes.
     # @type [Number] total_unlicensed_mails_count
     attr_accessor :total_unlicensed_mails_count
 
+    # If this field is present, it is possible to request cancellation of this job via the API.
     # @type [String] cancellation_id
     attr_accessor :cancellation_id
 
+    # If this backup job is still running, additional partial-progress information may be present in
+    # this field.
     # @type [Comet::BackupJobProgress] progress
     attr_accessor :progress
 
+    # The size of the Storage Vault, as measured at the start of the job.
     # @type [Comet::SizeMeasurement] destination_size_start
     attr_accessor :destination_size_start
 
+    # The size of the Storage Vault, as measured at the end of the job.
     # @type [Comet::SizeMeasurement] destination_size_end
     attr_accessor :destination_size_end
 

data/lib/comet/models/backup_job_progress.rb

@@ -12,12 +12,16 @@ module Comet
   # BackupJobProgress is a typed class wrapper around the underlying Comet Server API data structure.
   class BackupJobProgress
 
+    # This field will always increase monotonically, exactly once, for every change to the
+    # BackupJobProgress for a given backup job.
     # @type [Number] counter
     attr_accessor :counter
 
+    # Unix timestamp in seconds
     # @type [Number] sent_time
     attr_accessor :sent_time
 
+    # Unix timestamp in seconds. The typo is preserved for backwards-compatibility reasons.
     # @type [Number] recieved_time
     attr_accessor :recieved_time
 

data/lib/comet/models/backup_rule_config.rb

@@ -10,56 +10,73 @@ require 'json'
 module Comet
 
   # BackupRuleConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  # A backup rule connects one source Protected Item and one destination Storage Vault, with multiple
+# time schedules or event triggers
   class BackupRuleConfig
 
     # @type [String] description
     attr_accessor :description
 
+    # Unix timestamp in seconds
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # Unix timestamp in seconds. The caller is responsible for updating this themselves.
     # @type [Number] modify_time
     attr_accessor :modify_time
 
+    # Custom commands to run before the job
     # @type [Array<String>] pre_exec
     attr_accessor :pre_exec
 
+    # Custom commands to run after taking a disk snapshot
     # @type [Array<String>] thaw_exec
     attr_accessor :thaw_exec
 
+    # Custom commands to run after the job
     # @type [Array<String>] post_exec
     attr_accessor :post_exec
 
+    # The source Protected Item ID to back up from, during this schedule
     # @type [String] source
     attr_accessor :source
 
+    # The destination Storage Vault ID to back up to, during this schedule
     # @type [String] destination
     attr_accessor :destination
 
     # @type [Boolean] skip_already_running
     attr_accessor :skip_already_running
 
+    # If Zero: disabled
     # @type [Number] stop_after
     attr_accessor :stop_after
 
+    # If Zero: disabled
     # @type [Number] limit_vault_speed_bps
     attr_accessor :limit_vault_speed_bps
 
+    # Default disabled
     # @type [Boolean] reduce_disk_concurrency
     attr_accessor :reduce_disk_concurrency
 
+    # Default disabled
     # @type [Boolean] use_on_disk_indexes
     attr_accessor :use_on_disk_indexes
 
+    # Default disabled
     # @type [Boolean] allow_zero_files_success
     attr_accessor :allow_zero_files_success
 
+    # If Zero: default Automatic (BACKUPJOBAUTORETENTION_AUTOMATIC)
     # @type [Number] auto_retention_level
     attr_accessor :auto_retention_level
 
+    # Scheduled start times
     # @type [Array<Comet::ScheduleConfig>] schedules
     attr_accessor :schedules
 
+    # Other events that will cause this scheduled job to start
     # @type [Comet::BackupRuleEventTriggers] event_triggers
     attr_accessor :event_triggers
 

data/lib/comet/models/backup_rule_event_triggers.rb

@@ -12,9 +12,12 @@ module Comet
   # BackupRuleEventTriggers is a typed class wrapper around the underlying Comet Server API data structure.
   class BackupRuleEventTriggers
 
+    # The "When PC Starts" option
     # @type [Boolean] on_pcboot
     attr_accessor :on_pcboot
 
+    # The "If the last job was Missed" option. In Comet 23.12.3 and later, this condition is evaluated
+    # when the PC starts and/or when the live connection is resumed.
     # @type [Boolean] on_pcboot_if_last_job_missed
     attr_accessor :on_pcboot_if_last_job_missed
 

data/lib/comet/models/branding_options.rb

@@ -12,6 +12,8 @@ module Comet
   # BrandingOptions is a typed class wrapper around the underlying Comet Server API data structure.
   class BrandingOptions
 
+    # One of the BRANDINGSTYLETYPE_ constants
+    # This field is available in Comet 23.3.3 and later.
     # @type [Number] branding_style_type
     attr_accessor :branding_style_type
 

data/lib/comet/models/browse_disk_drives_response.rb

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

data/lib/comet/models/browse_edbresponse.rb

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

data/lib/comet/models/browse_hvresponse.rb

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

data/lib/comet/models/browse_office_365list_virtual_accounts_response.rb

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

data/lib/comet/models/browse_office_365objects_response.rb

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

data/lib/comet/models/browse_sqlserver_response.rb

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

data/lib/comet/models/browse_vssresponse.rb

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

data/lib/comet/models/bucket_usage_info.rb

@@ -15,6 +15,8 @@ module Comet
     # @type [String] access_key
     attr_accessor :access_key
 
+    # The servers where this bucket was found. The 0-based indexes here correspond to the entries inside
+    # ConstellationRoleOptions->Servers.
     # @type [Array<Number>] exists_on_servers
     attr_accessor :exists_on_servers
 

data/lib/comet/models/comet_apiresponse_message.rb

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

data/lib/comet/models/comet_destination_location.rb

@@ -12,6 +12,7 @@ module Comet
   # CometDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
   class CometDestinationLocation
 
+    # The URL for the target Comet Server Storage Role, including http/https and trailing slash
     # @type [String] comet_server
     attr_accessor :comet_server
 

data/lib/comet/models/constellation_check_report.rb

@@ -12,9 +12,11 @@ module Comet
   # ConstellationCheckReport is a typed class wrapper around the underlying Comet Server API data structure.
   class ConstellationCheckReport
 
+    # Unix timestamp in seconds
     # @type [Number] check_started
     attr_accessor :check_started
 
+    # Unix timestamp in seconds
     # @type [Number] check_completed
     attr_accessor :check_completed
 

data/lib/comet/models/constellation_status_apiresponse.rb

@@ -18,6 +18,7 @@ module Comet
     # @type [Array<String>] targets
     attr_accessor :targets
 
+    # This field is available in Comet 18.6.2 and later.
     # @type [Array<String>] target_names
     attr_accessor :target_names
 

data/lib/comet/models/content_measurement.rb

@@ -12,9 +12,11 @@ module Comet
   # ContentMeasurement is a typed class wrapper around the underlying Comet Server API data structure.
   class ContentMeasurement
 
+    # Unix timestamp in seconds
     # @type [Number] measure_started
     attr_accessor :measure_started
 
+    # Unix timestamp in seconds
     # @type [Number] measure_completed
     attr_accessor :measure_completed
 

data/lib/comet/models/content_measurement_component.rb

@@ -15,6 +15,18 @@ module Comet
     # @type [Number] bytes
     attr_accessor :bytes
 
+    # A list of strings describing which groups of snapshots rely on reaching this component of data.
+    # The strings may take the following formats:
+    # - source_id/CURRENT - this data is required by the most recent backup job snapshot for the listed
+    # Protected Item source.
+    # - source_id/HISTORIC - this data is required by an older backup job snapshot for the listed
+    # Protected Item source.
+    # - TRUNCATED/* - there are too many separate components to show, and this component represents data
+    # that is used by some other combination of components. If present, it will be the only entry in the
+    # UsedBy array.
+    # - the empty string - this amount of data is not currently referenced by any backup job snapshots.
+    # If that remains the case by the next retention pass, this much data will be deleted to free up
+    # space. If present, it will be the only entry in the UsedBy array.
     # @type [Array<String>] used_by
     attr_accessor :used_by
 

data/lib/comet/models/create_group_policy_response.rb

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

data/lib/comet/models/default_email_report_policy.rb

@@ -12,6 +12,10 @@ module Comet
   # DefaultEmailReportPolicy is a typed class wrapper around the underlying Comet Server API data structure.
   class DefaultEmailReportPolicy
 
+    # If true, the email reports will use the custom configuration that is defined in
+    # UserCustomEmailSettings / Reports fields.
+    # If false, the email reports will use configuration from the policy setting if present, or else
+    # from the built-in system default email report configuration.
     # @type [Boolean] should_override_default_reports
     attr_accessor :should_override_default_reports
 

data/lib/comet/models/destination_config.rb

@@ -15,24 +15,31 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
+    # Unix timestamp in seconds
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # Unix timestamp in seconds
     # @type [Number] modify_time
     attr_accessor :modify_time
 
+    # Custom commands to run before the job
     # @type [Array<String>] pre_exec
     attr_accessor :pre_exec
 
+    # Custom commands to run after taking a disk snapshot
     # @type [Array<String>] thaw_exec
     attr_accessor :thaw_exec
 
+    # Custom commands to run after the job
     # @type [Array<String>] post_exec
     attr_accessor :post_exec
 
+    # 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
 
@@ -63,6 +70,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
 
@@ -78,21 +86,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
 
@@ -105,18 +121,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
 
@@ -132,6 +153,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
 
@@ -141,12 +163,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
 
@@ -159,33 +186,53 @@ 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
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] encryption_key_encryption_method
     attr_accessor :encryption_key_encryption_method
 
     # @type [String] encrypted_encryption_key
     attr_accessor :encrypted_encryption_key
 
+    # Unix timestamp in seconds. If zero, the Storage Vault has not yet been initialized for the first
+    # time.
     # @type [Number] repo_init_timestamp
     attr_accessor :repo_init_timestamp
 
+    # Storage Vault quota
     # @type [Boolean] storage_limit_enabled
     attr_accessor :storage_limit_enabled
 
+    # Storage Vault quota
     # @type [Number] storage_limit_bytes
     attr_accessor :storage_limit_bytes
 
     # @type [Comet::DestinationStatistics] statistics
     attr_accessor :statistics
 
+    # Configure the retention policy for this Storage Vault. The rules will be applied to any snapshot
+    # inside this Storage Vault, unless that snapshot belongs to a Protected Item source that has an
+    # overriding retention policy.
     # @type [Comet::RetentionPolicy] default_retention
     attr_accessor :default_retention
 
+    # The "Prevent users from viewing the actual storage type" option
     # @type [Boolean] rebrand_storage
     attr_accessor :rebrand_storage