comet_backup_ruby_sdk 1.13.0 → 1.14.0

data/lib/models/s3destination_location.rb

@@ -0,0 +1,123 @@
+#!/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
+
+  # S3DestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  class S3DestinationLocation
+
+    # @type [String] s3server
+    attr_accessor :s3server
+
+    # @type [Boolean] s3uses_tls
+    attr_accessor :s3uses_tls
+
+    # @type [String] s3access_key
+    attr_accessor :s3access_key
+
+    # @type [String] s3secret_key
+    attr_accessor :s3secret_key
+
+    # @type [String] s3bucket_name
+    attr_accessor :s3bucket_name
+
+    # @type [String] s3subdir
+    attr_accessor :s3subdir
+
+    # @type [Boolean] s3uses_v2signing
+    attr_accessor :s3uses_v2signing
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @s3server = ''
+      @s3access_key = ''
+      @s3secret_key = ''
+      @s3bucket_name = ''
+      @s3subdir = ''
+      @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 'S3Server'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3server = v
+        when 'S3UsesTLS'
+          @s3uses_tls = v
+        when 'S3AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3access_key = v
+        when 'S3SecretKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3secret_key = v
+        when 'S3BucketName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3bucket_name = v
+        when 'S3Subdir'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3subdir = v
+        when 'S3UsesV2Signing'
+          @s3uses_v2signing = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['S3Server'] = @s3server
+      ret['S3UsesTLS'] = @s3uses_tls
+      ret['S3AccessKey'] = @s3access_key
+      ret['S3SecretKey'] = @s3secret_key
+      ret['S3BucketName'] = @s3bucket_name
+      ret['S3Subdir'] = @s3subdir
+      ret['S3UsesV2Signing'] = @s3uses_v2signing
+      @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/s3generic_virtual_storage_role.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
+
+  # S3GenericVirtualStorageRole is a typed class wrapper around the underlying Comet Server API data structure.
+  class S3GenericVirtualStorageRole
+
+    # @type [String] s3endpoint
+    attr_accessor :s3endpoint
+
+    # @type [String] iamendpoint
+    attr_accessor :iamendpoint
+
+    # @type [String] master_bucket
+    attr_accessor :master_bucket
+
+    # @type [String] access_key
+    attr_accessor :access_key
+
+    # @type [String] secret_key
+    attr_accessor :secret_key
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @s3endpoint = ''
+      @iamendpoint = ''
+      @master_bucket = ''
+      @access_key = ''
+      @secret_key = ''
+      @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 'S3Endpoint'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @s3endpoint = v
+        when 'IAMEndpoint'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @iamendpoint = v
+        when 'MasterBucket'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @master_bucket = v
+        when 'AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @access_key = v
+        when 'SecretKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @secret_key = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['S3Endpoint'] = @s3endpoint
+      ret['IAMEndpoint'] = @iamendpoint
+      ret['MasterBucket'] = @master_bucket
+      ret['AccessKey'] = @access_key
+      ret['SecretKey'] = @secret_key
+      @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/schedule_config.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
+
+  # ScheduleConfig is a typed class wrapper around the underlying Comet Server API data structure.
+  class ScheduleConfig
+
+    # @type [Number] frequency_type
+    attr_accessor :frequency_type
+
+    # @type [Number] seconds_past
+    attr_accessor :seconds_past
+
+    # @type [Number] offset
+    attr_accessor :offset
+
+    # @type [Boolean] restrict_runtime
+    attr_accessor :restrict_runtime
+
+    # @type [Comet::HourSchedConfig] from_time
+    attr_accessor :from_time
+
+    # @type [Comet::HourSchedConfig] to_time
+    attr_accessor :to_time
+
+    # @type [Boolean] restrict_days
+    attr_accessor :restrict_days
+
+    # @type [Comet::DaysOfWeekConfig] days_select
+    attr_accessor :days_select
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @frequency_type = 0
+      @seconds_past = 0
+      @offset = 0
+      @from_time = Comet::HourSchedConfig.new
+      @to_time = Comet::HourSchedConfig.new
+      @days_select = Comet::DaysOfWeekConfig.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 'FrequencyType'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @frequency_type = v
+        when 'SecondsPast'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @seconds_past = v
+        when 'Offset'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @offset = v
+        when 'RestrictRuntime'
+          @restrict_runtime = v
+        when 'FromTime'
+          @from_time = Comet::HourSchedConfig.new
+          @from_time.from_hash(v)
+        when 'ToTime'
+          @to_time = Comet::HourSchedConfig.new
+          @to_time.from_hash(v)
+        when 'RestrictDays'
+          @restrict_days = v
+        when 'DaysSelect'
+          @days_select = Comet::DaysOfWeekConfig.new
+          @days_select.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['FrequencyType'] = @frequency_type
+      ret['SecondsPast'] = @seconds_past
+      unless @offset.nil?
+        ret['Offset'] = @offset
+      end
+      ret['RestrictRuntime'] = @restrict_runtime
+      ret['FromTime'] = @from_time
+      ret['ToTime'] = @to_time
+      ret['RestrictDays'] = @restrict_days
+      ret['DaysSelect'] = @days_select
+      @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/search_clause.rb

@@ -0,0 +1,119 @@
+#!/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
+
+  # SearchClause is a typed class wrapper around the underlying Comet Server API data structure.
+  class SearchClause
+
+    # @type [String] clause_type
+    attr_accessor :clause_type
+
+    # @type [String] rule_field
+    attr_accessor :rule_field
+
+    # @type [String] rule_operator
+    attr_accessor :rule_operator
+
+    # @type [String] rule_value
+    attr_accessor :rule_value
+
+    # @type [Array<Comet::SearchClause>] clause_children
+    attr_accessor :clause_children
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @clause_type = ''
+      @rule_field = ''
+      @rule_operator = ''
+      @rule_value = ''
+      @clause_children = []
+      @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 'ClauseType'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @clause_type = v
+        when 'RuleField'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @rule_field = v
+        when 'RuleOperator'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @rule_operator = v
+        when 'RuleValue'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @rule_value = v
+        when 'ClauseChildren'
+          if v.nil?
+            @clause_children = []
+          else
+            @clause_children = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @clause_children[i1] = Comet::SearchClause.new
+              @clause_children[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['ClauseType'] = @clause_type
+      ret['RuleField'] = @rule_field
+      ret['RuleOperator'] = @rule_operator
+      ret['RuleValue'] = @rule_value
+      unless @clause_children.nil?
+        ret['ClauseChildren'] = @clause_children
+      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/self_backup_statistics.rb

@@ -0,0 +1,108 @@
+#!/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
+
+  # SelfBackupStatistics is a typed class wrapper around the underlying Comet Server API data structure.
+  class SelfBackupStatistics
+
+    # @type [Number] current_run_start
+    attr_accessor :current_run_start
+
+    # @type [Number] last_run_start
+    attr_accessor :last_run_start
+
+    # @type [Number] last_run_end
+    attr_accessor :last_run_end
+
+    # @type [Boolean] last_run_success
+    attr_accessor :last_run_success
+
+    # @type [Number] last_run_size
+    attr_accessor :last_run_size
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @current_run_start = 0
+      @last_run_start = 0
+      @last_run_end = 0
+      @last_run_size = 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 'CurrentRunStart'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @current_run_start = v
+        when 'LastRunStart'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @last_run_start = v
+        when 'LastRunEnd'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @last_run_end = v
+        when 'LastRunSuccess'
+          @last_run_success = v
+        when 'LastRunSize'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @last_run_size = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['CurrentRunStart'] = @current_run_start
+      ret['LastRunStart'] = @last_run_start
+      ret['LastRunEnd'] = @last_run_end
+      ret['LastRunSuccess'] = @last_run_success
+      ret['LastRunSize'] = @last_run_size
+      @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/server_config_options_branding_fragment.rb

@@ -0,0 +1,74 @@
+#!/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
+
+  # ServerConfigOptionsBrandingFragment is a typed class wrapper around the underlying Comet Server API data structure.
+  class ServerConfigOptionsBrandingFragment
+
+    # @type [Comet::BrandingOptions] branding
+    attr_accessor :branding
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @branding = Comet::BrandingOptions.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 'Branding'
+          @branding = Comet::BrandingOptions.new
+          @branding.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['Branding'] = @branding
+      @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