Class: Forgejo::CreateHookOption

Inherits:
Object
  • Object
show all
Defined in:
lib/forgejo/models/create_hook_option.rb

Overview

CreateHookOption options when create a hook

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateHookOption

Initializes the object



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/forgejo/models/create_hook_option.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Forgejo::CreateHookOption` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Forgejo::CreateHookOption`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  else
    self.active = false
  end

  if attributes.key?(:'authorization_header')
    self.authorization_header = attributes[:'authorization_header']
  end

  if attributes.key?(:'branch_filter')
    self.branch_filter = attributes[:'branch_filter']
  end

  if attributes.key?(:'config')
    if (value = attributes[:'config']).is_a?(Hash)
      self.config = value
    end
  else
    self.config = nil
  end

  if attributes.key?(:'events')
    if (value = attributes[:'events']).is_a?(Array)
      self.events = value
    end
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



19
20
21
 
# File 'lib/forgejo/models/create_hook_option.rb', line 19

def active
  @active
end

#authorization_header ⇒ Object

Returns the value of attribute authorization_header.



21
22
23
 
# File 'lib/forgejo/models/create_hook_option.rb', line 21

def authorization_header
  @authorization_header
end

#branch_filter ⇒ Object

Returns the value of attribute branch_filter.



23
24
25
 
# File 'lib/forgejo/models/create_hook_option.rb', line 23

def branch_filter
  @branch_filter
end

#config ⇒ Object

CreateHookOptionConfig has all config options in it required are "content_type" and "url" Required



26
27
28
 
# File 'lib/forgejo/models/create_hook_option.rb', line 26

def config
  @config
end

#events ⇒ Object

Returns the value of attribute events.



28
29
30
 
# File 'lib/forgejo/models/create_hook_option.rb', line 28

def events
  @events
end

#type ⇒ Object

Returns the value of attribute type.



30
31
32
 
# File 'lib/forgejo/models/create_hook_option.rb', line 30

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/forgejo/models/create_hook_option.rb', line 244

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Forgejo.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



67
68
69
 
# File 'lib/forgejo/models/create_hook_option.rb', line 67

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/forgejo/models/create_hook_option.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/forgejo/models/create_hook_option.rb', line 55

def self.attribute_map
  {
    :'active' => :'active',
    :'authorization_header' => :'authorization_header',
    :'branch_filter' => :'branch_filter',
    :'config' => :'config',
    :'events' => :'events',
    :'type' => :'type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/forgejo/models/create_hook_option.rb', line 220

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/forgejo/models/create_hook_option.rb', line 89

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/forgejo/models/create_hook_option.rb', line 77

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'authorization_header' => :'String',
    :'branch_filter' => :'String',
    :'config' => :'Hash<String, String>',
    :'events' => :'Array<String>',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/forgejo/models/create_hook_option.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      authorization_header == o.authorization_header &&
      branch_filter == o.branch_filter &&
      config == o.config &&
      events == o.events &&
      type == o.type
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/forgejo/models/create_hook_option.rb', line 315

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


207
208
209
 
# File 'lib/forgejo/models/create_hook_option.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



213
214
215
 
# File 'lib/forgejo/models/create_hook_option.rb', line 213

def hash
  [active, authorization_header, branch_filter, config, events, type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/forgejo/models/create_hook_option.rb', line 147

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @config.nil?
    invalid_properties.push('invalid value for "config", config cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



291
292
293
 
# File 'lib/forgejo/models/create_hook_option.rb', line 291

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/forgejo/models/create_hook_option.rb', line 297

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



285
286
287
 
# File 'lib/forgejo/models/create_hook_option.rb', line 285

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



163
164
165
166
167
168
169
170
 
# File 'lib/forgejo/models/create_hook_option.rb', line 163

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @config.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["forgejo", "dingtalk", "discord", "gitea", "gogs", "msteams", "slack", "telegram", "feishu", "wechatwork", "packagist"])
  return false unless type_validator.valid?(@type)
  true
end