Class: Comet::CustomRemoteBucketSettings

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CustomRemoteBucketSettings

Returns a new instance of CustomRemoteBucketSettings.



32
33
34
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 32

def initialize
  clear
end

Instance Attribute Details

#custom_body ⇒ Object

This field is available in Comet 24.5.0 and later.



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

def custom_body
  @custom_body
end

#custom_body_type ⇒ Object

Returns the value of attribute custom_body_type.



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

def custom_body_type
  @custom_body_type
end

#custom_headers ⇒ Object

This field is available in Comet 23.12.5 and later.



20
21
22
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 20

def custom_headers
  @custom_headers
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#url ⇒ Object

Returns the value of attribute url.



16
17
18
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 16

def url
  @url
end

Instance Method Details

#clear ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 36

def clear
  @url = ''
  @custom_headers = {}
  @custom_body = ''
  @custom_body_type = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 52

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

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

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

      @custom_body_type = 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) 


45
46
47
48
49
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 45

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



100
101
102
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 100

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



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 87

def to_hash
  ret = {}
  ret['URL'] = @url
  ret['CustomHeaders'] = @custom_headers
  ret['CustomBody'] = @custom_body
  ret['CustomBodyType'] = @custom_body_type
  @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



105
106
107
 
# File 'lib/comet/models/custom_remote_bucket_settings.rb', line 105

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