Class: Shipeasy::Admin::Generated::UpdateGateRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/shipeasy_admin/models/update_gate_request.rb

Overview

Body for PATCH /api/admin/gates/{id}. Partial — only supplied fields change. Array fields (rules, stack) replace, not merge.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateGateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 101

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#description ⇒ Object

Long-form description / runbook. Markdown is rendered in the dashboard.



38
39
40
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 38

def description
  @description
end

#enabled ⇒ Object

Master switch. false makes the gate evaluate to false for every caller regardless of rollout_pct, rules, or stack — use as kill switch.



29
30
31
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 29

def enabled
  @enabled
end

#folder ⇒ Object

Optional folder name grouping items in the dashboard. Alphanumeric, _ or - (no /). Part of the SDK lookup key (<folder>/<name>).



41
42
43
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 41

def folder
  @folder
end

#group ⇒ Object

Group label for dashboard organisation (e.g. team or product area).



44
45
46
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 44

def group
  @group
end

#owner_email ⇒ Object

Owner contact. Displayed verbatim; not used for auth.



47
48
49
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 47

def owner_email
  @owner_email
end

#rollout_pct ⇒ Object

New rollout in basis points (0–10000 = 0%–100%) — 100 here means 1%. Use rollout_percent (0–100) below for percent. Omit both to leave unchanged.



20
21
22
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 20

def rollout_pct
  @rollout_pct
end

#rollout_percent ⇒ Object

New rollout as a percentage (0–100). Friendlier alias for rollout_pct; converted internally. Wins over rollout_pct if both are supplied. Omit both to leave unchanged.



23
24
25
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 23

def rollout_percent
  @rollout_percent
end

#rules ⇒ Object

Replaces the rule list wholesale. To add a value to an in rule, send the full new rules array with the augmented value (e.g. previous ['US','CA'] → ['US','CA','GB']).



26
27
28
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 26

def rules
  @rules
end

#stack ⇒ Object

Replaces the gatekeeper stack wholesale. Send null to revert to flat rules + rollout_pct evaluation.



32
33
34
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 32

def stack
  @stack
end

#title ⇒ Object

Human-readable title shown in the dashboard. Free-form, no key format constraint.



35
36
37
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 35

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 50

def self.attribute_map
  {
    :'rollout_pct' => :'rollout_pct',
    :'rollout_percent' => :'rollout_percent',
    :'rules' => :'rules',
    :'enabled' => :'enabled',
    :'stack' => :'stack',
    :'title' => :'title',
    :'description' => :'description',
    :'folder' => :'folder',
    :'group' => :'group',
    :'owner_email' => :'owner_email'
  }
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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 365

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



92
93
94
95
96
97
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 92

def self.openapi_nullable
  Set.new([
    :'stack',
    :'folder',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 76

def self.openapi_types
  {
    :'rollout_pct' => :'Integer',
    :'rollout_percent' => :'Float',
    :'rules' => :'Array<ListGatesResponseDataInnerRulesInner>',
    :'enabled' => :'Boolean',
    :'stack' => :'Array<ListGatesResponseDataInnerStackInner>',
    :'title' => :'String',
    :'description' => :'String',
    :'folder' => :'String',
    :'group' => :'String',
    :'owner_email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 335

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      rollout_pct == o.rollout_pct &&
      rollout_percent == o.rollout_percent &&
      rules == o.rules &&
      enabled == o.enabled &&
      stack == o.stack &&
      title == o.title &&
      description == o.description &&
      folder == o.folder &&
      group == o.group &&
      owner_email == o.owner_email
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


352
353
354
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 352

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



358
359
360
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 358

def hash
  [rollout_pct, rollout_percent, rules, enabled, stack, title, description, folder, group, owner_email].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



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
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 162

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@rollout_pct.nil? && @rollout_pct > 10000
    invalid_properties.push('invalid value for "rollout_pct", must be smaller than or equal to 10000.')
  end

  if !@rollout_pct.nil? && @rollout_pct < 0
    invalid_properties.push('invalid value for "rollout_pct", must be greater than or equal to 0.')
  end

  if !@rollout_percent.nil? && @rollout_percent > 100
    invalid_properties.push('invalid value for "rollout_percent", must be smaller than or equal to 100.')
  end

  if !@rollout_percent.nil? && @rollout_percent < 0
    invalid_properties.push('invalid value for "rollout_percent", must be greater than or equal to 0.')
  end

  if !@title.nil? && @title.to_s.length > 140
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 140.')
  end

  if !@description.nil? && @description.to_s.length > 2000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
  end

  if !@folder.nil? && @folder.to_s.length > 256
    invalid_properties.push('invalid value for "folder", the character length must be smaller than or equal to 256.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if !@folder.nil? && @folder !~ pattern
    invalid_properties.push("invalid value for \"folder\", must conform to the pattern #{pattern}.")
  end

  if !@group.nil? && @group.to_s.length > 64
    invalid_properties.push('invalid value for "group", the character length must be smaller than or equal to 64.')
  end

  if !@owner_email.nil? && @owner_email.to_s.length > 190
    invalid_properties.push('invalid value for "owner_email", the character length must be smaller than or equal to 190.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 387

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/shipeasy_admin/models/update_gate_request.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@rollout_pct.nil? && @rollout_pct > 10000
  return false if !@rollout_pct.nil? && @rollout_pct < 0
  return false if !@rollout_percent.nil? && @rollout_percent > 100
  return false if !@rollout_percent.nil? && @rollout_percent < 0
  return false if !@title.nil? && @title.to_s.length > 140
  return false if !@description.nil? && @description.to_s.length > 2000
  return false if !@folder.nil? && @folder.to_s.length > 256
  return false if !@folder.nil? && @folder !~ Regexp.new(/^[a-zA-Z0-9_-]+$/)
  return false if !@group.nil? && @group.to_s.length > 64
  return false if !@owner_email.nil? && @owner_email.to_s.length > 190
  true
end