Class: OCI::Core::Models::SecurityList

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/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',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/core/models/security_list.rb', line 71

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[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

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

  if attributes[:'egressSecurityRules']
    self.egress_security_rules = attributes[:'egressSecurityRules']
  end

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  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) 


16
17
18
 
# File 'lib/oci/core/models/security_list.rb', line 16

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


24
25
26
 
# File 'lib/oci/core/models/security_list.rb', line 24

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/core/models/security_list.rb', line 30

def display_name
  @display_name
end

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

Rules for allowing egress IP packets.

Returns:



34
35
36
 
# File 'lib/oci/core/models/security_list.rb', line 34

def egress_security_rules
  @egress_security_rules
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


43
44
45
 
# File 'lib/oci/core/models/security_list.rb', line 43

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/core/models/security_list.rb', line 47

def id
  @id
end

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

Rules for allowing ingress IP packets.

Returns:



51
52
53
 
# File 'lib/oci/core/models/security_list.rb', line 51

def ingress_security_rules
  @ingress_security_rules
end

#lifecycle_state ⇒ String

The security list’s current state.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/core/models/security_list.rb', line 55

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) 


62
63
64
 
# File 'lib/oci/core/models/security_list.rb', line 62

def time_created
  @time_created
end

#vcn_id ⇒ String

The OCID of the VCN the security list belongs to.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/core/models/security_list.rb', line 66

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



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

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      defined_tags == other_object.defined_tags &&
      display_name == other_object.display_name &&
      egress_security_rules == other_object.egress_security_rules &&
      freeform_tags == other_object.freeform_tags &&
      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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/core/models/security_list.rb', line 161

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


148
149
150
 
# File 'lib/oci/core/models/security_list.rb', line 148

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/oci/core/models/security_list.rb', line 154

def hash
  [compartment_id, defined_tags, display_name, egress_security_rules, freeform_tags, 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



186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/core/models/security_list.rb', line 186

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



180
181
182
 
# File 'lib/oci/core/models/security_list.rb', line 180

def to_s
  to_hash.to_s
end