Class: Comet::ServerMetaBrandingProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/server_meta_branding_properties.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ServerMetaBrandingProperties

Returns a new instance of ServerMetaBrandingProperties.



47
48
49
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 47

def initialize
  clear
end

Instance Attribute Details

#allow_authenticated_downloads ⇒ Object

Returns the value of attribute allow_authenticated_downloads.



36
37
38
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 36

def allow_authenticated_downloads
  @allow_authenticated_downloads
end

#allow_unauthenticated_downloads ⇒ Object

Returns the value of attribute allow_unauthenticated_downloads.



33
34
35
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 33

def allow_unauthenticated_downloads
  @allow_unauthenticated_downloads
end

#brand_name ⇒ Object

Returns the value of attribute brand_name.



18
19
20
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 18

def brand_name
  @brand_name
end

#expired_in_seconds ⇒ Object

Returns the value of attribute expired_in_seconds.



42
43
44
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 42

def expired_in_seconds
  @expired_in_seconds
end

#has_image ⇒ Object

Returns the value of attribute has_image.



24
25
26
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 24

def has_image
  @has_image
end

#hide_news_area ⇒ Object

Returns the value of attribute hide_news_area.



30
31
32
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 30

def hide_news_area
  @hide_news_area
end

#product_name ⇒ Object

Returns the value of attribute product_name.



21
22
23
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 21

def product_name
  @product_name
end

#prune_logs_after_days ⇒ Object

Returns the value of attribute prune_logs_after_days.



39
40
41
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 39

def prune_logs_after_days
  @prune_logs_after_days
end

#top_color ⇒ Object

Returns the value of attribute top_color.



27
28
29
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 27

def top_color
  @top_color
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



45
46
47
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 45

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 51

def clear
  @brand_name = ''
  @product_name = ''
  @top_color = ''
  @prune_logs_after_days = 0
  @expired_in_seconds = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 68

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 'BrandName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @brand_name = v
    when 'ProductName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @product_name = v
    when 'HasImage'
      @has_image = v
    when 'TopColor'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @top_color = v
    when 'HideNewsArea'
      @hide_news_area = v
    when 'AllowUnauthenticatedDownloads'
      @allow_unauthenticated_downloads = v
    when 'AllowAuthenticatedDownloads'
      @allow_authenticated_downloads = v
    when 'PruneLogsAfterDays'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @prune_logs_after_days = v
    when 'ExpiredInSeconds'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @expired_in_seconds = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


61
62
63
64
65
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 61

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

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



126
127
128
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 126

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 108

def to_hash
  ret = {}
  ret['BrandName'] = @brand_name
  ret['ProductName'] = @product_name
  ret['HasImage'] = @has_image
  ret['TopColor'] = @top_color
  ret['HideNewsArea'] = @hide_news_area
  ret['AllowUnauthenticatedDownloads'] = @allow_unauthenticated_downloads
  ret['AllowAuthenticatedDownloads'] = @allow_authenticated_downloads
  ret['PruneLogsAfterDays'] = @prune_logs_after_days
  ret['ExpiredInSeconds'] = @expired_in_seconds
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



131
132
133
 
# File 'lib/comet/models/server_meta_branding_properties.rb', line 131

def to_json(options = {})
  to_hash.to_json(options)
end