Class: LinodeOpenapiClient::PostManagedService200Response

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/post_managed_service200_response.rb

Overview

A service that Linode is monitoring as part of your Managed services. If issues are detected with this service, a ManagedIssue will be opened and, optionally, Linode special forces will attempt to resolve the Issue.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostManagedService200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

The URL at which this Service is monitored. URL parameters such as ‘?no-cache=1` are preserved. URL fragments/anchors such as `#monitor` are __not__ preserved.



23
24
25
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 23

def address
  @address
end

#body ⇒ Object

What to expect to find in the response body for the Service to be considered up.



26
27
28
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 26

def body
  @body
end

#consultation_group ⇒ Object

The group of ManagedContacts who should be notified or consulted with when an Issue is detected.



56
57
58
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 56

def consultation_group
  @consultation_group
end

#created ⇒ Object

Read-only When this Managed Service was created.



47
48
49
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 47

def created
  @created
end

#credentials ⇒ Object

An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.



53
54
55
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 53

def credentials
  @credentials
end

#id ⇒ Object

Read-only This Service’s unique ID.



38
39
40
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 38

def id
  @id
end

#label ⇒ Object

The label for this Service. This is for display purposes only.



29
30
31
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 29

def label
  @label
end

#notes ⇒ Object

Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.



20
21
22
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 20

def notes
  @notes
end

#region ⇒ Object

The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.



41
42
43
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 41

def region
  @region
end

#service_type ⇒ Object

How this Service is monitored.



44
45
46
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 44

def service_type
  @service_type
end

#status ⇒ Object

Read-only The current status of this Service.



50
51
52
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 50

def status
  @status
end

#timeout ⇒ Object

How long to wait, in seconds, for a response before considering the Service to be down.



35
36
37
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 35

def timeout
  @timeout
end

#updated ⇒ Object

Read-only When this Managed Service was last updated.



32
33
34
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 32

def updated
  @updated
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



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 446

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 = LinodeOpenapiClient.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



100
101
102
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 100

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 81

def self.attribute_map
  {
    :'notes' => :'notes',
    :'address' => :'address',
    :'body' => :'body',
    :'label' => :'label',
    :'updated' => :'updated',
    :'timeout' => :'timeout',
    :'id' => :'id',
    :'region' => :'region',
    :'service_type' => :'service_type',
    :'created' => :'created',
    :'status' => :'status',
    :'credentials' => :'credentials',
    :'consultation_group' => :'consultation_group'
  }
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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 422

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



124
125
126
127
128
129
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 124

def self.openapi_nullable
  Set.new([
    :'notes',
    :'body',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 105

def self.openapi_types
  {
    :'notes' => :'String',
    :'address' => :'String',
    :'body' => :'String',
    :'label' => :'String',
    :'updated' => :'Time',
    :'timeout' => :'Integer',
    :'id' => :'Integer',
    :'region' => :'String',
    :'service_type' => :'String',
    :'created' => :'Time',
    :'status' => :'String',
    :'credentials' => :'Array<Integer>',
    :'consultation_group' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 389

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      notes == o.notes &&
      address == o.address &&
      body == o.body &&
      label == o.label &&
      updated == o.updated &&
      timeout == o.timeout &&
      id == o.id &&
      region == o.region &&
      service_type == o.service_type &&
      created == o.created &&
      status == o.status &&
      credentials == o.credentials &&
      consultation_group == o.consultation_group
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



517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 517

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


409
410
411
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 409

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



415
416
417
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 415

def hash
  [notes, address, body, label, updated, timeout, id, region, service_type, created, status, credentials, consultation_group].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



203
204
205
206
207
208
209
210
211
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/linode_openapi_client/models/post_managed_service200_response.rb', line 203

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@address.nil? && @address.to_s.length > 100
    invalid_properties.push('invalid value for "address", the character length must be smaller than or equal to 100.')
  end

  if !@address.nil? && @address.to_s.length < 3
    invalid_properties.push('invalid value for "address", the character length must be great than or equal to 3.')
  end

  if !@body.nil? && @body.to_s.length > 100
    invalid_properties.push('invalid value for "body", the character length must be smaller than or equal to 100.')
  end

  if !@body.nil? && @body.to_s.length < 0
    invalid_properties.push('invalid value for "body", the character length must be great than or equal to 0.')
  end

  if !@label.nil? && @label.to_s.length > 64
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 64.')
  end

  if !@label.nil? && @label.to_s.length < 3
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 3.')
  end

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

  if !@timeout.nil? && @timeout > 255
    invalid_properties.push('invalid value for "timeout", must be smaller than or equal to 255.')
  end

  if !@timeout.nil? && @timeout < 1
    invalid_properties.push('invalid value for "timeout", must be greater than or equal to 1.')
  end

  if !@consultation_group.nil? && @consultation_group.to_s.length > 50
    invalid_properties.push('invalid value for "consultation_group", the character length must be smaller than or equal to 50.')
  end

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



493
494
495
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 493

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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 499

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



487
488
489
 
# File 'lib/linode_openapi_client/models/post_managed_service200_response.rb', line 487

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@address.nil? && @address.to_s.length > 100
  return false if !@address.nil? && @address.to_s.length < 3
  return false if !@body.nil? && @body.to_s.length > 100
  return false if !@body.nil? && @body.to_s.length < 0
  return false if !@label.nil? && @label.to_s.length > 64
  return false if !@label.nil? && @label.to_s.length < 3
  return false if !@label.nil? && @label !~ Regexp.new(/[a-zA-Z0-9-_ \.]{3,64}/)
  return false if !@timeout.nil? && @timeout > 255
  return false if !@timeout.nil? && @timeout < 1
  service_type_validator = EnumAttributeValidator.new('String', ["url", "tcp"])
  return false unless service_type_validator.valid?(@service_type)
  status_validator = EnumAttributeValidator.new('String', ["disabled", "pending", "ok", "problem"])
  return false unless status_validator.valid?(@status)
  return false if !@consultation_group.nil? && @consultation_group.to_s.length > 50
  return false if !@consultation_group.nil? && @consultation_group.to_s.length < 0
  true
end