class Comet::SelfBackupExportOptions

SelfBackupExportOptions is a typed class wrapper around the underlying Comet Server API data structure.

def clear

def clear
  @location = Comet::DestinationLocation.new
  @encryption_key = ''
  @encryption_key_format = 0
  @compression = 0
  @restrict_to_single_org_id = ''
  @index = 0
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- 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 'Location'
      @location = Comet::DestinationLocation.new
      @location.from_hash(v)
    when 'EncryptionKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @encryption_key = v
    when 'EncryptionKeyFormat'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @encryption_key_format = v
    when 'Compression'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @compression = v
    when 'ExcludeJobsDB'
      @exclude_jobs_db = v
    when 'IncludeServerLogs'
      @include_server_logs = v
    when 'RestrictToSingleOrgID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @restrict_to_single_org_id = v
    when 'Index'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @index = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

def from_json(json_string)

Parameters:
  • json_string (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

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_hash
  ret = {}
  ret['Location'] = @location
  ret['EncryptionKey'] = @encryption_key
  ret['EncryptionKeyFormat'] = @encryption_key_format
  ret['Compression'] = @compression
  ret['ExcludeJobsDB'] = @exclude_jobs_db
  ret['IncludeServerLogs'] = @include_server_logs
  unless @restrict_to_single_org_id.nil?
    ret['RestrictToSingleOrgID'] = @restrict_to_single_org_id
  end
  ret['Index'] = @index
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end