Class: OracleBMC::Core::Models::SecurityList

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/security_list.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityList

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 51

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}

  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'egressSecurityRules']
    self.egress_security_rules = attributes[:'egressSecurityRules']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'ingressSecurityRules']
    self.ingress_security_rules = attributes[:'ingressSecurityRules']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
  if attributes[:'vcnId']
    self.vcn_id = attributes[:'vcnId']
  end
  
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the security list.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 15

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 19

def display_name
  @display_name
end

#egress_security_rules ⇒ Array<OracleBMC::Core::Models::EgressSecurityRule>

Rules for allowing egress IP packets.

Returns:



23
24
25
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 23

def egress_security_rules
  @egress_security_rules
end

#id ⇒ String

The security list’s Oracle Cloud ID (OCID).

Returns:

  • (String) 


27
28
29
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 27

def id
  @id
end

#ingress_security_rules ⇒ Array<OracleBMC::Core::Models::IngressSecurityRule>

Rules for allowing ingress IP packets.

Returns:



31
32
33
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 31

def ingress_security_rules
  @ingress_security_rules
end

#lifecycle_state ⇒ String

The security list’s current state.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 35

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the security list was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 42

def time_created
  @time_created
end

#vcn_id ⇒ String

The OCID of the VCN the security list belongs to.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 46

def vcn_id
  @vcn_id
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 103

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      egress_security_rules == other_object.egress_security_rules &&
      id == other_object.id &&
      ingress_security_rules == other_object.ingress_security_rules &&
      lifecycle_state == other_object.lifecycle_state &&
      time_created == other_object.time_created &&
      vcn_id == other_object.vcn_id
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 131

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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", OracleBMC::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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


118
119
120
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 118

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 124

def hash
  [compartment_id, display_name, egress_security_rules, id, ingress_security_rules, lifecycle_state, time_created, vcn_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 156

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



150
151
152
 
# File 'lib/oraclebmc/core/models/security_list.rb', line 150

def to_s
  to_hash.to_s
end