Class: OpenapiClient::ProjectRead

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/project_read.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProjectRead

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/openapi_client/models/project_read.rb', line 93

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_policy_repo_id ⇒ Object

the id of the policy repo to use for this project



46
47
48
 
# File 'lib/openapi_client/models/project_read.rb', line 46

def active_policy_repo_id
  @active_policy_repo_id
end

#created_at ⇒ Object

Date and time when the project was created (ISO_8601 format).



31
32
33
 
# File 'lib/openapi_client/models/project_read.rb', line 31

def created_at
  @created_at
end

#description ⇒ Object

a longer description outlining the project objectives



40
41
42
 
# File 'lib/openapi_client/models/project_read.rb', line 40

def description
  @description
end

#id ⇒ Object

Unique id of the project



25
26
27
 
# File 'lib/openapi_client/models/project_read.rb', line 25

def id
  @id
end

#key ⇒ Object

A URL-friendly name of the project (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the project.



19
20
21
 
# File 'lib/openapi_client/models/project_read.rb', line 19

def key
  @key
end

#name ⇒ Object

The name of the project



37
38
39
 
# File 'lib/openapi_client/models/project_read.rb', line 37

def name
  @name
end

#organization_id ⇒ Object

Unique id of the organization that the project belongs to.



28
29
30
 
# File 'lib/openapi_client/models/project_read.rb', line 28

def organization_id
  @organization_id
end

#settings ⇒ Object

the settings for this project



43
44
45
 
# File 'lib/openapi_client/models/project_read.rb', line 43

def settings
  @settings
end

#updated_at ⇒ Object

Date and time when the project was last updated/modified (ISO_8601 format).



34
35
36
 
# File 'lib/openapi_client/models/project_read.rb', line 34

def updated_at
  @updated_at
end

#urn_namespace ⇒ Object

Optional namespace for URNs. If empty, URNs will be generated from project key.



22
23
24
 
# File 'lib/openapi_client/models/project_read.rb', line 22

def urn_namespace
  @urn_namespace
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/openapi_client/models/project_read.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/openapi_client/models/project_read.rb', line 49

def self.attribute_map
  {
    :'key' => :'key',
    :'urn_namespace' => :'urn_namespace',
    :'id' => :'id',
    :'organization_id' => :'organization_id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name' => :'name',
    :'description' => :'description',
    :'settings' => :'settings',
    :'active_policy_repo_id' => :'active_policy_repo_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



239
240
241
 
# File 'lib/openapi_client/models/project_read.rb', line 239

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/openapi_client/models/project_read.rb', line 86

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/openapi_client/models/project_read.rb', line 70

def self.openapi_types
  {
    :'key' => :'String',
    :'urn_namespace' => :'String',
    :'id' => :'String',
    :'organization_id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'description' => :'String',
    :'settings' => :'Object',
    :'active_policy_repo_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/openapi_client/models/project_read.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      urn_namespace == o.urn_namespace &&
      id == o.id &&
      organization_id == o.organization_id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      description == o.description &&
      settings == o.settings &&
      active_policy_repo_id == o.active_policy_repo_id
end

#_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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/openapi_client/models/project_read.rb', line 270

def _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 = OpenapiClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/openapi_client/models/project_read.rb', line 341

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

#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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/openapi_client/models/project_read.rb', line 246

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/openapi_client/models/project_read.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/openapi_client/models/project_read.rb', line 232

def hash
  [key, urn_namespace, id, organization_id, created_at, updated_at, name, description, settings, active_policy_repo_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



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
 
# File 'lib/openapi_client/models/project_read.rb', line 149

def list_invalid_properties
  invalid_properties = Array.new
  if @key.nil?
    invalid_properties.push('invalid value for "key", key cannot be nil.')
  end

  pattern = Regexp.new(/[a-z0-9-]{2,}/)
  if !@urn_namespace.nil? && @urn_namespace !~ pattern
    invalid_properties.push("invalid value for \"urn_namespace\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



317
318
319
 
# File 'lib/openapi_client/models/project_read.rb', line 317

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/openapi_client/models/project_read.rb', line 323

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



311
312
313
 
# File 'lib/openapi_client/models/project_read.rb', line 311

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



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/openapi_client/models/project_read.rb', line 185

def valid?
  return false if @key.nil?
  return false if !@urn_namespace.nil? && @urn_namespace !~ Regexp.new(/[a-z0-9-]{2,}/)
  return false if @id.nil?
  return false if @organization_id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @name.nil?
  true
end