SessionSummary¶
-
class
oci.bastion.models.
SessionSummary
(**kwargs)¶ Bases:
object
Summary information for a bastion session resource.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a SessionSummary. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a SessionSummary. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a SessionSummary. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a SessionSummary. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a SessionSummary. bastion_id
[Required] Gets the bastion_id of this SessionSummary. bastion_name
[Required] Gets the bastion_name of this SessionSummary. display_name
Gets the display_name of this SessionSummary. id
[Required] Gets the id of this SessionSummary. lifecycle_details
Gets the lifecycle_details of this SessionSummary. lifecycle_state
[Required] Gets the lifecycle_state of this SessionSummary. session_ttl_in_seconds
[Required] Gets the session_ttl_in_seconds of this SessionSummary. target_resource_details
[Required] Gets the target_resource_details of this SessionSummary. time_created
[Required] Gets the time_created of this SessionSummary. time_updated
Gets the time_updated of this SessionSummary. Methods
__init__
(**kwargs)Initializes a new SessionSummary object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a SessionSummary. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a SessionSummary. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a SessionSummary. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a SessionSummary. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a SessionSummary. This constant has a value of “FAILED”
-
__init__
(**kwargs)¶ Initializes a new SessionSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - id (str) – The value to assign to the id property of this SessionSummary.
- display_name (str) – The value to assign to the display_name property of this SessionSummary.
- bastion_name (str) – The value to assign to the bastion_name property of this SessionSummary.
- bastion_id (str) – The value to assign to the bastion_id property of this SessionSummary.
- target_resource_details (oci.bastion.models.TargetResourceDetails) – The value to assign to the target_resource_details property of this SessionSummary.
- time_created (datetime) – The value to assign to the time_created property of this SessionSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this SessionSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this SessionSummary. 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’.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this SessionSummary.
- session_ttl_in_seconds (int) – The value to assign to the session_ttl_in_seconds property of this SessionSummary.
-
bastion_id
¶ [Required] Gets the bastion_id of this SessionSummary. The unique identifier (OCID) of the bastion that is hosting this session.
Returns: The bastion_id of this SessionSummary. Return type: str
-
bastion_name
¶ [Required] Gets the bastion_name of this SessionSummary. The name of the bastion that is hosting this session.
Returns: The bastion_name of this SessionSummary. Return type: str
-
display_name
¶ Gets the display_name of this SessionSummary. The name of the session.
Returns: The display_name of this SessionSummary. Return type: str
-
id
¶ [Required] Gets the id of this SessionSummary. The unique identifier (OCID) of the session, which can’t be changed after creation.
Returns: The id of this SessionSummary. Return type: str
-
lifecycle_details
¶ Gets the lifecycle_details of this SessionSummary. A message describing the current session state in more detail.
Returns: The lifecycle_details of this SessionSummary. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this SessionSummary. 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’.
Returns: The lifecycle_state of this SessionSummary. Return type: str
-
session_ttl_in_seconds
¶ [Required] Gets the session_ttl_in_seconds of this SessionSummary. The amount of time the session can remain active.
Returns: The session_ttl_in_seconds of this SessionSummary. Return type: int
-
target_resource_details
¶ [Required] Gets the target_resource_details of this SessionSummary.
Returns: The target_resource_details of this SessionSummary. Return type: oci.bastion.models.TargetResourceDetails
-