comet_backup_ruby_sdk 2.8.0 → 2.10.0

data/lib/comet/models/admin_user_permissions.rb

@@ -36,6 +36,34 @@ module Comet
     # @type [Boolean] deny_constellation_role
     attr_accessor :deny_constellation_role
 
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] deny_view_server_history
+    attr_accessor :deny_view_server_history
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] deny_view_server_info
+    attr_accessor :deny_view_server_info
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] prevent_request_storage_vault
+    attr_accessor :prevent_request_storage_vault
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] prevent_add_custom_storage_vault
+    attr_accessor :prevent_add_custom_storage_vault
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] hide_cloud_storage_branding
+    attr_accessor :hide_cloud_storage_branding
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Boolean] should_restrict_provider_list
+    attr_accessor :should_restrict_provider_list
+
+    # This field is available in Comet 23.6.0 and later.
+    # @type [Array<Number>] allowed_providers_when_restricted
+    attr_accessor :allowed_providers_when_restricted
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -44,6 +72,7 @@ module Comet
     end
 
     def clear
+      @allowed_providers_when_restricted = []
       @unknown_json_fields = {}
     end
 
@@ -76,6 +105,29 @@ module Comet
           @allow_edit_webhooks = v
         when 'DenyConstellationRole'
           @deny_constellation_role = v
+        when 'DenyViewServerHistory'
+          @deny_view_server_history = v
+        when 'DenyViewServerInfo'
+          @deny_view_server_info = v
+        when 'PreventRequestStorageVault'
+          @prevent_request_storage_vault = v
+        when 'PreventAddCustomStorageVault'
+          @prevent_add_custom_storage_vault = v
+        when 'HideCloudStorageBranding'
+          @hide_cloud_storage_branding = v
+        when 'ShouldRestrictProviderList'
+          @should_restrict_provider_list = v
+        when 'AllowedProvidersWhenRestricted'
+          if v.nil?
+            @allowed_providers_when_restricted = []
+          else
+            @allowed_providers_when_restricted = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric
+
+              @allowed_providers_when_restricted[i1] = v1
+            end
+          end
         else
           @unknown_json_fields[k] = v
         end
@@ -109,6 +161,27 @@ module Comet
       unless @deny_constellation_role.nil?
         ret['DenyConstellationRole'] = @deny_constellation_role
       end
+      unless @deny_view_server_history.nil?
+        ret['DenyViewServerHistory'] = @deny_view_server_history
+      end
+      unless @deny_view_server_info.nil?
+        ret['DenyViewServerInfo'] = @deny_view_server_info
+      end
+      unless @prevent_request_storage_vault.nil?
+        ret['PreventRequestStorageVault'] = @prevent_request_storage_vault
+      end
+      unless @prevent_add_custom_storage_vault.nil?
+        ret['PreventAddCustomStorageVault'] = @prevent_add_custom_storage_vault
+      end
+      unless @hide_cloud_storage_branding.nil?
+        ret['HideCloudStorageBranding'] = @hide_cloud_storage_branding
+      end
+      unless @should_restrict_provider_list.nil?
+        ret['ShouldRestrictProviderList'] = @should_restrict_provider_list
+      end
+      unless @allowed_providers_when_restricted.nil?
+        ret['AllowedProvidersWhenRestricted'] = @allowed_providers_when_restricted
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/admin_web_authn_registration.rb

@@ -16,6 +16,7 @@ module Comet
     # @type [String] description
     attr_accessor :description
 
+    # Unix timestamp, in seconds.
     # @type [Number] register_time
     attr_accessor :register_time
 
@@ -25,6 +26,7 @@ module Comet
     # @type [Boolean] is_legacy_u2f
     attr_accessor :is_legacy_u2f
 
+    # When this field is expressed as a AdminWebAuthnRegistration class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.
     # @type [Array<Object>] id
     attr_accessor :id
 

data/lib/comet/models/allowed_admin_user.rb

@@ -21,6 +21,7 @@ module Comet
     # @type [String] external_authentication_source
     attr_accessor :external_authentication_source
 
+    # One of the PASSWORD_FORMAT_ constants
     # @type [Number] password_format
     attr_accessor :password_format
 
@@ -47,12 +48,15 @@ module Comet
     # @type [Array<Comet::AdminWebAuthnRegistration>] web_authn_registrations
     attr_accessor :web_authn_registrations
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] totpkey_encryption_format
     attr_accessor :totpkey_encryption_format
 
     # @type [String] totpkey
     attr_accessor :totpkey
 
+    # A regular expression in Go regex syntax, for which IP addresses are allowed to authenticate as
+    # this admin account
     # @type [String] ipwhitelist
     attr_accessor :ipwhitelist
 

data/lib/comet/models/authentication_role_options.rb

@@ -15,12 +15,14 @@ module Comet
     # @type [Boolean] role_enabled
     attr_accessor :role_enabled
 
+    # One of the INTEGRITYCHECK_ constants
     # @type [Number] database_check_level
     attr_accessor :database_check_level
 
     # @type [Boolean] generate_missed_backup_events
     attr_accessor :generate_missed_backup_events
 
+    # Unix timestamp in seconds, before which no Missed jobs are created
     # @type [Number] no_missed_backup_events_before
     attr_accessor :no_missed_backup_events_before
 

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

data/lib/comet/models/b2destination_location.rb

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

data/lib/comet/models/backup_job_advanced_options.rb

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

data/lib/comet/models/backup_job_detail.rb

@@ -91,6 +91,7 @@ module Comet
     # @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
 

data/lib/comet/models/backup_job_progress.rb

@@ -12,13 +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
 
-    # The typo is preserved for backwards-compatibility reasons.
+    # 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

@@ -37,9 +37,11 @@ module Comet
     # @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
 
@@ -70,9 +72,11 @@ module Comet
     # @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/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
 
@@ -57,6 +59,7 @@ module Comet
     # @type [Boolean] hide_background_logo
     attr_accessor :hide_background_logo
 
+    # One of the CLIENTBRANDINGBUILD_ constants
     # @type [Number] build_mode
     attr_accessor :build_mode
 
@@ -84,12 +87,14 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # One of the WINDOWSCODESIGN_METHOD_ constants
     # @type [Number] windows_code_sign_method
     attr_accessor :windows_code_sign_method
 
     # @type [String] windows_code_sign_pkcs12file_path
     attr_accessor :windows_code_sign_pkcs12file_path
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs12password_format
     attr_accessor :windows_code_sign_pkcs12password_format
 
@@ -109,6 +114,7 @@ module Comet
     # @type [String] windows_code_sign_pkcs11key_id
     attr_accessor :windows_code_sign_pkcs11key_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs11password_format
     attr_accessor :windows_code_sign_pkcs11password_format
 
@@ -124,6 +130,7 @@ module Comet
     # @type [String] windows_code_sign_azure_app_id
     attr_accessor :windows_code_sign_azure_app_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_azure_app_secret_format
     attr_accessor :windows_code_sign_azure_app_secret_format
 

data/lib/comet/models/branding_properties.rb

@@ -36,6 +36,7 @@ module Comet
     # @type [Boolean] hide_background_logo
     attr_accessor :hide_background_logo
 
+    # One of the CLIENTBRANDINGBUILD_ constants
     # @type [Number] build_mode
     attr_accessor :build_mode
 
@@ -63,12 +64,14 @@ module Comet
     # @type [String] package_identifier
     attr_accessor :package_identifier
 
+    # One of the WINDOWSCODESIGN_METHOD_ constants
     # @type [Number] windows_code_sign_method
     attr_accessor :windows_code_sign_method
 
     # @type [String] windows_code_sign_pkcs12file_path
     attr_accessor :windows_code_sign_pkcs12file_path
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs12password_format
     attr_accessor :windows_code_sign_pkcs12password_format
 
@@ -88,6 +91,7 @@ module Comet
     # @type [String] windows_code_sign_pkcs11key_id
     attr_accessor :windows_code_sign_pkcs11key_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_pkcs11password_format
     attr_accessor :windows_code_sign_pkcs11password_format
 
@@ -103,6 +107,7 @@ module Comet
     # @type [String] windows_code_sign_azure_app_id
     attr_accessor :windows_code_sign_azure_app_id
 
+    # One of the ENCRYPTIONMETHOD_ constants
     # @type [Number] windows_code_sign_azure_app_secret_format
     attr_accessor :windows_code_sign_azure_app_secret_format
 

data/lib/comet/models/bucket_properties.rb

@@ -15,9 +15,11 @@ module Comet
     # @type [String] organization_id
     attr_accessor :organization_id
 
+    # Unix timestamp, in seconds.
     # @type [Number] create_time
     attr_accessor :create_time
 
+    # One of the PASSWORD_FORMAT_ constants
     # @type [Number] read_write_key_format
     attr_accessor :read_write_key_format
 

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_stats.rb

@@ -12,12 +12,17 @@ module Comet
   # ConstellationStats is a typed class wrapper around the underlying Comet Server API data structure.
   class ConstellationStats
 
+    # Unix timestamp, in seconds.
     # @type [Number] last_check_start
     attr_accessor :last_check_start
 
+    # The total number of Constellation bucket report scans that have been performed since this Comet
+    # Server was last restarted
     # @type [Number] total_checks_started
     attr_accessor :total_checks_started
 
+    # The total number of buckets that Constellation has successfully deleted since this Comet Server
+    # was last restarted
     # @type [Number] total_buckets_deleted
     attr_accessor :total_buckets_deleted
 

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/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,9 +15,11 @@ 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
 
@@ -33,9 +35,11 @@ module Comet
     # @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
 
@@ -82,6 +86,7 @@ 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
 
@@ -89,15 +94,21 @@ module Comet
     # @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
 
@@ -110,19 +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
 
-    # One of the FTPS_MODE_ constants.
+    # 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
 
@@ -148,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
 
@@ -166,9 +186,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
 
@@ -195,6 +226,9 @@ module Comet
     # @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
 

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
 
@@ -61,6 +66,7 @@ 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
 
@@ -68,15 +74,21 @@ module Comet
     # @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
 
@@ -89,19 +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
 
-    # One of the FTPS_MODE_ constants.
+    # 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
 
@@ -127,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
 
@@ -145,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