Collaboration diagram for src.lib.components.endpoints.bonus.Bonus:

Public Member Functions
None	__init__ (self, RuntimeData runtime_data, int success=0, int error=84, bool debug=False)

Response	get_welcome (self, Request request)

Response	get_s3_bucket_names (self, Request request)

Response	get_table (self, Request request)

Response	post_stop_server (self, Request request)

Response	trigger_endpoint (self, str id, Request request)

Data Fields
bool	debug = debug

int	success = success

int	error = error

RuntimeData	runtime_data_initialised = runtime_data

Disp	disp

Detailed Description

_summary_

Definition at line 12 of file bonus.py.

Constructor & Destructor Documentation

◆ init()

None src.lib.components.endpoints.bonus.Bonus.__init__	(		self,
		RuntimeData	runtime_data,
		int	success = 0,
		int	error = 84,
		bool	debug = False )

_summary_

Args:
    runtime_data (RuntimeData): _description_
    success (int, optional): _description_. Defaults to 0.
    error (int, optional): _description_. Defaults to 84.
    debug (bool, optional): _description_. Defaults to False.

Definition at line 16 of file bonus.py.

Member Function Documentation

◆ get_s3_bucket_names()

Response src.lib.components.endpoints.bonus.Bonus.get_s3_bucket_names	(		self,
		Request	request )

    The endpoint to get every bucket data

Definition at line 68 of file bonus.py.

◆ get_table()

Response src.lib.components.endpoints.bonus.Bonus.get_table	(		self,
		Request	request )

    table

Definition at line 91 of file bonus.py.

◆ get_welcome()

Response src.lib.components.endpoints.bonus.Bonus.get_welcome	(		self,
		Request	request )

_summary_
    The endpoint corresponding to '/'.

Returns:
    Response: _description_: The data to send back to the user as a response.

Definition at line 38 of file bonus.py.

◆ post_stop_server()

Response src.lib.components.endpoints.bonus.Bonus.post_stop_server	(		self,
		Request	request )

_summary_
    The endpoint allowing a user to stop the server.

Returns:
    Response: _description_: The data to send back to the user as a response.

Definition at line 119 of file bonus.py.

◆ trigger_endpoint()

Response src.lib.components.endpoints.bonus.Bonus.trigger_endpoint	(		self,
		str	id,
		Request	request )

_summary_
    The endpoint to trigger a specific action.

Args:
    id (str): _description_
    request (Request): _description_

Returns:
    Response: _description_

Definition at line 173 of file bonus.py.

Field Documentation

◆ debug

bool src.lib.components.endpoints.bonus.Bonus.debug = debug

Definition at line 25 of file bonus.py.

◆ disp

Disp src.lib.components.endpoints.bonus.Bonus.disp

Initial value:

=  Disp(
            TOML_CONF,
            SAVE_TO_FILE,
            FILE_NAME,
            FILE_DESCRIPTOR,
            debug=self.debug,
            logger=self.__class__.__name__
        )

Definition at line 29 of file bonus.py.

◆ error

int src.lib.components.endpoints.bonus.Bonus.error = error

Definition at line 27 of file bonus.py.

◆ runtime_data_initialised

RuntimeData src.lib.components.endpoints.bonus.Bonus.runtime_data_initialised = runtime_data

Definition at line 28 of file bonus.py.

◆ success

int src.lib.components.endpoints.bonus.Bonus.success = success

Definition at line 26 of file bonus.py.

The documentation for this class was generated from the following file:

app/back/server/src/lib/components/endpoints/bonus.py

Public Member Functions

Data Fields