File: //proc/self/root/lib/mysqlsh/lib/python3.8/site-packages/oci/bastion/models/session.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210331
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class Session(object):
"""
A bastion session resource. A bastion session lets authorized users connect to a target resource using a Secure Shell (SSH) for a predetermined amount of time.
"""
#: A constant which can be used with the key_type property of a Session.
#: This constant has a value of "PUB"
KEY_TYPE_PUB = "PUB"
#: A constant which can be used with the lifecycle_state property of a Session.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a Session.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a Session.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a Session.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
#: A constant which can be used with the lifecycle_state property of a Session.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
def __init__(self, **kwargs):
"""
Initializes a new Session object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param id:
The value to assign to the id property of this Session.
:type id: str
:param display_name:
The value to assign to the display_name property of this Session.
:type display_name: str
:param bastion_id:
The value to assign to the bastion_id property of this Session.
:type bastion_id: str
:param bastion_name:
The value to assign to the bastion_name property of this Session.
:type bastion_name: str
:param bastion_user_name:
The value to assign to the bastion_user_name property of this Session.
:type bastion_user_name: str
:param target_resource_details:
The value to assign to the target_resource_details property of this Session.
:type target_resource_details: oci.bastion.models.TargetResourceDetails
:param ssh_metadata:
The value to assign to the ssh_metadata property of this Session.
:type ssh_metadata: dict(str, str)
:param key_type:
The value to assign to the key_type property of this Session.
Allowed values for this property are: "PUB", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type key_type: str
:param key_details:
The value to assign to the key_details property of this Session.
:type key_details: oci.bastion.models.PublicKeyDetails
:param bastion_public_host_key_info:
The value to assign to the bastion_public_host_key_info property of this Session.
:type bastion_public_host_key_info: str
:param time_created:
The value to assign to the time_created property of this Session.
:type time_created: datetime
:param time_updated:
The value to assign to the time_updated property of this Session.
:type time_updated: datetime
:param lifecycle_state:
The value to assign to the lifecycle_state property of this Session.
Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param lifecycle_details:
The value to assign to the lifecycle_details property of this Session.
:type lifecycle_details: str
:param session_ttl_in_seconds:
The value to assign to the session_ttl_in_seconds property of this Session.
:type session_ttl_in_seconds: int
"""
self.swagger_types = {
'id': 'str',
'display_name': 'str',
'bastion_id': 'str',
'bastion_name': 'str',
'bastion_user_name': 'str',
'target_resource_details': 'TargetResourceDetails',
'ssh_metadata': 'dict(str, str)',
'key_type': 'str',
'key_details': 'PublicKeyDetails',
'bastion_public_host_key_info': 'str',
'time_created': 'datetime',
'time_updated': 'datetime',
'lifecycle_state': 'str',
'lifecycle_details': 'str',
'session_ttl_in_seconds': 'int'
}
self.attribute_map = {
'id': 'id',
'display_name': 'displayName',
'bastion_id': 'bastionId',
'bastion_name': 'bastionName',
'bastion_user_name': 'bastionUserName',
'target_resource_details': 'targetResourceDetails',
'ssh_metadata': 'sshMetadata',
'key_type': 'keyType',
'key_details': 'keyDetails',
'bastion_public_host_key_info': 'bastionPublicHostKeyInfo',
'time_created': 'timeCreated',
'time_updated': 'timeUpdated',
'lifecycle_state': 'lifecycleState',
'lifecycle_details': 'lifecycleDetails',
'session_ttl_in_seconds': 'sessionTtlInSeconds'
}
self._id = None
self._display_name = None
self._bastion_id = None
self._bastion_name = None
self._bastion_user_name = None
self._target_resource_details = None
self._ssh_metadata = None
self._key_type = None
self._key_details = None
self._bastion_public_host_key_info = None
self._time_created = None
self._time_updated = None
self._lifecycle_state = None
self._lifecycle_details = None
self._session_ttl_in_seconds = None
@property
def id(self):
"""
**[Required]** Gets the id of this Session.
The unique identifier (OCID) of the session, which can't be changed after creation.
:return: The id of this Session.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this Session.
The unique identifier (OCID) of the session, which can't be changed after creation.
:param id: The id of this Session.
:type: str
"""
self._id = id
@property
def display_name(self):
"""
Gets the display_name of this Session.
The name of the session.
:return: The display_name of this Session.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this Session.
The name of the session.
:param display_name: The display_name of this Session.
:type: str
"""
self._display_name = display_name
@property
def bastion_id(self):
"""
**[Required]** Gets the bastion_id of this Session.
The unique identifier (OCID) of the bastion that is hosting this session.
:return: The bastion_id of this Session.
:rtype: str
"""
return self._bastion_id
@bastion_id.setter
def bastion_id(self, bastion_id):
"""
Sets the bastion_id of this Session.
The unique identifier (OCID) of the bastion that is hosting this session.
:param bastion_id: The bastion_id of this Session.
:type: str
"""
self._bastion_id = bastion_id
@property
def bastion_name(self):
"""
**[Required]** Gets the bastion_name of this Session.
The name of the bastion that is hosting this session.
:return: The bastion_name of this Session.
:rtype: str
"""
return self._bastion_name
@bastion_name.setter
def bastion_name(self, bastion_name):
"""
Sets the bastion_name of this Session.
The name of the bastion that is hosting this session.
:param bastion_name: The bastion_name of this Session.
:type: str
"""
self._bastion_name = bastion_name
@property
def bastion_user_name(self):
"""
Gets the bastion_user_name of this Session.
The username that the session uses to connect to the target resource.
:return: The bastion_user_name of this Session.
:rtype: str
"""
return self._bastion_user_name
@bastion_user_name.setter
def bastion_user_name(self, bastion_user_name):
"""
Sets the bastion_user_name of this Session.
The username that the session uses to connect to the target resource.
:param bastion_user_name: The bastion_user_name of this Session.
:type: str
"""
self._bastion_user_name = bastion_user_name
@property
def target_resource_details(self):
"""
**[Required]** Gets the target_resource_details of this Session.
:return: The target_resource_details of this Session.
:rtype: oci.bastion.models.TargetResourceDetails
"""
return self._target_resource_details
@target_resource_details.setter
def target_resource_details(self, target_resource_details):
"""
Sets the target_resource_details of this Session.
:param target_resource_details: The target_resource_details of this Session.
:type: oci.bastion.models.TargetResourceDetails
"""
self._target_resource_details = target_resource_details
@property
def ssh_metadata(self):
"""
Gets the ssh_metadata of this Session.
The connection message for the session.
:return: The ssh_metadata of this Session.
:rtype: dict(str, str)
"""
return self._ssh_metadata
@ssh_metadata.setter
def ssh_metadata(self, ssh_metadata):
"""
Sets the ssh_metadata of this Session.
The connection message for the session.
:param ssh_metadata: The ssh_metadata of this Session.
:type: dict(str, str)
"""
self._ssh_metadata = ssh_metadata
@property
def key_type(self):
"""
Gets the key_type of this Session.
The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.
Allowed values for this property are: "PUB", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The key_type of this Session.
:rtype: str
"""
return self._key_type
@key_type.setter
def key_type(self, key_type):
"""
Sets the key_type of this Session.
The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.
:param key_type: The key_type of this Session.
:type: str
"""
allowed_values = ["PUB"]
if not value_allowed_none_or_none_sentinel(key_type, allowed_values):
key_type = 'UNKNOWN_ENUM_VALUE'
self._key_type = key_type
@property
def key_details(self):
"""
**[Required]** Gets the key_details of this Session.
:return: The key_details of this Session.
:rtype: oci.bastion.models.PublicKeyDetails
"""
return self._key_details
@key_details.setter
def key_details(self, key_details):
"""
Sets the key_details of this Session.
:param key_details: The key_details of this Session.
:type: oci.bastion.models.PublicKeyDetails
"""
self._key_details = key_details
@property
def bastion_public_host_key_info(self):
"""
Gets the bastion_public_host_key_info of this Session.
The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion.
:return: The bastion_public_host_key_info of this Session.
:rtype: str
"""
return self._bastion_public_host_key_info
@bastion_public_host_key_info.setter
def bastion_public_host_key_info(self, bastion_public_host_key_info):
"""
Sets the bastion_public_host_key_info of this Session.
The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion.
:param bastion_public_host_key_info: The bastion_public_host_key_info of this Session.
:type: str
"""
self._bastion_public_host_key_info = bastion_public_host_key_info
@property
def time_created(self):
"""
**[Required]** Gets the time_created of this Session.
The time the session was created. Format is defined by `RFC3339`__.
Example: `2020-01-25T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The time_created of this Session.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this Session.
The time the session was created. Format is defined by `RFC3339`__.
Example: `2020-01-25T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param time_created: The time_created of this Session.
:type: datetime
"""
self._time_created = time_created
@property
def time_updated(self):
"""
Gets the time_updated of this Session.
The time the session was updated. Format is defined by `RFC3339`__.
Example: `2020-01-25T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:return: The time_updated of this Session.
:rtype: datetime
"""
return self._time_updated
@time_updated.setter
def time_updated(self, time_updated):
"""
Sets the time_updated of this Session.
The time the session was updated. Format is defined by `RFC3339`__.
Example: `2020-01-25T21:10:29.600Z`
__ https://tools.ietf.org/html/rfc3339
:param time_updated: The time_updated of this Session.
:type: datetime
"""
self._time_updated = time_updated
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this Session.
The current state of the session.
Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this Session.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this Session.
The current state of the session.
:param lifecycle_state: The lifecycle_state of this Session.
:type: str
"""
allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
lifecycle_state = 'UNKNOWN_ENUM_VALUE'
self._lifecycle_state = lifecycle_state
@property
def lifecycle_details(self):
"""
Gets the lifecycle_details of this Session.
A message describing the current session state in more detail.
:return: The lifecycle_details of this Session.
:rtype: str
"""
return self._lifecycle_details
@lifecycle_details.setter
def lifecycle_details(self, lifecycle_details):
"""
Sets the lifecycle_details of this Session.
A message describing the current session state in more detail.
:param lifecycle_details: The lifecycle_details of this Session.
:type: str
"""
self._lifecycle_details = lifecycle_details
@property
def session_ttl_in_seconds(self):
"""
**[Required]** Gets the session_ttl_in_seconds of this Session.
The amount of time the session can remain active.
:return: The session_ttl_in_seconds of this Session.
:rtype: int
"""
return self._session_ttl_in_seconds
@session_ttl_in_seconds.setter
def session_ttl_in_seconds(self, session_ttl_in_seconds):
"""
Sets the session_ttl_in_seconds of this Session.
The amount of time the session can remain active.
:param session_ttl_in_seconds: The session_ttl_in_seconds of this Session.
:type: int
"""
self._session_ttl_in_seconds = session_ttl_in_seconds
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other