class OCI::Bastion::Models::CreateSessionDetails

The configuration details for a new bastion session. A session lets authorized users connect to a target resource for a predetermined amount of time. 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.

Constants

KEY_TYPE_ENUM

Attributes

bastion_id[RW]

[Required] The unique identifier (OCID) of the bastion on which to create this session. @return [String]

display_name[RW]

The name of the session. @return [String]

key_details[RW]

This attribute is required. @return [OCI::Bastion::Models::PublicKeyDetails]

key_type[R]

The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format. @return [String]

session_ttl_in_seconds[RW]

The amount of time the session can remain active. @return [Integer]

target_resource_details[RW]

This attribute is required. @return [OCI::Bastion::Models::CreateSessionTargetResourceDetails]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/bastion/models/create_session_details.rb, line 39
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'bastion_id': :'bastionId',
    'target_resource_details': :'targetResourceDetails',
    'key_type': :'keyType',
    'key_details': :'keyDetails',
    'session_ttl_in_seconds': :'sessionTtlInSeconds'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :bastion_id The value to assign to the {#bastion_id} property @option attributes [OCI::Bastion::Models::CreateSessionTargetResourceDetails] :target_resource_details The value to assign to the {#target_resource_details} property @option attributes [String] :key_type The value to assign to the {#key_type} property @option attributes [OCI::Bastion::Models::PublicKeyDetails] :key_details The value to assign to the {#key_details} property @option attributes [Integer] :session_ttl_in_seconds The value to assign to the {#session_ttl_in_seconds} property

# File lib/oci/bastion/models/create_session_details.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.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.bastion_id = attributes[:'bastionId'] if attributes[:'bastionId']

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

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

  self.target_resource_details = attributes[:'targetResourceDetails'] if attributes[:'targetResourceDetails']

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

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

  self.key_type = attributes[:'keyType'] if attributes[:'keyType']
  self.key_type = "PUB" if key_type.nil? && !attributes.key?(:'keyType') # rubocop:disable Style/StringLiterals

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

  self.key_type = attributes[:'key_type'] if attributes[:'key_type']
  self.key_type = "PUB" if key_type.nil? && !attributes.key?(:'keyType') && !attributes.key?(:'key_type') # rubocop:disable Style/StringLiterals

  self.key_details = attributes[:'keyDetails'] if attributes[:'keyDetails']

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

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

  self.session_ttl_in_seconds = attributes[:'sessionTtlInSeconds'] if attributes[:'sessionTtlInSeconds']

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

  self.session_ttl_in_seconds = attributes[:'session_ttl_in_seconds'] if attributes[:'session_ttl_in_seconds']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/bastion/models/create_session_details.rb, line 53
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'bastion_id': :'String',
    'target_resource_details': :'OCI::Bastion::Models::CreateSessionTargetResourceDetails',
    'key_type': :'String',
    'key_details': :'OCI::Bastion::Models::PublicKeyDetails',
    'session_ttl_in_seconds': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/bastion/models/create_session_details.rb, line 138
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    bastion_id == other.bastion_id &&
    target_resource_details == other.target_resource_details &&
    key_type == other.key_type &&
    key_details == other.key_details &&
    session_ttl_in_seconds == other.session_ttl_in_seconds
end
build_from_hash(attributes) click to toggle source

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/create_session_details.rb, line 173
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/bastion/models/create_session_details.rb, line 153
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/bastion/models/create_session_details.rb, line 162
def hash
  [display_name, bastion_id, target_resource_details, key_type, key_details, session_ttl_in_seconds].hash
end
key_type=(key_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] key_type Object to be assigned

# File lib/oci/bastion/models/create_session_details.rb, line 127
def key_type=(key_type)
  raise "Invalid value for 'key_type': this must be one of the values in KEY_TYPE_ENUM." if key_type && !KEY_TYPE_ENUM.include?(key_type)

  @key_type = key_type
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/bastion/models/create_session_details.rb, line 206
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/bastion/models/create_session_details.rb, line 200
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/create_session_details.rb, line 223
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