Class: OryClient::Project

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/project.rb

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ory-client/models/project.rb', line 127

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

  if attributes.key?(:'cors_public')
    self.cors_public = attributes[:'cors_public']
  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?(:'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?(:'organizations')
    if (value = attributes[:'organizations']).is_a?(Array)
      self.organizations = value
    end
  else
    self.organizations = nil
  end

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

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

Instance Attribute Details

#cors_admin ⇒ Object

Returns the value of attribute cors_admin.



18
19
20
 
# File 'lib/ory-client/models/project.rb', line 18

def cors_admin
  @cors_admin
end

#cors_public ⇒ Object

Returns the value of attribute cors_public.



20
21
22
 
# File 'lib/ory-client/models/project.rb', line 20

def cors_public
  @cors_public
end

#environment ⇒ Object

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



23
24
25
 
# File 'lib/ory-client/models/project.rb', line 23

def environment
  @environment
end

#home_region ⇒ Object

The project home region. This is used to set where the project data is stored and where the project’s endpoints are located. eu-central EUCentral asia-northeast AsiaNorthEast us-east USEast us-west USWest us US global Global



26
27
28
 
# File 'lib/ory-client/models/project.rb', line 26

def home_region
  @home_region
end

#id ⇒ Object

The project’s ID.



29
30
31
 
# File 'lib/ory-client/models/project.rb', line 29

def id
  @id
end

#name ⇒ Object

The name of the project.



32
33
34
 
# File 'lib/ory-client/models/project.rb', line 32

def name
  @name
end

#organizations ⇒ Object

The organizations of the project. Organizations are used to group users and enforce certain restrictions like usage of SSO.



35
36
37
 
# File 'lib/ory-client/models/project.rb', line 35

def organizations
  @organizations
end

#revision_id ⇒ Object

The configuration revision ID.



38
39
40
 
# File 'lib/ory-client/models/project.rb', line 38

def revision_id
  @revision_id
end

#services ⇒ Object

Returns the value of attribute services.



40
41
42
 
# File 'lib/ory-client/models/project.rb', line 40

def services
  @services
end

#slug ⇒ Object

The project’s slug



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

def slug
  @slug
end

#state ⇒ Object

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



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

def state
  @state
end

#workspace_id ⇒ Object

Returns the value of attribute workspace_id.



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

def workspace_id
  @workspace_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



91
92
93
 
# File 'lib/ory-client/models/project.rb', line 91

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/ory-client/models/project.rb', line 96

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ory-client/models/project.rb', line 73

def self.attribute_map
  {
    :'cors_admin' => :'cors_admin',
    :'cors_public' => :'cors_public',
    :'environment' => :'environment',
    :'home_region' => :'home_region',
    :'id' => :'id',
    :'name' => :'name',
    :'organizations' => :'organizations',
    :'revision_id' => :'revision_id',
    :'services' => :'services',
    :'slug' => :'slug',
    :'state' => :'state',
    :'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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/ory-client/models/project.rb', line 400

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'cors_admin' => :'ProjectCors',
    :'cors_public' => :'ProjectCors',
    :'environment' => :'String',
    :'home_region' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'organizations' => :'Array<BasicOrganization>',
    :'revision_id' => :'String',
    :'services' => :'ProjectServices',
    :'slug' => :'String',
    :'state' => :'String',
    :'workspace_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ory-client/models/project.rb', line 368

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cors_admin == o.cors_admin &&
      cors_public == o.cors_public &&
      environment == o.environment &&
      home_region == o.home_region &&
      id == o.id &&
      name == o.name &&
      organizations == o.organizations &&
      revision_id == o.revision_id &&
      services == o.services &&
      slug == o.slug &&
      state == o.state &&
      workspace_id == o.workspace_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


387
388
389
 
# File 'lib/ory-client/models/project.rb', line 387

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



393
394
395
 
# File 'lib/ory-client/models/project.rb', line 393

def hash
  [cors_admin, cors_public, environment, home_region, id, name, organizations, revision_id, services, slug, state, workspace_id].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 @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 @organizations.nil?
    invalid_properties.push('invalid value for "organizations", organizations cannot be nil.')
  end

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

  if @services.nil?
    invalid_properties.push('invalid value for "services", services 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

  invalid_properties
end

#to_hash ⇒ Hash

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.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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ory-client/models/project.rb', line 256

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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", "asia-northeast", "us-east", "us-west", "us", "global"])
  return false unless home_region_validator.valid?(@home_region)
  return false if @id.nil?
  return false if @name.nil?
  return false if @organizations.nil?
  return false if @revision_id.nil?
  return false if @services.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)
  true
end