Class: OCI::Core::Models::TunnelStatus

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

Overview

Deprecated. For tunnel information, instead see IPSecConnectionTunnel.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_UP = 'UP'.freeze,
  LIFECYCLE_STATE_DOWN = 'DOWN'.freeze,
  LIFECYCLE_STATE_DOWN_FOR_MAINTENANCE = 'DOWN_FOR_MAINTENANCE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TunnelStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :ip_address (String)

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

  • :time_state_modified (DateTime)

    The value to assign to the #time_state_modified property



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
# File 'lib/oci/core/models/tunnel_status.rb', line 78

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

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

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

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

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

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

Instance Attribute Details

#ip_addressString

[Required] The IP address of Oracle's VPN headend.

Example: 129.146.17.50

Returns:

  • (String)


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

def ip_address
  @ip_address
end

#lifecycle_stateString

The tunnel's current state.

Returns:

  • (String)


28
29
30
# File 'lib/oci/core/models/tunnel_status.rb', line 28

def lifecycle_state
  @lifecycle_state
end

#time_createdDateTime

The date and time the IPSec connection was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime)


35
36
37
# File 'lib/oci/core/models/tunnel_status.rb', line 35

def time_created
  @time_created
end

#time_state_modifiedDateTime

When the state of the tunnel last changed, in the format defined by RFC3339.

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

Returns:

  • (DateTime)


42
43
44
# File 'lib/oci/core/models/tunnel_status.rb', line 42

def time_state_modified
  @time_state_modified
end

Class Method Details

.attribute_mapObject

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



45
46
47
48
49
50
51
52
53
54
# File 'lib/oci/core/models/tunnel_status.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ip_address': :'ipAddress',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_state_modified': :'timeStateModified'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
# File 'lib/oci/core/models/tunnel_status.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'ip_address': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_state_modified': :'DateTime'
    # 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



129
130
131
132
133
134
135
136
137
# File 'lib/oci/core/models/tunnel_status.rb', line 129

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

  self.class == other.class &&
    ip_address == other.ip_address &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_state_modified == other.time_state_modified
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/oci/core/models/tunnel_status.rb', line 162

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


142
143
144
# File 'lib/oci/core/models/tunnel_status.rb', line 142

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



151
152
153
# File 'lib/oci/core/models/tunnel_status.rb', line 151

def hash
  [ip_address, lifecycle_state, time_created, time_state_modified].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
# File 'lib/oci/core/models/tunnel_status.rb', line 195

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



189
190
191
# File 'lib/oci/core/models/tunnel_status.rb', line 189

def to_s
  to_hash.to_s
end