Class: Fastly::ServiceDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/service_detail.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
213
214
215
# File 'lib/fastly/models/service_detail.rb', line 143

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_versionObject

Returns the value of attribute active_version.



51
52
53
# File 'lib/fastly/models/service_detail.rb', line 51

def active_version
  @active_version
end

#commentObject

A freeform descriptive note.



26
27
28
# File 'lib/fastly/models/service_detail.rb', line 26

def comment
  @comment
end

#created_atObject

Date and time in ISO 8601 format.



17
18
19
# File 'lib/fastly/models/service_detail.rb', line 17

def created_at
  @created_at
end

#customer_idObject

Alphanumeric string identifying the customer.



32
33
34
# File 'lib/fastly/models/service_detail.rb', line 32

def customer_id
  @customer_id
end

#deleted_atObject

Date and time in ISO 8601 format.



20
21
22
# File 'lib/fastly/models/service_detail.rb', line 20

def deleted_at
  @deleted_at
end

#environmentsObject

A list of environments where the service has been deployed.



49
50
51
# File 'lib/fastly/models/service_detail.rb', line 49

def environments
  @environments
end

#idObject

Returns the value of attribute id.



37
38
39
# File 'lib/fastly/models/service_detail.rb', line 37

def id
  @id
end

#nameObject

The name of the service.



29
30
31
# File 'lib/fastly/models/service_detail.rb', line 29

def name
  @name
end

#pausedObject

Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated.



43
44
45
# File 'lib/fastly/models/service_detail.rb', line 43

def paused
  @paused
end

#publish_keyObject

Unused at this time.



40
41
42
# File 'lib/fastly/models/service_detail.rb', line 40

def publish_key
  @publish_key
end

#typeObject

The type of this service.



35
36
37
# File 'lib/fastly/models/service_detail.rb', line 35

def type
  @type
end

#updated_atObject

Date and time in ISO 8601 format.



23
24
25
# File 'lib/fastly/models/service_detail.rb', line 23

def updated_at
  @updated_at
end

#versionObject

Returns the value of attribute version.



53
54
55
# File 'lib/fastly/models/service_detail.rb', line 53

def version
  @version
end

#versionsObject

A list of [versions](www.fastly.com/documentation/reference/api/services/version/) associated with the service.



46
47
48
# File 'lib/fastly/models/service_detail.rb', line 46

def versions
  @versions
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



98
99
100
# File 'lib/fastly/models/service_detail.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/fastly/models/service_detail.rb', line 78

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'comment' => :'comment',
    :'name' => :'name',
    :'customer_id' => :'customer_id',
    :'type' => :'type',
    :'id' => :'id',
    :'publish_key' => :'publish_key',
    :'paused' => :'paused',
    :'versions' => :'versions',
    :'environments' => :'environments',
    :'active_version' => :'active_version',
    :'version' => :'version'
  }
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



278
279
280
# File 'lib/fastly/models/service_detail.rb', line 278

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

.fastly_all_ofObject

List of class defined in allOf (OpenAPI v3)



134
135
136
137
138
139
# File 'lib/fastly/models/service_detail.rb', line 134

def self.fastly_all_of
  [
  :'ServiceDetailAllOf',
  :'ServiceResponse'
  ]
end

.fastly_nullableObject

List of attributes with nullable: true



123
124
125
126
127
128
129
130
131
# File 'lib/fastly/models/service_detail.rb', line 123

def self.fastly_nullable
  Set.new([
    :'created_at',
    :'deleted_at',
    :'updated_at',
    :'comment',
    :'active_version',
  ])
end

.fastly_typesObject

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/fastly/models/service_detail.rb', line 103

def self.fastly_types
  {
    :'created_at' => :'Time',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'comment' => :'String',
    :'name' => :'String',
    :'customer_id' => :'String',
    :'type' => :'String',
    :'id' => :'String',
    :'publish_key' => :'String',
    :'paused' => :'Boolean',
    :'versions' => :'Array<SchemasVersionResponse>',
    :'environments' => :'Array<Environment>',
    :'active_version' => :'ServiceVersionDetailOrNull',
    :'version' => :'ServiceVersionDetail'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/fastly/models/service_detail.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      comment == o.comment &&
      name == o.name &&
      customer_id == o.customer_id &&
      type == o.type &&
      id == o.id &&
      publish_key == o.publish_key &&
      paused == o.paused &&
      versions == o.versions &&
      environments == o.environments &&
      active_version == o.active_version &&
      version == o.version
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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/fastly/models/service_detail.rb', line 308

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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_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



379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/fastly/models/service_detail.rb', line 379

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/fastly/models/service_detail.rb', line 285

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_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


265
266
267
# File 'lib/fastly/models/service_detail.rb', line 265

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



271
272
273
# File 'lib/fastly/models/service_detail.rb', line 271

def hash
  [created_at, deleted_at, updated_at, comment, name, customer_id, type, id, publish_key, paused, versions, environments, active_version, version].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



219
220
221
222
# File 'lib/fastly/models/service_detail.rb', line 219

def list_invalid_properties
  invalid_properties = Array.new
  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



355
356
357
# File 'lib/fastly/models/service_detail.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/fastly/models/service_detail.rb', line 361

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_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



349
350
351
# File 'lib/fastly/models/service_detail.rb', line 349

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



226
227
228
229
230
# File 'lib/fastly/models/service_detail.rb', line 226

def valid?
  type_validator = EnumAttributeValidator.new('String', ["vcl", "wasm"])
  return false unless type_validator.valid?(@type)
  true
end