Class: OCI::Bastion::Models::CreatePortForwardingSessionTargetResourceDetails

Inherits:
CreateSessionTargetResourceDetails show all
Defined in:
lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb

Overview

Details about a port forwarding session for a target resource.

Constant Summary

Constants inherited from CreateSessionTargetResourceDetails

OCI::Bastion::Models::CreateSessionTargetResourceDetails::SESSION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateSessionTargetResourceDetails

#session_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateSessionTargetResourceDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreatePortForwardingSessionTargetResourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
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
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 64

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['sessionType'] = 'PORT_FORWARDING'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.target_resource_id = attributes[:'targetResourceId'] if attributes[:'targetResourceId']

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

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

  self.target_resource_private_ip_address = attributes[:'targetResourcePrivateIpAddress'] if attributes[:'targetResourcePrivateIpAddress']

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

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

  self.target_resource_fqdn = attributes[:'targetResourceFqdn'] if attributes[:'targetResourceFqdn']

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

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

  self.target_resource_port = attributes[:'targetResourcePort'] if attributes[:'targetResourcePort']

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

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

Instance Attribute Details

#target_resource_fqdn ⇒ String

The Fully Qualified Domain Name of the target resource that the session connects to.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 22

def target_resource_fqdn
  @target_resource_fqdn
end

#target_resource_id ⇒ String

The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 14

def target_resource_id
  @target_resource_id
end

#target_resource_port ⇒ Integer

The port number to connect to on the target resource.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 26

def target_resource_port
  @target_resource_port
end

#target_resource_private_ip_address ⇒ String

The private IP address of the target resource that the session connects to.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 18

def target_resource_private_ip_address
  @target_resource_private_ip_address
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'session_type': :'sessionType',
    'target_resource_id': :'targetResourceId',
    'target_resource_private_ip_address': :'targetResourcePrivateIpAddress',
    'target_resource_fqdn': :'targetResourceFqdn',
    'target_resource_port': :'targetResourcePort'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'session_type': :'String',
    'target_resource_id': :'String',
    'target_resource_private_ip_address': :'String',
    'target_resource_fqdn': :'String',
    'target_resource_port': :'Integer'
    # 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



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 106

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

  self.class == other.class &&
    session_type == other.session_type &&
    target_resource_id == other.target_resource_id &&
    target_resource_private_ip_address == other.target_resource_private_ip_address &&
    target_resource_fqdn == other.target_resource_fqdn &&
    target_resource_port == other.target_resource_port
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 140

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


120
121
122
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 129

def hash
  [session_type, target_resource_id, target_resource_private_ip_address, target_resource_fqdn, target_resource_port].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 173

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



167
168
169
 
# File 'lib/oci/bastion/models/create_port_forwarding_session_target_resource_details.rb', line 167

def to_s
  to_hash.to_s
end