Class: SmplkitGeneratedClient::App::Environment

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb

Overview

A named deployment context — for example, ‘production`, `staging`, or `development`. Resources scoped to an environment (such as config items and feature flags) are evaluated against environment-specific values.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 104

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

  if attributes.key?(:'classification')
    self.classification = attributes[:'classification']
  else
    self.classification = 'STANDARD'
  end

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

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

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

Instance Attribute Details

#classification ⇒ Object

‘STANDARD` for environments deliberately created (and shown by default in the environment grid); `AD_HOC` for auto-discovered environments seen in SDK traffic (hidden from the default view). Case-insensitive on input. Independent of the `managed` flag.



26
27
28
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 26

def classification
  @classification
end

#color ⇒ Object

Display color used by the console to badge the environment. Accepts any CSS color string.



23
24
25
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 23

def color
  @color
end

#created_at ⇒ Object

When the environment was created.



32
33
34
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 32

def created_at
  @created_at
end

#managed ⇒ Object

When ‘true`, per-environment resource values can be set against this environment and it counts toward the account’s managed-environments quota. When ‘false`, the environment is view-only: existing values are displayed for comparison but no new values can be written. Promotion and demotion flip this boolean via `PUT /api/v1/environments/id`; promotion is subject to the quota.



29
30
31
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 29

def managed
  @managed
end

#name ⇒ Object

Human-readable name for the environment.



20
21
22
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 20

def name
  @name
end

#updated_at ⇒ Object

When the environment was last modified.



35
36
37
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 35

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



72
73
74
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 72

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 77

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 60

def self.attribute_map
  {
    :'name' => :'name',
    :'color' => :'color',
    :'classification' => :'classification',
    :'managed' => :'managed',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 243

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



94
95
96
97
98
99
100
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 94

def self.openapi_nullable
  Set.new([
    :'color',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 82

def self.openapi_types
  {
    :'name' => :'String',
    :'color' => :'String',
    :'classification' => :'String',
    :'managed' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      color == o.color &&
      classification == o.classification &&
      managed == o.managed &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 236

def hash
  [name, color, classification, managed, created_at, updated_at].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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 151

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 > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 265

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



171
172
173
174
175
176
177
178
179
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if !@color.nil? && @color.to_s.length > 50
  classification_validator = EnumAttributeValidator.new('String', ["STANDARD", "AD_HOC"])
  return false unless classification_validator.valid?(@classification)
  true
end