Class: OCI::ApmSynthetics::Models::BrowserMonitorConfiguration

Inherits:
MonitorConfiguration show all
Defined in:
lib/oci/apm_synthetics/models/browser_monitor_configuration.rb

Overview

Configuration details for the BROWSER monitor type.

Constant Summary

Constants inherited from MonitorConfiguration

MonitorConfiguration::CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from MonitorConfiguration

#config_type, #dns_configuration, #is_failure_retried

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from MonitorConfiguration

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ BrowserMonitorConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
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
115
116
117
118
119
120
121
122
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 79

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

  attributes['configType'] = 'BROWSER_CONFIG'

  super(attributes)

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

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

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

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

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

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

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

  self.verify_texts = attributes[:'verifyTexts'] if attributes[:'verifyTexts']

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

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

  self.verify_response_codes = attributes[:'verifyResponseCodes'] if attributes[:'verifyResponseCodes']

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

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

  self.network_configuration = attributes[:'networkConfiguration'] if attributes[:'networkConfiguration']

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

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

Instance Attribute Details

#is_certificate_validation_enabled ⇒ BOOLEAN

If certificate validation is enabled, then the call will fail in case of certification errors.

Returns:

  • (BOOLEAN) 


14
15
16
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 14

def is_certificate_validation_enabled
  @is_certificate_validation_enabled
end

#is_default_snapshot_enabled ⇒ BOOLEAN

If disabled, auto snapshots are not collected.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 18

def is_default_snapshot_enabled
  @is_default_snapshot_enabled
end

#network_configuration ⇒ OCI::ApmSynthetics::Models::NetworkConfiguration

Returns:



32
33
34
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 32

def network_configuration
  @network_configuration
end

#verify_response_codes ⇒ Array<String>

Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

Returns:

  • (Array<String>) 


29
30
31
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 29

def verify_response_codes
  @verify_response_codes
end

#verify_texts ⇒ Array<OCI::ApmSynthetics::Models::VerifyText>

Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

Returns:



24
25
26
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 24

def verify_texts
  @verify_texts
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'configType',
    'is_failure_retried': :'isFailureRetried',
    'dns_configuration': :'dnsConfiguration',
    'is_certificate_validation_enabled': :'isCertificateValidationEnabled',
    'is_default_snapshot_enabled': :'isDefaultSnapshotEnabled',
    'verify_texts': :'verifyTexts',
    'verify_response_codes': :'verifyResponseCodes',
    'network_configuration': :'networkConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'String',
    'is_failure_retried': :'BOOLEAN',
    'dns_configuration': :'OCI::ApmSynthetics::Models::DnsConfiguration',
    'is_certificate_validation_enabled': :'BOOLEAN',
    'is_default_snapshot_enabled': :'BOOLEAN',
    'verify_texts': :'Array<OCI::ApmSynthetics::Models::VerifyText>',
    'verify_response_codes': :'Array<String>',
    'network_configuration': :'OCI::ApmSynthetics::Models::NetworkConfiguration'
    # 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



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/apm_synthetics/models/browser_monitor_configuration.rb', line 131

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 &&
    is_certificate_validation_enabled == other.is_certificate_validation_enabled &&
    is_default_snapshot_enabled == other.is_default_snapshot_enabled &&
    verify_texts == other.verify_texts &&
    verify_response_codes == other.verify_response_codes &&
    network_configuration == other.network_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



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/browser_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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [config_type, is_failure_retried, dns_configuration, is_certificate_validation_enabled, is_default_snapshot_enabled, verify_texts, verify_response_codes, network_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/apm_synthetics/models/browser_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



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

def to_s
  to_hash.to_s
end