Class: OracleBMC::Core::Models::InternetGateway

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/internet_gateway.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 = {}) ⇒ InternetGateway

Initializes the object

Parameters:

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

    Model attributes in the form of hash



50
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
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 50

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'isEnabled']
    self.is_enabled = attributes[:'isEnabled']
  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 Internet Gateway.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 16

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) 


20
21
22
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 20

def display_name
  @display_name
end

#id ⇒ String

The Internet Gateway’s Oracle ID (OCID).

Returns:

  • (String) 


24
25
26
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 24

def id
  @id
end

#is_enabled ⇒ BOOLEAN

Whether the gateway is enabled. When the gateway is disabled, traffic is not routed to/from the Internet, regardless of route rules.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 30

def is_enabled
  @is_enabled
end

#lifecycle_state ⇒ String

The Internet Gateway’s current state.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 34

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the Internet Gateway was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


41
42
43
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 41

def time_created
  @time_created
end

#vcn_id ⇒ String

The OCID of the VCN the Internet Gateway belongs to.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 45

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



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 99

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 &&
      id == other_object.id &&
      is_enabled == other_object.is_enabled &&
      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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 126

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


113
114
115
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 113

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 119

def hash
  [compartment_id, display_name, id, is_enabled, 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



151
152
153
154
155
156
157
158
159
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 151

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



145
146
147
 
# File 'lib/oraclebmc/core/models/internet_gateway.rb', line 145

def to_s
  to_hash.to_s
end