Class: OCI::Healthchecks::Models::HttpMonitorSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/healthchecks/models/http_monitor_summary.rb

Overview

A summary containing all of the mutable and immutable properties for an HTTP monitor.

Constant Summary collapse

PROTOCOL_ENUM =
[
  PROTOCOL_HTTP = 'HTTP'.freeze,
  PROTOCOL_HTTPS = 'HTTPS'.freeze,
  PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HttpMonitorSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id property

  • :results_url (String)

    The value to assign to the #results_url property

  • :home_region (String)

    The value to assign to the #home_region property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :interval_in_seconds (Integer)

    The value to assign to the #interval_in_seconds property

  • :is_enabled (BOOLEAN)

    The value to assign to the #is_enabled property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags property

  • :protocol (String)

    The value to assign to the #protocol property



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
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 127

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.results_url = attributes[:'resultsUrl'] if attributes[:'resultsUrl']

  raise 'You cannot provide both :resultsUrl and :results_url' if attributes.key?(:'resultsUrl') && attributes.key?(:'results_url')

  self.results_url = attributes[:'results_url'] if attributes[:'results_url']

  self.home_region = attributes[:'homeRegion'] if attributes[:'homeRegion']

  raise 'You cannot provide both :homeRegion and :home_region' if attributes.key?(:'homeRegion') && attributes.key?(:'home_region')

  self.home_region = attributes[:'home_region'] if attributes[:'home_region']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.interval_in_seconds = attributes[:'intervalInSeconds'] if attributes[:'intervalInSeconds']

  raise 'You cannot provide both :intervalInSeconds and :interval_in_seconds' if attributes.key?(:'intervalInSeconds') && attributes.key?(:'interval_in_seconds')

  self.interval_in_seconds = attributes[:'interval_in_seconds'] if attributes[:'interval_in_seconds']

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isEnabled and :is_enabled' if attributes.key?(:'isEnabled') && attributes.key?(:'is_enabled')

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.protocol = attributes[:'protocol'] if attributes[:'protocol']
end

Instance Attribute Details

#compartment_idString

The OCID of the compartment.

Returns:

  • (String)


38
39
40
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 38

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


67
68
69
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 67

def defined_tags
  @defined_tags
end

#display_nameString

A user-friendly and mutable name suitable for display in a user interface.

Returns:

  • (String)


42
43
44
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 42

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


60
61
62
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 60

def freeform_tags
  @freeform_tags
end

#home_regionString

The region where updates must be made and where results must be fetched from.

Returns:

  • (String)


29
30
31
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 29

def home_region
  @home_region
end

#idString

The OCID of the resource.

Returns:

  • (String)


20
21
22
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 20

def id
  @id
end

#interval_in_secondsInteger

The monitor interval in seconds. Valid values: 10, 30, and 60.

Returns:

  • (Integer)


47
48
49
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 47

def interval_in_seconds
  @interval_in_seconds
end

#is_enabledBOOLEAN

Enables or disables the monitor. Set to 'true' to launch monitoring.

Returns:

  • (BOOLEAN)


52
53
54
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 52

def is_enabled
  @is_enabled
end

#protocolString

Returns:

  • (String)


70
71
72
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 70

def protocol
  @protocol
end

#results_urlString

A URL for fetching the probe results.

Returns:

  • (String)


24
25
26
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 24

def results_url
  @results_url
end

#time_createdDateTime

The RFC 3339-formatted creation date and time of the probe.

Returns:

  • (DateTime)


34
35
36
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 34

def time_created
  @time_created
end

Class Method Details

.attribute_mapObject

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
89
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 73

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'results_url': :'resultsUrl',
    'home_region': :'homeRegion',
    'time_created': :'timeCreated',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'interval_in_seconds': :'intervalInSeconds',
    'is_enabled': :'isEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'protocol': :'protocol'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 92

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'results_url': :'String',
    'home_region': :'String',
    'time_created': :'DateTime',
    'compartment_id': :'String',
    'display_name': :'String',
    'interval_in_seconds': :'Integer',
    'is_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'protocol': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 214

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    results_url == other.results_url &&
    home_region == other.home_region &&
    time_created == other.time_created &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    interval_in_seconds == other.interval_in_seconds &&
    is_enabled == other.is_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    protocol == other.protocol
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 254

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 234

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



243
244
245
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 243

def hash
  [id, results_url, home_region, time_created, compartment_id, display_name, interval_in_seconds, is_enabled, freeform_tags, defined_tags, protocol].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



287
288
289
290
291
292
293
294
295
296
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 287

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



281
282
283
# File 'lib/oci/healthchecks/models/http_monitor_summary.rb', line 281

def to_s
  to_hash.to_s
end