Class: SmplkitGeneratedClient::App::Group

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

Overview

An Environment Access Group: a named bundle of standard environments its members may manage. A user’s effective managed-environment set is the union across all their groups (or "all" if any of their groups grants “["*"]“). Roles answer what a user may do; groups answer *which environments* that capability reaches.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
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
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 82

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

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

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

#created_at ⇒ Object

When the group was created.



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

def created_at
  @created_at
end

#description ⇒ Object

Free-text description shown on the group’s detail page.



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

def description
  @description
end

#managed_environments ⇒ Object

The set of environments members of this group may manage. Either the exact value ‘["*"]` to grant every standard environment, or an explicit array of standard environment keys. Ad-hoc environments are never listed here — they are exempt from group governance and remain manageable by every member of the account.



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

def managed_environments
  @managed_environments
end

#name ⇒ Object

Human-readable name for the group.



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

def name
  @name
end

#system ⇒ Object

True for built-in groups the platform reserves. The ‘default` group has `system=true`; it cannot be deleted or renamed, though its `managed_environments` may be narrowed.



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

def system
  @system
end

#updated_at ⇒ Object

When the group was last modified.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



50
51
52
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 50

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 55

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 38

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'managed_environments' => :'managed_environments',
    :'system' => :'system',
    :'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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 209

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



72
73
74
75
76
77
78
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'managed_environments' => :'Array<String>',
    :'system' => :'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



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      managed_environments == o.managed_environments &&
      system == o.system &&
      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


196
197
198
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 202

def hash
  [name, description, managed_environments, system, 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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 129

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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 231

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



149
150
151
152
153
154
155
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/group.rb', line 149

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 !@description.nil? && @description.to_s.length > 1024
  true
end