Class: OCI::Core::Models::LocalPeeringGateway

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

Overview

A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. Peering means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see [VCN Peering](docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm).

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']
PEERING_STATUS_ENUM = 
[PEERING_STATUS_INVALID = 'INVALID',
PEERING_STATUS_NEW = 'NEW',
PEERING_STATUS_PEERED = 'PEERED',
PEERING_STATUS_PENDING = 'PENDING',
PEERING_STATUS_REVOKED = 'REVOKED',
PEERING_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LocalPeeringGateway

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_cross_tenancy_peering (BOOLEAN) —

    The value to assign to the #is_cross_tenancy_peering property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :peer_advertised_cidr (String) —

    The value to assign to the #peer_advertised_cidr property

  • :peering_status (String) —

    The value to assign to the #peering_status property

  • :peering_status_details (String) —

    The value to assign to the #peering_status_details 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



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 102

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[:'isCrossTenancyPeering'].nil?
    self.is_cross_tenancy_peering = attributes[:'isCrossTenancyPeering']
  end

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

  unless attributes[:'is_cross_tenancy_peering'].nil?
    self.is_cross_tenancy_peering = attributes[:'is_cross_tenancy_peering']
  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[:'peerAdvertisedCidr']
    self.peer_advertised_cidr = attributes[:'peerAdvertisedCidr']
  end

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

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

  if attributes[:'peeringStatus']
    self.peering_status = attributes[:'peeringStatus']
  end

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

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

  if attributes[:'peeringStatusDetails']
    self.peering_status_details = attributes[:'peeringStatusDetails']
  end

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

  if attributes[:'peering_status_details']
    self.peering_status_details = attributes[:'peering_status_details']
  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 LPG.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#is_cross_tenancy_peering ⇒ BOOLEAN

[Required] Whether the VCN at the other end of the peering is in a different tenancy.

Example: ‘false`

Returns:

  • (BOOLEAN) 


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

def is_cross_tenancy_peering
  @is_cross_tenancy_peering
end

#lifecycle_state ⇒ String

[Required] The LPG’s current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#peer_advertised_cidr ⇒ String

The range of IP addresses available on the VCN at the other end of the peering from this LPG. The value is ‘null` if the LPG is not peered. You can use this as the destination CIDR for a route rule to route a subnet’s traffic to this LPG.

Example: ‘192.168.0.0/16`

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 65

def peer_advertised_cidr
  @peer_advertised_cidr
end

#peering_status ⇒ String

[Required] Whether the LPG is peered with another LPG. ‘NEW` means the LPG has not yet been peered. `PENDING` means the peering is being established. `REVOKED` means the LPG at the other end of the peering has been deleted.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 72

def peering_status
  @peering_status
end

#peering_status_details ⇒ String

Additional information regarding the peering status, if applicable.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 76

def peering_status_details
  @peering_status_details
end

#time_created ⇒ DateTime

[Required] The date and time the LPG was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 83

def time_created
  @time_created
end

#vcn_id ⇒ String

[Required] The OCID of the VCN the LPG belongs to.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 87

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 226

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_cross_tenancy_peering == other_object.is_cross_tenancy_peering &&
      lifecycle_state == other_object.lifecycle_state &&
      peer_advertised_cidr == other_object.peer_advertised_cidr &&
      peering_status == other_object.peering_status &&
      peering_status_details == other_object.peering_status_details &&
      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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 256

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


243
244
245
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 243

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



249
250
251
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 249

def hash
  [compartment_id, display_name, id, is_cross_tenancy_peering, lifecycle_state, peer_advertised_cidr, peering_status, peering_status_details, 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



281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 281

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



275
276
277
 
# File 'lib/oci/core/models/local_peering_gateway.rb', line 275

def to_s
  to_hash.to_s
end