Class: OCI::CloudGuard::Models::EntitiesMapping

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/entities_mapping.rb

Overview

Parameters for entities mapping to data source.

Constant Summary collapse

ENTITY_TYPE_ENUM = 
[
  ENTITY_TYPE_EXTERNAL_IP = 'EXTERNAL_IP'.freeze,
  ENTITY_TYPE_INTERNAL_IP = 'INTERNAL_IP'.freeze,
  ENTITY_TYPE_TEXT = 'TEXT'.freeze,
  ENTITY_TYPE_JSON_LIST = 'JSON_LIST'.freeze,
  ENTITY_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 = {}) ⇒ EntitiesMapping

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :query_field (String) —

    The value to assign to the #query_field property

  • :entity_type (String) —

    The value to assign to the #entity_type property



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 63

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

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

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

  self.query_field = attributes[:'queryField'] if attributes[:'queryField']

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

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

  self.entity_type = attributes[:'entityType'] if attributes[:'entityType']

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

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

Instance Attribute Details

#display_name ⇒ String

Display name of the entity

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 22

def display_name
  @display_name
end

#entity_type ⇒ String

Type of entity

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 30

def entity_type
  @entity_type
end

#query_field ⇒ String

[Required] The entity value mapped to a data source query

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 26

def query_field
  @query_field
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'query_field': :'queryField',
    'entity_type': :'entityType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 44

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



108
109
110
111
112
113
114
115
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 108

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

  self.class == other.class &&
    display_name == other.display_name &&
    query_field == other.query_field &&
    entity_type == other.entity_type
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 140

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


120
121
122
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 129

def hash
  [display_name, query_field, entity_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 173

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



167
168
169
 
# File 'lib/oci/cloud_guard/models/entities_mapping.rb', line 167

def to_s
  to_hash.to_s
end