Class: OCI::VnMonitoring::Models::FlexTunnel

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vn_monitoring/models/flex_tunnel.rb

Overview

Flex tunnel will set up a network tunnel between your SD-WAN appliance and DRG, allowing you to establish BGP and advertise routes.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlexTunnel

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 122

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

  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.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.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.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.drg_id = attributes[:'drgId'] if attributes[:'drgId']

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

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

  self.transport_attachment_id = attributes[:'transportAttachmentId'] if attributes[:'transportAttachmentId']

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

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

  self.flex_tunnel_configuration = attributes[:'flexTunnelConfiguration'] if attributes[:'flexTunnelConfiguration']

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

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

  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.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']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment to contain the flex tunnel.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 26

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>>) 


68
69
70
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 68

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) 


32
33
34
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 32

def display_name
  @display_name
end

#drg_id ⇒ String

[Required] The OCID of the drg for loopback attachment.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 48

def drg_id
  @drg_id
end

#flex_tunnel_configuration ⇒ OCI::VnMonitoring::Models::FlexTunnelConfiguration

This attribute is required.

Returns:



56
57
58
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 56

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the flex tunnel.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 22

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the flex tunnel.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#transport_attachment_id ⇒ String

[Required] The OCID of the transport attachment.

Returns:

  • (String) 


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

def transport_attachment_id
  @transport_attachment_id
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'drg_id': :'drgId',
    'transport_attachment_id': :'transportAttachmentId',
    'flex_tunnel_configuration': :'flexTunnelConfiguration',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'drg_id': :'String',
    'transport_attachment_id': :'String',
    'flex_tunnel_configuration': :'OCI::VnMonitoring::Models::FlexTunnelConfiguration',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 200

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    drg_id == other.drg_id &&
    transport_attachment_id == other.transport_attachment_id &&
    flex_tunnel_configuration == other.flex_tunnel_configuration &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 239

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


219
220
221
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 219

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 228

def hash
  [id, compartment_id, display_name, time_created, lifecycle_state, drg_id, transport_attachment_id, flex_tunnel_configuration, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 272

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



266
267
268
 
# File 'lib/oci/vn_monitoring/models/flex_tunnel.rb', line 266

def to_s
  to_hash.to_s
end