Class: OCI::Database::Models::DataCollectionOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/data_collection_options.rb

Overview

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataCollectionOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/database/models/data_collection_options.rb', line 60

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.is_diagnostics_events_enabled = attributes[:'isDiagnosticsEventsEnabled'] unless attributes[:'isDiagnosticsEventsEnabled'].nil?

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

  self.is_diagnostics_events_enabled = attributes[:'is_diagnostics_events_enabled'] unless attributes[:'is_diagnostics_events_enabled'].nil?

  self.is_health_monitoring_enabled = attributes[:'isHealthMonitoringEnabled'] unless attributes[:'isHealthMonitoringEnabled'].nil?

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

  self.is_health_monitoring_enabled = attributes[:'is_health_monitoring_enabled'] unless attributes[:'is_health_monitoring_enabled'].nil?

  self.is_incident_logs_enabled = attributes[:'isIncidentLogsEnabled'] unless attributes[:'isIncidentLogsEnabled'].nil?

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

  self.is_incident_logs_enabled = attributes[:'is_incident_logs_enabled'] unless attributes[:'is_incident_logs_enabled'].nil?
end

Instance Attribute Details

#is_diagnostics_events_enabled ⇒ BOOLEAN

Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.

Returns:

  • (BOOLEAN) 


15
16
17
 
# File 'lib/oci/database/models/data_collection_options.rb', line 15

def is_diagnostics_events_enabled
  @is_diagnostics_events_enabled
end

#is_health_monitoring_enabled ⇒ BOOLEAN

Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.

Returns:

  • (BOOLEAN) 


21
22
23
 
# File 'lib/oci/database/models/data_collection_options.rb', line 21

def is_health_monitoring_enabled
  @is_health_monitoring_enabled
end

#is_incident_logs_enabled ⇒ BOOLEAN

Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

Returns:

  • (BOOLEAN) 


27
28
29
 
# File 'lib/oci/database/models/data_collection_options.rb', line 27

def is_incident_logs_enabled
  @is_incident_logs_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/database/models/data_collection_options.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_diagnostics_events_enabled': :'isDiagnosticsEventsEnabled',
    'is_health_monitoring_enabled': :'isHealthMonitoringEnabled',
    'is_incident_logs_enabled': :'isIncidentLogsEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/database/models/data_collection_options.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_diagnostics_events_enabled': :'BOOLEAN',
    'is_health_monitoring_enabled': :'BOOLEAN',
    'is_incident_logs_enabled': :'BOOLEAN'
    # 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



92
93
94
95
96
97
98
99
 
# File 'lib/oci/database/models/data_collection_options.rb', line 92

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

  self.class == other.class &&
    is_diagnostics_events_enabled == other.is_diagnostics_events_enabled &&
    is_health_monitoring_enabled == other.is_health_monitoring_enabled &&
    is_incident_logs_enabled == other.is_incident_logs_enabled
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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/database/models/data_collection_options.rb', line 124

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


104
105
106
 
# File 'lib/oci/database/models/data_collection_options.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/database/models/data_collection_options.rb', line 113

def hash
  [is_diagnostics_events_enabled, is_health_monitoring_enabled, is_incident_logs_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/database/models/data_collection_options.rb', line 157

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



151
152
153
 
# File 'lib/oci/database/models/data_collection_options.rb', line 151

def to_s
  to_hash.to_s
end