Class: LinodeOpenapiClient::PostManagedServiceRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostManagedServiceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#addressObject

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.



52
53
54
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 52

def address
  @address
end

#bodyObject

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



55
56
57
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 55

def body
  @body
end

#consultation_groupObject

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



25
26
27
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 25

def consultation_group
  @consultation_group
end

#createdObject

Read-only When this Managed Service was created.



34
35
36
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 34

def created
  @created
end

#credentialsObject

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



22
23
24
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 22

def credentials
  @credentials
end

#idObject

Read-only This Service’s unique ID.



37
38
39
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 37

def id
  @id
end

#labelObject

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



46
47
48
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 46

def label
  @label
end

#notesObject

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



49
50
51
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 49

def notes
  @notes
end

#regionObject

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



28
29
30
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 28

def region
  @region
end

#service_typeObject

How this Service is monitored.



31
32
33
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 31

def service_type
  @service_type
end

#statusObject

Read-only The current status of this Service.



19
20
21
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 19

def status
  @status
end

#timeoutObject

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



40
41
42
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 40

def timeout
  @timeout
end

#updatedObject

Read-only When this Managed Service was last updated.



43
44
45
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 43

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



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 473

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_attributesObject

Returns all the JSON keys this model knows about



99
100
101
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 99

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 449

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



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

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

.openapi_typesObject

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 416

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



544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 544

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


436
437
438
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 436

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



442
443
444
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 442

def hash
  [status, credentials, consultation_group, region, service_type, created, id, timeout, updated, label, notes, address, body].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 210

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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

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

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

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

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

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

  if @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.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 !~ pattern
    invalid_properties.push("invalid value for \"label\", must conform to the pattern #{pattern}.")
  end

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

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

  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



520
521
522
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 520

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



526
527
528
529
530
531
532
533
534
535
536
537
538
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 526

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



514
515
516
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 514

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/linode_openapi_client/models/post_managed_service_request.rb', line 279

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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
  return false if @service_type.nil?
  service_type_validator = EnumAttributeValidator.new('String', ["url", "tcp"])
  return false unless service_type_validator.valid?(@service_type)
  return false if @timeout.nil?
  return false if @timeout > 255
  return false if @timeout < 1
  return false if @label.nil?
  return false if @label.to_s.length > 64
  return false if @label.to_s.length < 3
  return false if @label !~ Regexp.new(/[a-zA-Z0-9-_ \.]{3,64}/)
  return false if @address.nil?
  return false if @address.to_s.length > 100
  return false if @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
  true
end