Class: OryClient::ProjectMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/project_metadata.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProjectMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
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
# File 'lib/ory-client/models/project_metadata.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::ProjectMetadata` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::ProjectMetadata`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'environment')
    self.environment = attributes[:'environment']
  else
    self.environment = nil
  end

  if attributes.key?(:'home_region')
    self.home_region = attributes[:'home_region']
  else
    self.home_region = nil
  end

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'slug')
    self.slug = attributes[:'slug']
  else
    self.slug = nil
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = nil
  end

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

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

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

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

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

Instance Attribute Details

#created_atObject

The Project’s Creation Date



19
20
21
# File 'lib/ory-client/models/project_metadata.rb', line 19

def created_at
  @created_at
end

#environmentObject

The environment of the project. prod Production stage Staging dev Development



22
23
24
# File 'lib/ory-client/models/project_metadata.rb', line 22

def environment
  @environment
end

#home_regionObject

The project’s data home region eu-central EUCentral us-east USEast us-west USWest us US global Global



25
26
27
# File 'lib/ory-client/models/project_metadata.rb', line 25

def home_region
  @home_region
end

#hostsObject

Returns the value of attribute hosts.



27
28
29
# File 'lib/ory-client/models/project_metadata.rb', line 27

def hosts
  @hosts
end

#idObject

The project’s ID.



30
31
32
# File 'lib/ory-client/models/project_metadata.rb', line 30

def id
  @id
end

#nameObject

The project’s name if set



33
34
35
# File 'lib/ory-client/models/project_metadata.rb', line 33

def name
  @name
end

#slugObject

The project’s slug



36
37
38
# File 'lib/ory-client/models/project_metadata.rb', line 36

def slug
  @slug
end

#stateObject

The state of the project. running Running halted Halted deleted Deleted



39
40
41
# File 'lib/ory-client/models/project_metadata.rb', line 39

def state
  @state
end

#subscription_idObject

Returns the value of attribute subscription_id.



41
42
43
# File 'lib/ory-client/models/project_metadata.rb', line 41

def subscription_id
  @subscription_id
end

#subscription_planObject

Returns the value of attribute subscription_plan.



43
44
45
# File 'lib/ory-client/models/project_metadata.rb', line 43

def subscription_plan
  @subscription_plan
end

#updated_atObject

Last Time Project was Updated



46
47
48
# File 'lib/ory-client/models/project_metadata.rb', line 46

def updated_at
  @updated_at
end

#workspaceObject

Returns the value of attribute workspace.



48
49
50
# File 'lib/ory-client/models/project_metadata.rb', line 48

def workspace
  @workspace
end

#workspace_idObject

Returns the value of attribute workspace_id.



50
51
52
# File 'lib/ory-client/models/project_metadata.rb', line 50

def workspace_id
  @workspace_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
# File 'lib/ory-client/models/project_metadata.rb', line 369

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OryClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



94
95
96
# File 'lib/ory-client/models/project_metadata.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/ory-client/models/project_metadata.rb', line 75

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'environment' => :'environment',
    :'home_region' => :'home_region',
    :'hosts' => :'hosts',
    :'id' => :'id',
    :'name' => :'name',
    :'slug' => :'slug',
    :'state' => :'state',
    :'subscription_id' => :'subscription_id',
    :'subscription_plan' => :'subscription_plan',
    :'updated_at' => :'updated_at',
    :'workspace' => :'workspace',
    :'workspace_id' => :'workspace_id'
  }
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/ory-client/models/project_metadata.rb', line 345

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_nullableObject

List of attributes with nullable: true



118
119
120
121
122
123
124
# File 'lib/ory-client/models/project_metadata.rb', line 118

def self.openapi_nullable
  Set.new([
    :'subscription_id',
    :'subscription_plan',
    :'workspace_id'
  ])
end

.openapi_typesObject

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/ory-client/models/project_metadata.rb', line 99

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'environment' => :'String',
    :'home_region' => :'String',
    :'hosts' => :'Array<String>',
    :'id' => :'String',
    :'name' => :'String',
    :'slug' => :'String',
    :'state' => :'String',
    :'subscription_id' => :'String',
    :'subscription_plan' => :'String',
    :'updated_at' => :'Time',
    :'workspace' => :'Workspace',
    :'workspace_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/ory-client/models/project_metadata.rb', line 312

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      environment == o.environment &&
      home_region == o.home_region &&
      hosts == o.hosts &&
      id == o.id &&
      name == o.name &&
      slug == o.slug &&
      state == o.state &&
      subscription_id == o.subscription_id &&
      subscription_plan == o.subscription_plan &&
      updated_at == o.updated_at &&
      workspace == o.workspace &&
      workspace_id == o.workspace_id
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'lib/ory-client/models/project_metadata.rb', line 440

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


332
333
334
# File 'lib/ory-client/models/project_metadata.rb', line 332

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



338
339
340
# File 'lib/ory-client/models/project_metadata.rb', line 338

def hash
  [created_at, environment, home_region, hosts, id, name, slug, state, subscription_id, subscription_plan, updated_at, workspace, workspace_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/ory-client/models/project_metadata.rb', line 216

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



416
417
418
# File 'lib/ory-client/models/project_metadata.rb', line 416

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



422
423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/ory-client/models/project_metadata.rb', line 422

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



410
411
412
# File 'lib/ory-client/models/project_metadata.rb', line 410

def to_s
  to_hash.to_s
end

#valid?Boolean

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

Returns:

  • (Boolean)

    true if the model is valid



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/ory-client/models/project_metadata.rb', line 260

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created_at.nil?
  return false if @environment.nil?
  environment_validator = EnumAttributeValidator.new('String', ["prod", "stage", "dev"])
  return false unless environment_validator.valid?(@environment)
  return false if @home_region.nil?
  home_region_validator = EnumAttributeValidator.new('String', ["eu-central", "us-east", "us-west", "us", "global"])
  return false unless home_region_validator.valid?(@home_region)
  return false if @hosts.nil?
  return false if @id.nil?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["running", "halted", "deleted"])
  return false unless state_validator.valid?(@state)
  return false if @updated_at.nil?
  true
end