Class: Shipeasy::Admin::Generated::ToggleKillswitchRequest

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

Overview

Body for POST /api/admin/killswitches/{id}/toggle. Every field is optional, so the four useful calls read as one method with a widening argument list: - {} — flip the flat value on prod. - { \"switchKey\": \"eu_region\" } — flip that sub-switch on prod. - { \"switchKey\": \"eu_region\", \"value\": true } — set that sub-switch on prod, idempotently. - { \"switchKey\": \"eu_region\", \"value\": true, \"env\": \"staging\" } — the same, on a chosen env.

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 88

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

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

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

Instance Attribute Details

#env ⇒ Object

Environment to publish on. Defaults to prod — the environment an incident response means when it says "kill it".



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

def env
  @env
end

#switch_key ⇒ Object

Which target to flip. Omit (or null) to flip the killswitch's own flat value; name a switch key to flip that nested sub-switch instead, creating the entry if it doesn't exist yet.



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

def switch_key
  @switch_key
end

#value ⇒ Object

The value to publish. Omit (or null) to flip whatever is stored now — read-modify-write in one call. Pass an explicit true/false to make the call idempotent, so a retry can't undo the first attempt.



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

def value
  @value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



60
61
62
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 60

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 65

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 51

def self.attribute_map
  {
    :'switch_key' => :'switchKey',
    :'value' => :'value',
    :'env' => :'env'
  }
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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 181

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



79
80
81
82
83
84
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 79

def self.openapi_nullable
  Set.new([
    :'switch_key',
    :'value',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 70

def self.openapi_types
  {
    :'switch_key' => :'String',
    :'value' => :'Boolean',
    :'env' => :'Env'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      switch_key == o.switch_key &&
      value == o.value &&
      env == o.env
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 174

def hash
  [switch_key, value, env].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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 117

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

  pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/)
  if !@switch_key.nil? && @switch_key !~ pattern
    invalid_properties.push("invalid value for \"switch_key\", must conform to the pattern #{pattern}.")
  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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 203

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



134
135
136
137
138
139
 
# File 'lib/shipeasy_admin/models/toggle_killswitch_request.rb', line 134

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@switch_key.nil? && @switch_key.to_s.length > 64
  return false if !@switch_key.nil? && @switch_key !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/)
  true
end