Class: OCI::ApmSynthetics::Models::MonitorConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_synthetics/models/monitor_configuration.rb

Overview

Details of monitor configuration. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

CONFIG_TYPE_ENUM = 
[
  CONFIG_TYPE_BROWSER_CONFIG = 'BROWSER_CONFIG'.freeze,
  CONFIG_TYPE_SCRIPTED_BROWSER_CONFIG = 'SCRIPTED_BROWSER_CONFIG'.freeze,
  CONFIG_TYPE_REST_CONFIG = 'REST_CONFIG'.freeze,
  CONFIG_TYPE_SCRIPTED_REST_CONFIG = 'SCRIPTED_REST_CONFIG'.freeze,
  CONFIG_TYPE_NETWORK_CONFIG = 'NETWORK_CONFIG'.freeze,
  CONFIG_TYPE_DNS_SERVER_CONFIG = 'DNS_SERVER_CONFIG'.freeze,
  CONFIG_TYPE_DNS_TRACE_CONFIG = 'DNS_TRACE_CONFIG'.freeze,
  CONFIG_TYPE_DNSSEC_CONFIG = 'DNSSEC_CONFIG'.freeze,
  CONFIG_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MonitorConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

[View source]

89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 89

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.config_type = attributes[:'configType'] if attributes[:'configType']

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

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

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

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

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

  self.dns_configuration = attributes[:'dnsConfiguration'] if attributes[:'dnsConfiguration']

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

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

Instance Attribute Details

#config_type ⇒ String

Type of configuration.

Returns:

  • (String) 

27
28
29
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 27

def config_type
  @config_type
end

#dns_configuration ⇒ OCI::ApmSynthetics::Models::DnsConfiguration

Returns:


34
35
36
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 34

def dns_configuration
  @dns_configuration
end

#is_failure_retried ⇒ BOOLEAN

If isFailureRetried is enabled, then a failed call will be retried.

Returns:

  • (BOOLEAN) 

31
32
33
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 31

def is_failure_retried
  @is_failure_retried
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'configType',
    'is_failure_retried': :'isFailureRetried',
    'dns_configuration': :'dnsConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

[View source]

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 63

def self.get_subtype(object_hash)
  type = object_hash[:'configType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::ApmSynthetics::Models::DnsSecMonitorConfiguration' if type == 'DNSSEC_CONFIG'
  return 'OCI::ApmSynthetics::Models::DnsTraceMonitorConfiguration' if type == 'DNS_TRACE_CONFIG'
  return 'OCI::ApmSynthetics::Models::ScriptedRestMonitorConfiguration' if type == 'SCRIPTED_REST_CONFIG'
  return 'OCI::ApmSynthetics::Models::DnsServerMonitorConfiguration' if type == 'DNS_SERVER_CONFIG'
  return 'OCI::ApmSynthetics::Models::ScriptedBrowserMonitorConfiguration' if type == 'SCRIPTED_BROWSER_CONFIG'
  return 'OCI::ApmSynthetics::Models::RestMonitorConfiguration' if type == 'REST_CONFIG'
  return 'OCI::ApmSynthetics::Models::BrowserMonitorConfiguration' if type == 'BROWSER_CONFIG'
  return 'OCI::ApmSynthetics::Models::NetworkMonitorConfiguration' if type == 'NETWORK_CONFIG'

  # TODO: Log a warning when the subtype is not found.
  'OCI::ApmSynthetics::Models::MonitorConfiguration'
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'String',
    'is_failure_retried': :'BOOLEAN',
    'dns_configuration': :'OCI::ApmSynthetics::Models::DnsConfiguration'
    # 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

[View source]

136
137
138
139
140
141
142
143
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 136

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

  self.class == other.class &&
    config_type == other.config_type &&
    is_failure_retried == other.is_failure_retried &&
    dns_configuration == other.dns_configuration
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

[View source]

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 168

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
[View source]

148
149
150
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

157
158
159
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 157

def hash
  [config_type, is_failure_retried, dns_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 201

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object

[View source]

195
196
197
 
# File 'lib/oci/apm_synthetics/models/monitor_configuration.rb', line 195

def to_s
  to_hash.to_s
end