comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/backup_job_detail.rb

@@ -0,0 +1,328 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # BackupJobDetail is a typed class wrapper around the underlying Comet Server API data structure.
+  class BackupJobDetail
+
+    # @type [String] guid
+    attr_accessor :guid
+
+    # @type [String] username
+    attr_accessor :username
+
+    # @type [Number] classification
+    attr_accessor :classification
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [Number] start_time
+    attr_accessor :start_time
+
+    # @type [Number] end_time
+    attr_accessor :end_time
+
+    # @type [String] source_guid
+    attr_accessor :source_guid
+
+    # @type [String] destination_guid
+    attr_accessor :destination_guid
+
+    # @type [String] device_id
+    attr_accessor :device_id
+
+    # @type [String] snapshot_id
+    attr_accessor :snapshot_id
+
+    # @type [String] client_version
+    attr_accessor :client_version
+
+    # @type [Number] total_directories
+    attr_accessor :total_directories
+
+    # @type [Number] total_files
+    attr_accessor :total_files
+
+    # @type [Number] total_size
+    attr_accessor :total_size
+
+    # @type [Number] total_chunks
+    attr_accessor :total_chunks
+
+    # @type [Number] upload_size
+    attr_accessor :upload_size
+
+    # @type [Number] download_size
+    attr_accessor :download_size
+
+    # @type [Number] total_vm_count
+    attr_accessor :total_vm_count
+
+    # @type [Number] total_mails_count
+    attr_accessor :total_mails_count
+
+    # @type [Number] total_sites_count
+    attr_accessor :total_sites_count
+
+    # @type [Number] total_accounts_count
+    attr_accessor :total_accounts_count
+
+    # @type [Number] total_licensed_mails_count
+    attr_accessor :total_licensed_mails_count
+
+    # @type [Number] total_unlicensed_mails_count
+    attr_accessor :total_unlicensed_mails_count
+
+    # @type [String] cancellation_id
+    attr_accessor :cancellation_id
+
+    # @type [Comet::BackupJobProgress] progress
+    attr_accessor :progress
+
+    # @type [Comet::SizeMeasurement] destination_size_start
+    attr_accessor :destination_size_start
+
+    # @type [Comet::SizeMeasurement] destination_size_end
+    attr_accessor :destination_size_end
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @guid = ''
+      @username = ''
+      @classification = 0
+      @status = 0
+      @start_time = 0
+      @end_time = 0
+      @source_guid = ''
+      @destination_guid = ''
+      @device_id = ''
+      @snapshot_id = ''
+      @client_version = ''
+      @total_directories = 0
+      @total_files = 0
+      @total_size = 0
+      @total_chunks = 0
+      @upload_size = 0
+      @download_size = 0
+      @total_vm_count = 0
+      @total_mails_count = 0
+      @total_sites_count = 0
+      @total_accounts_count = 0
+      @total_licensed_mails_count = 0
+      @total_unlicensed_mails_count = 0
+      @cancellation_id = ''
+      @progress = Comet::BackupJobProgress.new
+      @destination_size_start = Comet::SizeMeasurement.new
+      @destination_size_end = Comet::SizeMeasurement.new
+      @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 'GUID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @guid = v
+        when 'Username'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @username = v
+        when 'Classification'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @classification = v
+        when 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'StartTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @start_time = v
+        when 'EndTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @end_time = v
+        when 'SourceGUID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @source_guid = v
+        when 'DestinationGUID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @destination_guid = v
+        when 'DeviceID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @device_id = v
+        when 'SnapshotID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @snapshot_id = v
+        when 'ClientVersion'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @client_version = v
+        when 'TotalDirectories'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_directories = v
+        when 'TotalFiles'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_files = v
+        when 'TotalSize'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_size = v
+        when 'TotalChunks'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_chunks = v
+        when 'UploadSize'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @upload_size = v
+        when 'DownloadSize'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @download_size = v
+        when 'TotalVmCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_vm_count = v
+        when 'TotalMailsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_mails_count = v
+        when 'TotalSitesCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_sites_count = v
+        when 'TotalAccountsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_accounts_count = v
+        when 'TotalLicensedMailsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_licensed_mails_count = v
+        when 'TotalUnlicensedMailsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_unlicensed_mails_count = v
+        when 'CancellationID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @cancellation_id = v
+        when 'Progress'
+          @progress = Comet::BackupJobProgress.new
+          @progress.from_hash(v)
+        when 'DestinationSizeStart'
+          @destination_size_start = Comet::SizeMeasurement.new
+          @destination_size_start.from_hash(v)
+        when 'DestinationSizeEnd'
+          @destination_size_end = Comet::SizeMeasurement.new
+          @destination_size_end.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['GUID'] = @guid
+      ret['Username'] = @username
+      ret['Classification'] = @classification
+      ret['Status'] = @status
+      ret['StartTime'] = @start_time
+      ret['EndTime'] = @end_time
+      ret['SourceGUID'] = @source_guid
+      ret['DestinationGUID'] = @destination_guid
+      ret['DeviceID'] = @device_id
+      unless @snapshot_id.nil?
+        ret['SnapshotID'] = @snapshot_id
+      end
+      ret['ClientVersion'] = @client_version
+      ret['TotalDirectories'] = @total_directories
+      ret['TotalFiles'] = @total_files
+      ret['TotalSize'] = @total_size
+      ret['TotalChunks'] = @total_chunks
+      ret['UploadSize'] = @upload_size
+      ret['DownloadSize'] = @download_size
+      unless @total_vm_count.nil?
+        ret['TotalVmCount'] = @total_vm_count
+      end
+      unless @total_mails_count.nil?
+        ret['TotalMailsCount'] = @total_mails_count
+      end
+      unless @total_sites_count.nil?
+        ret['TotalSitesCount'] = @total_sites_count
+      end
+      unless @total_accounts_count.nil?
+        ret['TotalAccountsCount'] = @total_accounts_count
+      end
+      unless @total_licensed_mails_count.nil?
+        ret['TotalLicensedMailsCount'] = @total_licensed_mails_count
+      end
+      unless @total_unlicensed_mails_count.nil?
+        ret['TotalUnlicensedMailsCount'] = @total_unlicensed_mails_count
+      end
+      unless @cancellation_id.nil?
+        ret['CancellationID'] = @cancellation_id
+      end
+      unless @progress.nil?
+        ret['Progress'] = @progress
+      end
+      unless @destination_size_start.nil?
+        ret['DestinationSizeStart'] = @destination_size_start
+      end
+      unless @destination_size_end.nil?
+        ret['DestinationSizeEnd'] = @destination_size_end
+      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/models/backup_job_progress.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # BackupJobProgress is a typed class wrapper around the underlying Comet Server API data structure.
+  class BackupJobProgress
+
+    # @type [Number] counter
+    attr_accessor :counter
+
+    # @type [Number] sent_time
+    attr_accessor :sent_time
+
+    # @type [Number] recieved_time
+    attr_accessor :recieved_time
+
+    # @type [Number] bytes_done
+    attr_accessor :bytes_done
+
+    # @type [Number] items_done
+    attr_accessor :items_done
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @counter = 0
+      @sent_time = 0
+      @recieved_time = 0
+      @bytes_done = 0
+      @items_done = 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 'Counter'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @counter = v
+        when 'SentTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @sent_time = v
+        when 'RecievedTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @recieved_time = v
+        when 'BytesDone'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @bytes_done = v
+        when 'ItemsDone'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @items_done = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Counter'] = @counter
+      ret['SentTime'] = @sent_time
+      ret['RecievedTime'] = @recieved_time
+      ret['BytesDone'] = @bytes_done
+      ret['ItemsDone'] = @items_done
+      @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/models/backup_rule_config.rb

@@ -0,0 +1,233 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # BackupRuleConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class BackupRuleConfig
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [Number] create_time
+    attr_accessor :create_time
+
+    # @type [Number] modify_time
+    attr_accessor :modify_time
+
+    # @type [Array<String>] pre_exec
+    attr_accessor :pre_exec
+
+    # @type [Array<String>] thaw_exec
+    attr_accessor :thaw_exec
+
+    # @type [Array<String>] post_exec
+    attr_accessor :post_exec
+
+    # @type [String] source
+    attr_accessor :source
+
+    # @type [String] destination
+    attr_accessor :destination
+
+    # @type [Boolean] skip_already_running
+    attr_accessor :skip_already_running
+
+    # @type [Number] stop_after
+    attr_accessor :stop_after
+
+    # @type [Number] limit_vault_speed_bps
+    attr_accessor :limit_vault_speed_bps
+
+    # @type [Boolean] reduce_disk_concurrency
+    attr_accessor :reduce_disk_concurrency
+
+    # @type [Boolean] use_on_disk_indexes
+    attr_accessor :use_on_disk_indexes
+
+    # @type [Boolean] allow_zero_files_success
+    attr_accessor :allow_zero_files_success
+
+    # @type [Number] auto_retention_level
+    attr_accessor :auto_retention_level
+
+    # @type [Array<Comet::ScheduleConfig>] schedules
+    attr_accessor :schedules
+
+    # @type [Comet::BackupRuleEventTriggers] event_triggers
+    attr_accessor :event_triggers
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @description = ''
+      @create_time = 0
+      @modify_time = 0
+      @pre_exec = []
+      @thaw_exec = []
+      @post_exec = []
+      @source = ''
+      @destination = ''
+      @stop_after = 0
+      @limit_vault_speed_bps = 0
+      @auto_retention_level = 0
+      @schedules = []
+      @event_triggers = Comet::BackupRuleEventTriggers.new
+      @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 'Description'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @description = v
+        when 'CreateTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @create_time = v
+        when 'ModifyTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @modify_time = v
+        when 'PreExec'
+          if v.nil?
+            @pre_exec = []
+          else
+            @pre_exec = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @pre_exec[i1] = v1
+            end
+          end
+        when 'ThawExec'
+          if v.nil?
+            @thaw_exec = []
+          else
+            @thaw_exec = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @thaw_exec[i1] = v1
+            end
+          end
+        when 'PostExec'
+          if v.nil?
+            @post_exec = []
+          else
+            @post_exec = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @post_exec[i1] = v1
+            end
+          end
+        when 'Source'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @source = v
+        when 'Destination'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @destination = v
+        when 'SkipAlreadyRunning'
+          @skip_already_running = v
+        when 'StopAfter'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @stop_after = v
+        when 'LimitVaultSpeedBps'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @limit_vault_speed_bps = v
+        when 'ReduceDiskConcurrency'
+          @reduce_disk_concurrency = v
+        when 'UseOnDiskIndexes'
+          @use_on_disk_indexes = v
+        when 'AllowZeroFilesSuccess'
+          @allow_zero_files_success = v
+        when 'AutoRetentionLevel'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @auto_retention_level = v
+        when 'Schedules'
+          if v.nil?
+            @schedules = []
+          else
+            @schedules = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @schedules[i1] = Comet::ScheduleConfig.new
+              @schedules[i1].from_hash(v1)
+            end
+          end
+        when 'EventTriggers'
+          @event_triggers = Comet::BackupRuleEventTriggers.new
+          @event_triggers.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Description'] = @description
+      ret['CreateTime'] = @create_time
+      ret['ModifyTime'] = @modify_time
+      ret['PreExec'] = @pre_exec
+      ret['ThawExec'] = @thaw_exec
+      ret['PostExec'] = @post_exec
+      ret['Source'] = @source
+      ret['Destination'] = @destination
+      ret['SkipAlreadyRunning'] = @skip_already_running
+      ret['StopAfter'] = @stop_after
+      ret['LimitVaultSpeedBps'] = @limit_vault_speed_bps
+      ret['ReduceDiskConcurrency'] = @reduce_disk_concurrency
+      ret['UseOnDiskIndexes'] = @use_on_disk_indexes
+      ret['AllowZeroFilesSuccess'] = @allow_zero_files_success
+      ret['AutoRetentionLevel'] = @auto_retention_level
+      ret['Schedules'] = @schedules
+      ret['EventTriggers'] = @event_triggers
+      @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