AGB.Cloud

Appearance

Session API Reference ​

Overview ​

The Session module provides methods for creating, managing, and terminating sessions in the AGB cloud environment. Sessions are the foundation for all operations.

Session ​

python
class Session()

Session represents a session in the AGB cloud environment.

set_labels ​

python
def set_labels(labels: Dict[str, str]) -> OperationResult

Sets the labels for this session.

Arguments:

  • labels Dict[str, str] - The labels to set for the session.

Returns:

OperationResult: Result indicating success or failure with request ID.

Raises:

SessionError: If the operation fails.

get_labels ​

python
def get_labels() -> OperationResult

Gets the labels for this session.

Returns:

OperationResult: Result containing the labels as data and request ID.

Raises:

SessionError: If the operation fails.

info ​

python
def info() -> OperationResult

Get session information including resource details.

Returns:

OperationResult: Result containing the session information as data and

request ID.

python
def get_link(protocol_type: Optional[str] = None,
             port: Optional[int] = None) -> OperationResult

Get a link associated with the current session.

Arguments:

  • protocol_type Optional[str] - The protocol type to use for the link. Defaults to None.
  • port Optional[int] - The port to use for the link.

Returns:

OperationResult: Result containing the link as data and request ID.

Raises:

SessionError: If the request fails or the response is invalid.

delete ​

python
def delete(sync_context: bool = False) -> DeleteResult

Delete a session by session object.

Arguments:

  • sync_context bool - Whether to sync context before deletion. Defaults to False.

Returns:

DeleteResult: Result indicating success or failure and request ID.

Documentation generated automatically from source code using pydoc-markdown.