comet_backup_ruby_sdk 1.11.0 → 1.14.0

data/lib/models/replicator_state_apiresponse.rb

@@ -0,0 +1,174 @@
+#!/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
+
+  # ReplicatorStateAPIResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class ReplicatorStateAPIResponse
+
+    # @type [String] description
+    attr_accessor :description
+
+    # @type [String] remote_server_id
+    attr_accessor :remote_server_id
+
+    # @type [Number] display_class
+    attr_accessor :display_class
+
+    # @type [Number] active_workers
+    attr_accessor :active_workers
+
+    # @type [Number] total_workers
+    attr_accessor :total_workers
+
+    # @type [Number] state
+    attr_accessor :state
+
+    # @type [Number] items_queued
+    attr_accessor :items_queued
+
+    # @type [Number] bytes_queued
+    attr_accessor :bytes_queued
+
+    # @type [Number] last_worker_submit_time
+    attr_accessor :last_worker_submit_time
+
+    # @type [Number] current_time
+    attr_accessor :current_time
+
+    # @type [Number] items_replicated
+    attr_accessor :items_replicated
+
+    # @type [Number] bytes_replicated
+    attr_accessor :bytes_replicated
+
+    # @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 = ''
+      @remote_server_id = ''
+      @display_class = 0
+      @active_workers = 0
+      @total_workers = 0
+      @state = 0
+      @items_queued = 0
+      @bytes_queued = 0
+      @last_worker_submit_time = 0
+      @current_time = 0
+      @items_replicated = 0
+      @bytes_replicated = 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 'Description'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @description = v
+        when 'RemoteServerID'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @remote_server_id = v
+        when 'DisplayClass'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @display_class = v
+        when 'ActiveWorkers'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @active_workers = v
+        when 'TotalWorkers'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_workers = v
+        when 'State'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @state = v
+        when 'ItemsQueued'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @items_queued = v
+        when 'BytesQueued'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @bytes_queued = v
+        when 'LastWorkerSubmitTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @last_worker_submit_time = v
+        when 'CurrentTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @current_time = v
+        when 'ItemsReplicated'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @items_replicated = v
+        when 'BytesReplicated'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @bytes_replicated = 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['RemoteServerID'] = @remote_server_id
+      ret['DisplayClass'] = @display_class
+      ret['ActiveWorkers'] = @active_workers
+      ret['TotalWorkers'] = @total_workers
+      ret['State'] = @state
+      ret['ItemsQueued'] = @items_queued
+      ret['BytesQueued'] = @bytes_queued
+      ret['LastWorkerSubmitTime'] = @last_worker_submit_time
+      ret['CurrentTime'] = @current_time
+      ret['ItemsReplicated'] = @items_replicated
+      ret['BytesReplicated'] = @bytes_replicated
+      @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/request_storage_vault_response_message.rb

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

@@ -0,0 +1,131 @@
+#!/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
+
+  # RestoreJobAdvancedOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class RestoreJobAdvancedOptions
+
+    # @type [Number] type
+    attr_accessor :type
+
+    # @type [Boolean] overwrite_existing_files
+    attr_accessor :overwrite_existing_files
+
+    # @type [Boolean] dest_is_original_location
+    attr_accessor :dest_is_original_location
+
+    # @type [String] dest_path
+    attr_accessor :dest_path
+
+    # @type [Array<String>] exact_dest_paths
+    attr_accessor :exact_dest_paths
+
+    # @type [Number] archive_format
+    attr_accessor :archive_format
+
+    # @type [Comet::Office365Credential] office_365credential
+    attr_accessor :office_365credential
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @type = 0
+      @dest_path = ''
+      @exact_dest_paths = []
+      @archive_format = 0
+      @office_365credential = Comet::Office365Credential.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 'Type'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @type = v
+        when 'OverwriteExistingFiles'
+          @overwrite_existing_files = v
+        when 'DestIsOriginalLocation'
+          @dest_is_original_location = v
+        when 'DestPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @dest_path = v
+        when 'ExactDestPaths'
+          if v.nil?
+            @exact_dest_paths = []
+          else
+            @exact_dest_paths = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
+
+              @exact_dest_paths[i1] = v1
+            end
+          end
+        when 'ArchiveFormat'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @archive_format = v
+        when 'Office365Credential'
+          @office_365credential = Comet::Office365Credential.new
+          @office_365credential.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['Type'] = @type
+      ret['OverwriteExistingFiles'] = @overwrite_existing_files
+      ret['DestIsOriginalLocation'] = @dest_is_original_location
+      ret['DestPath'] = @dest_path
+      ret['ExactDestPaths'] = @exact_dest_paths
+      ret['ArchiveFormat'] = @archive_format
+      unless @office_365credential.nil?
+        ret['Office365Credential'] = @office_365credential
+      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/retention_policy.rb

@@ -0,0 +1,90 @@
+#!/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
+
+  # RetentionPolicy is a typed class wrapper around the underlying Comet Server API data structure.
+  class RetentionPolicy
+
+    # @type [Number] mode
+    attr_accessor :mode
+
+    # @type [Array<Comet::RetentionRange>] ranges
+    attr_accessor :ranges
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @mode = 0
+      @ranges = []
+      @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 'Mode'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @mode = v
+        when 'Ranges'
+          if v.nil?
+            @ranges = []
+          else
+            @ranges = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @ranges[i1] = Comet::RetentionRange.new
+              @ranges[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['Mode'] = @mode
+      ret['Ranges'] = @ranges
+      @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/retention_range.rb

@@ -0,0 +1,138 @@
+#!/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
+
+  # RetentionRange is a typed class wrapper around the underlying Comet Server API data structure.
+  class RetentionRange
+
+    # @type [Number] type
+    attr_accessor :type
+
+    # @type [Number] timestamp
+    attr_accessor :timestamp
+
+    # @type [Number] jobs
+    attr_accessor :jobs
+
+    # @type [Number] days
+    attr_accessor :days
+
+    # @type [Number] weeks
+    attr_accessor :weeks
+
+    # @type [Number] months
+    attr_accessor :months
+
+    # @type [Number] week_offset
+    attr_accessor :week_offset
+
+    # @type [Number] month_offset
+    attr_accessor :month_offset
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @type = 0
+      @timestamp = 0
+      @jobs = 0
+      @days = 0
+      @weeks = 0
+      @months = 0
+      @week_offset = 0
+      @month_offset = 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 'Type'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @type = v
+        when 'Timestamp'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @timestamp = v
+        when 'Jobs'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @jobs = v
+        when 'Days'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @days = v
+        when 'Weeks'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @weeks = v
+        when 'Months'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @months = v
+        when 'WeekOffset'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @week_offset = v
+        when 'MonthOffset'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @month_offset = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Type'] = @type
+      ret['Timestamp'] = @timestamp
+      ret['Jobs'] = @jobs
+      ret['Days'] = @days
+      ret['Weeks'] = @weeks
+      ret['Months'] = @months
+      ret['WeekOffset'] = @week_offset
+      ret['MonthOffset'] = @month_offset
+      @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