Class: Comet::PSAConfig

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PSAConfig

Returns a new instance of PSAConfig.



41
42
43
 
# File 'lib/comet/models/psaconfig.rb', line 41

def initialize
  clear
end

Instance Attribute Details

#alerts_disabled ⇒ Object

For PSA_TYPE_GRADIENT. Defaults to enabled



17
18
19
 
# File 'lib/comet/models/psaconfig.rb', line 17

def alerts_disabled
  @alerts_disabled
end

#custom_headers ⇒ Object

Custom headers to send with each PSA request



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

def custom_headers
  @custom_headers
end

#grouped_by ⇒ Object

Returns the value of attribute grouped_by.



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

def grouped_by
  @grouped_by
end

#partner_key ⇒ Object

Specified API key for the target PSA



25
26
27
 
# File 'lib/comet/models/psaconfig.rb', line 25

def partner_key
  @partner_key
end

#type ⇒ Object

One of the PSA_TYPE_ constants



29
30
31
 
# File 'lib/comet/models/psaconfig.rb', line 29

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#url ⇒ Object

The URL or subdomain for outbound PSA requests



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

def url
  @url
end

Instance Method Details

#clear ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'lib/comet/models/psaconfig.rb', line 45

def clear
  @custom_headers = {}
  @partner_key = ''
  @type = 0
  @url = ''
  @grouped_by = Comet::PSAGroupedBy.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


62
63
64
65
66
67
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
 
# File 'lib/comet/models/psaconfig.rb', line 62

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 'AlertsDisabled'
      @alerts_disabled = v
    when 'CustomHeaders'
      @custom_headers = {}
      if v.nil?
        @custom_headers = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @custom_headers[k1] = v1
        end
      end
    when 'PartnerKey'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

      @url = v
    when 'GroupedBy'
      @grouped_by = Comet::PSAGroupedBy.new
      @grouped_by.from_hash(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) 


55
56
57
58
59
 
# File 'lib/comet/models/psaconfig.rb', line 55

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



121
122
123
 
# File 'lib/comet/models/psaconfig.rb', line 121

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/comet/models/psaconfig.rb', line 102

def to_hash
  ret = {}
  ret['AlertsDisabled'] = @alerts_disabled
  unless @custom_headers.nil?
    ret['CustomHeaders'] = @custom_headers
  end
  unless @partner_key.nil?
    ret['PartnerKey'] = @partner_key
  end
  ret['Type'] = @type
  ret['URL'] = @url
  ret['GroupedBy'] = @grouped_by
  @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



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

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