Class: OCI::VnMonitoring::Models::LocalPeeringGateway

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vn_monitoring/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.

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.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PEERING_STATUS_ENUM = 
[
  PEERING_STATUS_INVALID = 'INVALID'.freeze,
  PEERING_STATUS_NEW = 'NEW'.freeze,
  PEERING_STATUS_PEERED = 'PEERED'.freeze,
  PEERING_STATUS_PENDING = 'PENDING'.freeze,
  PEERING_STATUS_REVOKED = 'REVOKED'.freeze,
  PEERING_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method 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

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

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



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 165

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 }

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

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

  self.is_cross_tenancy_peering = attributes[:'isCrossTenancyPeering'] unless attributes[:'isCrossTenancyPeering'].nil?

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

  self.is_cross_tenancy_peering = attributes[:'is_cross_tenancy_peering'] unless attributes[:'is_cross_tenancy_peering'].nil?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the LPG.

Returns:

  • (String) 


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

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


46
47
48
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 46

def defined_tags
  @defined_tags
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) 


52
53
54
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 52

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


58
59
60
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 58

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 62

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) 


69
70
71
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 69

def is_cross_tenancy_peering
  @is_cross_tenancy_peering
end

#lifecycle_state ⇒ String

[Required] The LPG's current lifecycle state.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 73

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) 


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

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) 


90
91
92
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 90

def peering_status
  @peering_status
end

#peering_status_details ⇒ String

Additional information regarding the peering status, if applicable.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 94

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) 


101
102
103
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 101

def time_created
  @time_created
end

#vcn_id ⇒ String

[Required] The OCID of the VCN that uses the LPG.

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 105

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 108

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'is_cross_tenancy_peering': :'isCrossTenancyPeering',
    'lifecycle_state': :'lifecycleState',
    'peer_advertised_cidr': :'peerAdvertisedCidr',
    'peering_status': :'peeringStatus',
    'peering_status_details': :'peeringStatusDetails',
    'time_created': :'timeCreated',
    'vcn_id': :'vcnId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'is_cross_tenancy_peering': :'BOOLEAN',
    'lifecycle_state': :'String',
    'peer_advertised_cidr': :'String',
    'peering_status': :'String',
    'peering_status_details': :'String',
    'time_created': :'DateTime',
    'vcn_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 273

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    is_cross_tenancy_peering == other.is_cross_tenancy_peering &&
    lifecycle_state == other.lifecycle_state &&
    peer_advertised_cidr == other.peer_advertised_cidr &&
    peering_status == other.peering_status &&
    peering_status_details == other.peering_status_details &&
    time_created == other.time_created &&
    vcn_id == other.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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 314

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


294
295
296
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 294

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 303

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



347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 347

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



341
342
343
 
# File 'lib/oci/vn_monitoring/models/local_peering_gateway.rb', line 341

def to_s
  to_hash.to_s
end