Class: OCI::FleetSoftwareUpdate::Models::DbFleetDiscoveryFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb

Overview

Possible Discovery filters for Database targets.

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

TYPE_ENUM =
[
  TYPE_COMPARTMENT_ID = 'COMPARTMENT_ID'.freeze,
  TYPE_VERSION = 'VERSION'.freeze,
  TYPE_DB_NAME = 'DB_NAME'.freeze,
  TYPE_DB_UNIQUE_NAME = 'DB_UNIQUE_NAME'.freeze,
  TYPE_DB_HOME_NAME = 'DB_HOME_NAME'.freeze,
  TYPE_FREEFORM_TAG = 'FREEFORM_TAG'.freeze,
  TYPE_DEFINED_TAG = 'DEFINED_TAG'.freeze,
  TYPE_RESOURCE_ID = 'RESOURCE_ID'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MODE_ENUM =
[
  MODE_INCLUDE = 'INCLUDE'.freeze,
  MODE_EXCLUDE = 'EXCLUDE'.freeze,
  MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbFleetDiscoveryFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String)

    The value to assign to the #type property

  • :mode (String)

    The value to assign to the #mode property



93
94
95
96
97
98
99
100
101
102
103
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 93

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

  self.mode = attributes[:'mode'] if attributes[:'mode']
  self.mode = "INCLUDE" if mode.nil? && !attributes.key?(:'mode') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#modeString

INCLUDE or EXCLUDE the filter results in the discovery for DB targets. Supported for 'FSUCOLLECTION' RESOURCE_ID filter only.

Returns:

  • (String)


41
42
43
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 41

def mode
  @mode
end

#typeString

[Required] Type of filters supported for Database targets discovery.

Returns:

  • (String)


35
36
37
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 35

def type
  @type
end

Class Method Details

.attribute_mapObject

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



44
45
46
47
48
49
50
51
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'mode': :'mode'
    # 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.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 68

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

  return 'OCI::FleetSoftwareUpdate::Models::DbDefinedTagsFilter' if type == 'DEFINED_TAG'
  return 'OCI::FleetSoftwareUpdate::Models::DbUniqueNameFilter' if type == 'DB_UNIQUE_NAME'
  return 'OCI::FleetSoftwareUpdate::Models::DbVersionFilter' if type == 'VERSION'
  return 'OCI::FleetSoftwareUpdate::Models::DbResourceIdFilter' if type == 'RESOURCE_ID'
  return 'OCI::FleetSoftwareUpdate::Models::DbHomeNameFilter' if type == 'DB_HOME_NAME'
  return 'OCI::FleetSoftwareUpdate::Models::DbCompartmentIdFilter' if type == 'COMPARTMENT_ID'
  return 'OCI::FleetSoftwareUpdate::Models::DbNameFilter' if type == 'DB_NAME'
  return 'OCI::FleetSoftwareUpdate::Models::DbFreeformTagsFilter' if type == 'FREEFORM_TAG'

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

.swagger_typesObject

Attribute type mapping.



54
55
56
57
58
59
60
61
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'mode': :'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



138
139
140
141
142
143
144
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 138

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

  self.class == other.class &&
    type == other.type &&
    mode == other.mode
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



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

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


149
150
151
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 149

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



158
159
160
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 158

def hash
  [type, mode].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 202

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



196
197
198
# File 'lib/oci/fleet_software_update/models/db_fleet_discovery_filter.rb', line 196

def to_s
  to_hash.to_s
end