class OCI::Bastion::Models::TargetResourceDetails
Details about a bastion session's target resource. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Constants
- SESSION_TYPE_ENUM
Attributes
[Required] The Bastion
service recognizes two types of sessions, managed SSH sessions and SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running. @return [String]
[Required] The port number to connect to on the target resource. @return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/bastion/models/target_resource_details.rb, line 27 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'session_type': :'sessionType', 'target_resource_port': :'targetResourcePort' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/bastion/models/target_resource_details.rb, line 51 def self.get_subtype(object_hash) type = object_hash[:'sessionType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Bastion::Models::ManagedSshSessionTargetResourceDetails' if type == 'MANAGED_SSH' return 'OCI::Bastion::Models::PortForwardingSessionTargetResourceDetails' if type == 'PORT_FORWARDING' # TODO: Log a warning when the subtype is not found. 'OCI::Bastion::Models::TargetResourceDetails' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :session_type The value to assign to the {#session_type} property @option attributes [Integer] :target_resource_port The value to assign to the {#target_resource_port} property
# File lib/oci/bastion/models/target_resource_details.rb, line 70 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.session_type = attributes[:'sessionType'] if attributes[:'sessionType'] raise 'You cannot provide both :sessionType and :session_type' if attributes.key?(:'sessionType') && attributes.key?(:'session_type') self.session_type = attributes[:'session_type'] if attributes[:'session_type'] 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
Attribute type mapping.
# File lib/oci/bastion/models/target_resource_details.rb, line 37 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'session_type': :'String', 'target_resource_port': :'Integer' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/bastion/models/target_resource_details.rb, line 109 def ==(other) return true if equal?(other) self.class == other.class && session_type == other.session_type && target_resource_port == other.target_resource_port end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/bastion/models/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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/bastion/models/target_resource_details.rb, line 120 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/bastion/models/target_resource_details.rb, line 129 def hash [session_type, target_resource_port].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] session_type
Object
to be assigned
# File lib/oci/bastion/models/target_resource_details.rb, line 93 def session_type=(session_type) # rubocop:disable Style/ConditionalAssignment if session_type && !SESSION_TYPE_ENUM.include?(session_type) OCI.logger.debug("Unknown value for 'session_type' [" + session_type + "]. Mapping to 'SESSION_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @session_type = SESSION_TYPE_UNKNOWN_ENUM_VALUE else @session_type = session_type end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/bastion/models/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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/bastion/models/target_resource_details.rb, line 167 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/bastion/models/target_resource_details.rb, line 190 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end