Class: Forgejo::CreateBranchProtectionOption

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

Overview

CreateBranchProtectionOption options for creating a branch protection

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBranchProtectionOption

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 150

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Forgejo::CreateBranchProtectionOption` 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::CreateBranchProtectionOption`. 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?(:'apply_to_admins')
    self.apply_to_admins = attributes[:'apply_to_admins']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#apply_to_admins ⇒ Object

Returns the value of attribute apply_to_admins.



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

def apply_to_admins
  @apply_to_admins
end

#approvals_whitelist_teams ⇒ Object

Returns the value of attribute approvals_whitelist_teams.



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

def approvals_whitelist_teams
  @approvals_whitelist_teams
end

#approvals_whitelist_username ⇒ Object

Returns the value of attribute approvals_whitelist_username.



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

def approvals_whitelist_username
  @approvals_whitelist_username
end

#block_on_official_review_requests ⇒ Object

Returns the value of attribute block_on_official_review_requests.



25
26
27
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 25

def block_on_official_review_requests
  @block_on_official_review_requests
end

#block_on_outdated_branch ⇒ Object

Returns the value of attribute block_on_outdated_branch.



27
28
29
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 27

def block_on_outdated_branch
  @block_on_outdated_branch
end

#block_on_rejected_reviews ⇒ Object

Returns the value of attribute block_on_rejected_reviews.



29
30
31
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 29

def block_on_rejected_reviews
  @block_on_rejected_reviews
end

#branch_name ⇒ Object

Deprecated: true



32
33
34
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 32

def branch_name
  @branch_name
end

#dismiss_stale_approvals ⇒ Object

Returns the value of attribute dismiss_stale_approvals.



34
35
36
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 34

def dismiss_stale_approvals
  @dismiss_stale_approvals
end

#enable_approvals_whitelist ⇒ Object

Returns the value of attribute enable_approvals_whitelist.



36
37
38
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 36

def enable_approvals_whitelist
  @enable_approvals_whitelist
end

#enable_merge_whitelist ⇒ Object

Returns the value of attribute enable_merge_whitelist.



38
39
40
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 38

def enable_merge_whitelist
  @enable_merge_whitelist
end

#enable_push ⇒ Object

Returns the value of attribute enable_push.



40
41
42
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 40

def enable_push
  @enable_push
end

#enable_push_whitelist ⇒ Object

Returns the value of attribute enable_push_whitelist.



42
43
44
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 42

def enable_push_whitelist
  @enable_push_whitelist
end

#enable_status_check ⇒ Object

Returns the value of attribute enable_status_check.



44
45
46
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 44

def enable_status_check
  @enable_status_check
end

#ignore_stale_approvals ⇒ Object

Returns the value of attribute ignore_stale_approvals.



46
47
48
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 46

def ignore_stale_approvals
  @ignore_stale_approvals
end

#merge_whitelist_teams ⇒ Object

Returns the value of attribute merge_whitelist_teams.



48
49
50
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 48

def merge_whitelist_teams
  @merge_whitelist_teams
end

#merge_whitelist_usernames ⇒ Object

Returns the value of attribute merge_whitelist_usernames.



50
51
52
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 50

def merge_whitelist_usernames
  @merge_whitelist_usernames
end

#protected_file_patterns ⇒ Object

Returns the value of attribute protected_file_patterns.



52
53
54
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 52

def protected_file_patterns
  @protected_file_patterns
end

#push_whitelist_deploy_keys ⇒ Object

Returns the value of attribute push_whitelist_deploy_keys.



54
55
56
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 54

def push_whitelist_deploy_keys
  @push_whitelist_deploy_keys
end

#push_whitelist_teams ⇒ Object

Returns the value of attribute push_whitelist_teams.



56
57
58
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 56

def push_whitelist_teams
  @push_whitelist_teams
end

#push_whitelist_usernames ⇒ Object

Returns the value of attribute push_whitelist_usernames.



58
59
60
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 58

def push_whitelist_usernames
  @push_whitelist_usernames
end

#require_signed_commits ⇒ Object

Returns the value of attribute require_signed_commits.



60
61
62
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 60

def require_signed_commits
  @require_signed_commits
end

#required_approvals ⇒ Object

Returns the value of attribute required_approvals.



62
63
64
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 62

def required_approvals
  @required_approvals
end

#rule_name ⇒ Object

Returns the value of attribute rule_name.



64
65
66
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 64

def rule_name
  @rule_name
end

#status_check_contexts ⇒ Object

Returns the value of attribute status_check_contexts.



66
67
68
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 66

def status_check_contexts
  @status_check_contexts
end

#unprotected_file_patterns ⇒ Object

Returns the value of attribute unprotected_file_patterns.



68
69
70
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 68

def unprotected_file_patterns
  @unprotected_file_patterns
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 365

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



102
103
104
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 102

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 107

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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/forgejo/models/create_branch_protection_option.rb', line 71

def self.attribute_map
  {
    :'apply_to_admins' => :'apply_to_admins',
    :'approvals_whitelist_teams' => :'approvals_whitelist_teams',
    :'approvals_whitelist_username' => :'approvals_whitelist_username',
    :'block_on_official_review_requests' => :'block_on_official_review_requests',
    :'block_on_outdated_branch' => :'block_on_outdated_branch',
    :'block_on_rejected_reviews' => :'block_on_rejected_reviews',
    :'branch_name' => :'branch_name',
    :'dismiss_stale_approvals' => :'dismiss_stale_approvals',
    :'enable_approvals_whitelist' => :'enable_approvals_whitelist',
    :'enable_merge_whitelist' => :'enable_merge_whitelist',
    :'enable_push' => :'enable_push',
    :'enable_push_whitelist' => :'enable_push_whitelist',
    :'enable_status_check' => :'enable_status_check',
    :'ignore_stale_approvals' => :'ignore_stale_approvals',
    :'merge_whitelist_teams' => :'merge_whitelist_teams',
    :'merge_whitelist_usernames' => :'merge_whitelist_usernames',
    :'protected_file_patterns' => :'protected_file_patterns',
    :'push_whitelist_deploy_keys' => :'push_whitelist_deploy_keys',
    :'push_whitelist_teams' => :'push_whitelist_teams',
    :'push_whitelist_usernames' => :'push_whitelist_usernames',
    :'require_signed_commits' => :'require_signed_commits',
    :'required_approvals' => :'required_approvals',
    :'rule_name' => :'rule_name',
    :'status_check_contexts' => :'status_check_contexts',
    :'unprotected_file_patterns' => :'unprotected_file_patterns'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 341

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



143
144
145
146
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 143

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 112

def self.openapi_types
  {
    :'apply_to_admins' => :'Boolean',
    :'approvals_whitelist_teams' => :'Array<String>',
    :'approvals_whitelist_username' => :'Array<String>',
    :'block_on_official_review_requests' => :'Boolean',
    :'block_on_outdated_branch' => :'Boolean',
    :'block_on_rejected_reviews' => :'Boolean',
    :'branch_name' => :'String',
    :'dismiss_stale_approvals' => :'Boolean',
    :'enable_approvals_whitelist' => :'Boolean',
    :'enable_merge_whitelist' => :'Boolean',
    :'enable_push' => :'Boolean',
    :'enable_push_whitelist' => :'Boolean',
    :'enable_status_check' => :'Boolean',
    :'ignore_stale_approvals' => :'Boolean',
    :'merge_whitelist_teams' => :'Array<String>',
    :'merge_whitelist_usernames' => :'Array<String>',
    :'protected_file_patterns' => :'String',
    :'push_whitelist_deploy_keys' => :'Boolean',
    :'push_whitelist_teams' => :'Array<String>',
    :'push_whitelist_usernames' => :'Array<String>',
    :'require_signed_commits' => :'Boolean',
    :'required_approvals' => :'Integer',
    :'rule_name' => :'String',
    :'status_check_contexts' => :'Array<String>',
    :'unprotected_file_patterns' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apply_to_admins == o.apply_to_admins &&
      approvals_whitelist_teams == o.approvals_whitelist_teams &&
      approvals_whitelist_username == o.approvals_whitelist_username &&
      block_on_official_review_requests == o.block_on_official_review_requests &&
      block_on_outdated_branch == o.block_on_outdated_branch &&
      block_on_rejected_reviews == o.block_on_rejected_reviews &&
      branch_name == o.branch_name &&
      dismiss_stale_approvals == o.dismiss_stale_approvals &&
      enable_approvals_whitelist == o.enable_approvals_whitelist &&
      enable_merge_whitelist == o.enable_merge_whitelist &&
      enable_push == o.enable_push &&
      enable_push_whitelist == o.enable_push_whitelist &&
      enable_status_check == o.enable_status_check &&
      ignore_stale_approvals == o.ignore_stale_approvals &&
      merge_whitelist_teams == o.merge_whitelist_teams &&
      merge_whitelist_usernames == o.merge_whitelist_usernames &&
      protected_file_patterns == o.protected_file_patterns &&
      push_whitelist_deploy_keys == o.push_whitelist_deploy_keys &&
      push_whitelist_teams == o.push_whitelist_teams &&
      push_whitelist_usernames == o.push_whitelist_usernames &&
      require_signed_commits == o.require_signed_commits &&
      required_approvals == o.required_approvals &&
      rule_name == o.rule_name &&
      status_check_contexts == o.status_check_contexts &&
      unprotected_file_patterns == o.unprotected_file_patterns
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 436

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


328
329
330
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 328

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



334
335
336
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 334

def hash
  [apply_to_admins, approvals_whitelist_teams, approvals_whitelist_username, block_on_official_review_requests, block_on_outdated_branch, block_on_rejected_reviews, branch_name, dismiss_stale_approvals, enable_approvals_whitelist, enable_merge_whitelist, enable_push, enable_push_whitelist, enable_status_check, ignore_stale_approvals, merge_whitelist_teams, merge_whitelist_usernames, protected_file_patterns, push_whitelist_deploy_keys, push_whitelist_teams, push_whitelist_usernames, require_signed_commits, required_approvals, rule_name, status_check_contexts, unprotected_file_patterns].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



281
282
283
284
285
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 281

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



412
413
414
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 412

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 418

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

Returns:

  • (String) —

    String presentation of the object



406
407
408
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 406

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



289
290
291
292
 
# File 'lib/forgejo/models/create_branch_protection_option.rb', line 289

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end