Class: Shipeasy::Admin::Generated::CreateGateRequest

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

Overview

Body for POST /api/admin/gates. At minimum supply name; everything else has sensible defaults.

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 = {}) ⇒ CreateGateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'rollout_pct')
    self.rollout_pct = attributes[:'rollout_pct']
  else
    self.rollout_pct = 0
  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
  else
    self.rules = nil
  end

  if attributes.key?(:'salt')
    self.salt = attributes[:'salt']
  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.



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

def description
  @description
end

#enabled ⇒ Object

Master switch. Defaults to true. Set false to create the gate disabled (evaluates to false regardless of rules/rollout); flip on via POST /{id}/enable or PATCH.



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

def enabled
  @enabled
end

#folder ⇒ Object

Optional folder name used to group items in the dashboard. Part of the SDK lookup key: an item in folder checkout named new-cart is referenced as checkout/new-cart from the SDK.



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

def folder
  @folder
end

#group ⇒ Object

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



50
51
52
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 50

def group
  @group
end

#name ⇒ Object

Stable gate key used by SDKs (Shipeasy.checkGate(user, '<name>')). Single segment or folder.name. Lowercase letters, digits, _ or -; max 128 chars. Immutable after create — rename = delete + recreate.



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

def name
  @name
end

#owner_email ⇒ Object

Owner contact. Displayed verbatim; not used for auth.



53
54
55
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 53

def owner_email
  @owner_email
end

#rollout_pct ⇒ Object

Initial rollout in basis points (0–10000 = 0%–100%) — 100 here means 1%, not 100%. Use rollout_percent (0–100) below if you'd rather think in percent. Use 0 to create the gate dark and ramp via PATCH after deploy validation.



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

def rollout_pct
  @rollout_pct
end

#rollout_percent ⇒ Object

Initial rollout as a percentage (0–100, fractional ok). Friendlier alias for rollout_pct; converted internally to basis points (e.g. 100 here = 10000 bp = 100%). If both rollout_pct and rollout_percent are set, rollout_percent wins.



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

def rollout_percent
  @rollout_percent
end

#rules ⇒ Object

Targeting predicates. AND-combined. If non-empty, the gate returns true only for callers that satisfy every rule and fall under rollout_pct.



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

def rules
  @rules
end

#salt ⇒ Object

Hash salt for percentage bucketing. Auto-generated if omitted. Provide explicitly to keep a gate's buckets stable across delete/recreate. Immutable after create — there is no PATCH for salt because changing it would re-bucket every caller.



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

def salt
  @salt
end

#stack ⇒ Object

Optional gatekeeper stack. When provided, takes precedence over rules + rollout_pct at evaluation time. Omit (or pass null) for a flat gate.



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

def stack
  @stack
end

#title ⇒ Object

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



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

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 56

def self.attribute_map
  {
    :'name' => :'name',
    :'enabled' => :'enabled',
    :'rollout_pct' => :'rollout_pct',
    :'rollout_percent' => :'rollout_percent',
    :'rules' => :'rules',
    :'salt' => :'salt',
    :'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



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 491

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



102
103
104
105
106
107
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 84

def self.openapi_types
  {
    :'name' => :'String',
    :'enabled' => :'Boolean',
    :'rollout_pct' => :'Integer',
    :'rollout_percent' => :'Float',
    :'rules' => :'Array<ListGatesResponseDataInnerRulesInner>',
    :'salt' => :'String',
    :'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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 459

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      enabled == o.enabled &&
      rollout_pct == o.rollout_pct &&
      rollout_percent == o.rollout_percent &&
      rules == o.rules &&
      salt == o.salt &&
      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


478
479
480
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 478

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



484
485
486
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 484

def hash
  [name, enabled, rollout_pct, rollout_percent, rules, salt, 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



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

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

  if @name.to_s.length > 128
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
  end

  pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

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

  if @rollout_pct > 10000
    invalid_properties.push('invalid value for "rollout_pct", must be smaller than or equal to 10000.')
  end

  if @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 @rules.nil?
    invalid_properties.push('invalid value for "rules", rules cannot be nil.')
  end

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

  if !@salt.nil? && @salt.to_s.length < 1
    invalid_properties.push('invalid value for "salt", the character length must be greater than or equal to 1.')
  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



513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 513

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/shipeasy_admin/models/create_gate_request.rb', line 270

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 128
  return false if @name !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
  return false if @enabled.nil?
  return false if @rollout_pct.nil?
  return false if @rollout_pct > 10000
  return false if @rollout_pct < 0
  return false if !@rollout_percent.nil? && @rollout_percent > 100
  return false if !@rollout_percent.nil? && @rollout_percent < 0
  return false if @rules.nil?
  return false if !@salt.nil? && @salt.to_s.length > 64
  return false if !@salt.nil? && @salt.to_s.length < 1
  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