Class: OCI::FleetSoftwareUpdate::Models::GiFleetDiscoveryFilter

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

Overview

Possible Discovery filters.

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_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 = {}) ⇒ GiFleetDiscoveryFilter

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



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 87

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

#mode ⇒ String

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

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 38

def mode
  @mode
end

#type ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 32

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 41

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.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 65

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

  return 'OCI::FleetSoftwareUpdate::Models::GiDefinedTagsFilter' if type == 'DEFINED_TAG'
  return 'OCI::FleetSoftwareUpdate::Models::GiCompartmentIdFilter' if type == 'COMPARTMENT_ID'
  return 'OCI::FleetSoftwareUpdate::Models::GiFreeformTagsFilter' if type == 'FREEFORM_TAG'
  return 'OCI::FleetSoftwareUpdate::Models::GiResourceIdFilter' if type == 'RESOURCE_ID'
  return 'OCI::FleetSoftwareUpdate::Models::GiVersionFilter' if type == 'VERSION'

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

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 51

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



132
133
134
135
136
137
138
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 132

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 163

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


143
144
145
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 152

def hash
  [type, mode].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 196

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



190
191
192
 
# File 'lib/oci/fleet_software_update/models/gi_fleet_discovery_filter.rb', line 190

def to_s
  to_hash.to_s
end