comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/source_config.rb

@@ -0,0 +1,202 @@
+#!/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
+
+  # SourceConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class SourceConfig
+
+    # @type [String] engine
+    attr_accessor :engine
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [String] owner_device
+    attr_accessor :owner_device
+
+    # @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 [Hash{String => String}] engine_props
+    attr_accessor :engine_props
+
+    # @type [Hash{String => Comet::RetentionPolicy}] override_destination_retention
+    attr_accessor :override_destination_retention
+
+    # @type [Comet::SourceStatistics] statistics
+    attr_accessor :statistics
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @engine = ''
+      @description = ''
+      @owner_device = ''
+      @create_time = 0
+      @modify_time = 0
+      @pre_exec = []
+      @thaw_exec = []
+      @post_exec = []
+      @engine_props = {}
+      @override_destination_retention = {}
+      @statistics = Comet::SourceStatistics.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 'Engine'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @engine = v
+        when 'Description'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @description = v
+        when 'OwnerDevice'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @owner_device = 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 'EngineProps'
+          @engine_props = {}
+          if v.nil?
+            @engine_props = {}
+          else
+            v.each do |k1, v1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @engine_props[k1] = v1
+            end
+          end
+        when 'OverrideDestinationRetention'
+          @override_destination_retention = {}
+          if v.nil?
+            @override_destination_retention = {}
+          else
+            v.each do |k1, v1|
+              @override_destination_retention[k1] = Comet::RetentionPolicy.new
+              @override_destination_retention[k1].from_hash(v1)
+            end
+          end
+        when 'Statistics'
+          @statistics = Comet::SourceStatistics.new
+          @statistics.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['Engine'] = @engine
+      ret['Description'] = @description
+      ret['OwnerDevice'] = @owner_device
+      ret['CreateTime'] = @create_time
+      ret['ModifyTime'] = @modify_time
+      ret['PreExec'] = @pre_exec
+      ret['ThawExec'] = @thaw_exec
+      ret['PostExec'] = @post_exec
+      ret['EngineProps'] = @engine_props
+      unless @override_destination_retention.nil?
+        ret['OverrideDestinationRetention'] = @override_destination_retention
+      end
+      unless @statistics.nil?
+        ret['Statistics'] = @statistics
+      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/source_include_pattern.rb

@@ -0,0 +1,84 @@
+#!/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
+
+  # SourceIncludePattern is a typed class wrapper around the underlying Comet Server API data structure.
+  class SourceIncludePattern
+
+    # @type [String] top_directory
+    attr_accessor :top_directory
+
+    # @type [String] value
+    attr_accessor :value
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @top_directory = ''
+      @value = ''
+      @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 'TopDirectory'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @top_directory = v
+        when 'Value'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @value = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['TopDirectory'] = @top_directory
+      ret['Value'] = @value
+      @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/source_statistics.rb

@@ -0,0 +1,82 @@
+#!/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
+
+  # SourceStatistics is a typed class wrapper around the underlying Comet Server API data structure.
+  class SourceStatistics
+
+    # @type [Comet::BackupJobDetail] last_backup_job
+    attr_accessor :last_backup_job
+
+    # @type [Comet::BackupJobDetail] last_successful_backup_job
+    attr_accessor :last_successful_backup_job
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @last_backup_job = Comet::BackupJobDetail.new
+      @last_successful_backup_job = Comet::BackupJobDetail.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 'LastBackupJob'
+          @last_backup_job = Comet::BackupJobDetail.new
+          @last_backup_job.from_hash(v)
+        when 'LastSuccessfulBackupJob'
+          @last_successful_backup_job = Comet::BackupJobDetail.new
+          @last_successful_backup_job.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['LastBackupJob'] = @last_backup_job
+      ret['LastSuccessfulBackupJob'] = @last_successful_backup_job
+      @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/spanned_destination_location.rb

@@ -0,0 +1,87 @@
+#!/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
+
+  # SpannedDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  class SpannedDestinationLocation
+
+    # @type [Array<Comet::DestinationLocation>] span_targets
+    attr_accessor :span_targets
+
+    # @type [Boolean] span_use_static_slots
+    attr_accessor :span_use_static_slots
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @span_targets = []
+      @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 'SpanTargets'
+          if v.nil?
+            @span_targets = []
+          else
+            @span_targets = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @span_targets[i1] = Comet::DestinationLocation.new
+              @span_targets[i1].from_hash(v1)
+            end
+          end
+        when 'SpanUseStaticSlots'
+          @span_use_static_slots = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SpanTargets'] = @span_targets
+      ret['SpanUseStaticSlots'] = @span_use_static_slots
+      @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/spanned_storage_extra_info.rb

@@ -0,0 +1,81 @@
+#!/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
+
+  # SpannedStorageExtraInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class SpannedStorageExtraInfo
+
+    # @type [Array<Comet::StorageFreeSpaceInfo>] targets
+    attr_accessor :targets
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @targets = []
+      @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 'Targets'
+          if v.nil?
+            @targets = []
+          else
+            @targets = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @targets[i1] = Comet::StorageFreeSpaceInfo.new
+              @targets[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Targets'] = @targets
+      @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/sshconnection.rb

@@ -0,0 +1,126 @@
+#!/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
+
+  # SSHConnection is a typed class wrapper around the underlying Comet Server API data structure.
+  class SSHConnection
+
+    # @type [String] sshserver
+    attr_accessor :sshserver
+
+    # @type [String] sshusername
+    attr_accessor :sshusername
+
+    # @type [Number] sshauth_mode
+    attr_accessor :sshauth_mode
+
+    # @type [String] sshpassword
+    attr_accessor :sshpassword
+
+    # @type [String] sshprivate_key
+    attr_accessor :sshprivate_key
+
+    # @type [Boolean] sshcustom_auth__use_known_hosts_file
+    attr_accessor :sshcustom_auth__use_known_hosts_file
+
+    # @type [String] sshcustom_auth__known_hosts_file
+    attr_accessor :sshcustom_auth__known_hosts_file
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @sshserver = ''
+      @sshusername = ''
+      @sshauth_mode = 0
+      @sshpassword = ''
+      @sshprivate_key = ''
+      @sshcustom_auth__known_hosts_file = ''
+      @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 'SSHServer'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @sshserver = v
+        when 'SSHUsername'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @sshusername = v
+        when 'SSHAuthMode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @sshauth_mode = v
+        when 'SSHPassword'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @sshpassword = v
+        when 'SSHPrivateKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @sshprivate_key = v
+        when 'SSHCustomAuth_UseKnownHostsFile'
+          @sshcustom_auth__use_known_hosts_file = v
+        when 'SSHCustomAuth_KnownHostsFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @sshcustom_auth__known_hosts_file = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SSHServer'] = @sshserver
+      ret['SSHUsername'] = @sshusername
+      ret['SSHAuthMode'] = @sshauth_mode
+      ret['SSHPassword'] = @sshpassword
+      ret['SSHPrivateKey'] = @sshprivate_key
+      ret['SSHCustomAuth_UseKnownHostsFile'] = @sshcustom_auth__use_known_hosts_file
+      ret['SSHCustomAuth_KnownHostsFile'] = @sshcustom_auth__known_hosts_file
+      @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