comet_backup_ruby_sdk 2.7.0 → 2.8.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

@@ -21,6 +21,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

@@ -12,9 +12,11 @@ module Comet
   # B2DestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
   class B2DestinationLocation
 
+    # Key ID
     # @type [String] account_id
     attr_accessor :account_id
 
+    # Application Key
     # @type [String] key
     attr_accessor :key
 
@@ -28,6 +30,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

@@ -15,21 +15,27 @@ module Comet
     # @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,43 @@ 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
 
     # @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

@@ -18,6 +18,7 @@ module Comet
     # @type [Number] sent_time
     attr_accessor :sent_time
 
+    # 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,23 +10,30 @@ 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
 
@@ -39,21 +46,27 @@ module Comet
     # @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_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/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/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/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/destination_config.rb

@@ -21,12 +21,15 @@ module Comet
     # @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
 
@@ -63,6 +66,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
 
@@ -81,6 +85,7 @@ module Comet
     # @type [String] sftpremote_path
     attr_accessor :sftpremote_path
 
+    # One of the DESTINATION_SFTP_AUTHMODE_ constants
     # @type [Number] sftpauth_mode
     attr_accessor :sftpauth_mode
 
@@ -111,6 +116,7 @@ module Comet
     # @type [String] ftpcustom_base_directory
     attr_accessor :ftpcustom_base_directory
 
+    # One of the FTPS_MODE_ constants.
     # @type [Number] ftpsmode
     attr_accessor :ftpsmode
 
@@ -132,6 +138,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
 
@@ -165,18 +172,23 @@ module Comet
     # @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
 
@@ -186,6 +198,7 @@ module Comet
     # @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
 

data/lib/comet/models/destination_location.rb

@@ -45,6 +45,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
 
@@ -63,6 +64,7 @@ module Comet
     # @type [String] sftpremote_path
     attr_accessor :sftpremote_path
 
+    # One of the DESTINATION_SFTP_AUTHMODE_ constants
     # @type [Number] sftpauth_mode
     attr_accessor :sftpauth_mode
 
@@ -93,6 +95,7 @@ module Comet
     # @type [String] ftpcustom_base_directory
     attr_accessor :ftpcustom_base_directory
 
+    # One of the FTPS_MODE_ constants.
     # @type [Number] ftpsmode
     attr_accessor :ftpsmode
 
@@ -114,6 +117,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/device_config.rb

@@ -18,12 +18,16 @@ module Comet
     # @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/ftpdestination_location.rb

@@ -27,6 +27,7 @@ module Comet
     # @type [String] ftpcustom_base_directory
     attr_accessor :ftpcustom_base_directory
 
+    # One of the FTPS_MODE_ constants.
     # @type [Number] ftpsmode
     attr_accessor :ftpsmode
 

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