Class: OCI::Core::Models::InternetGateway

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/internet_gateway.rb

Overview

Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an Internet Gateway, see [Typical Networking Service Scenarios](docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm#scenarios).

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

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

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property



67
68
69
70
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/core/models/internet_gateway.rb', line 67

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

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

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

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

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

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

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

  unless attributes[:'isEnabled'].nil?
    self.is_enabled = attributes[:'isEnabled']
  end

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

  unless attributes[:'is_enabled'].nil?
    self.is_enabled = attributes[:'is_enabled']
  end

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

  if attributes[:'vcnId']
    self.vcn_id = attributes[:'vcnId']
  end

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the Internet Gateway.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
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/internet_gateway.rb', line 30

def display_name
  @display_name
end

#id ⇒ String

[Required] The Internet Gateway’s Oracle ID (OCID).

Returns:

  • (String) 


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

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) 


40
41
42
 
# File 'lib/oci/core/models/internet_gateway.rb', line 40

def is_enabled
  @is_enabled
end

#lifecycle_state ⇒ String

[Required] The Internet Gateway’s current state.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/core/models/internet_gateway.rb', line 44

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) 


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

def time_created
  @time_created
end

#vcn_id ⇒ String

[Required] The OCID of the VCN the Internet Gateway belongs to.

Returns:

  • (String) 


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

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



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

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/core/models/internet_gateway.rb', line 178

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


165
166
167
 
# File 'lib/oci/core/models/internet_gateway.rb', line 165

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/oci/core/models/internet_gateway.rb', line 171

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



203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/core/models/internet_gateway.rb', line 203

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



197
198
199
 
# File 'lib/oci/core/models/internet_gateway.rb', line 197

def to_s
  to_hash.to_s
end