Response

This script defines the Response and UpdateStateSuccess classes, used for receiving messages from the control interface.

Classes

• Response:

  Represents a response from the control interface.

• UpdateStateSuccess:

  Represents a response for a successful update state request.

Enums

• ResponseType:

  Enumeration for the different types of response. It includes ERROR, COMPLETE_STATE, and UPDATE_STATE_SUCCESS and CONNECTION_CLOSED.

Usage

• Get response content:

  response = Response()
  (content_type, content) = response.get_content()
  

• Check if the request_id matches:

  response = Response()
  if response.check_request_id("1234"):
      print("Request ID matches")
  

• Convert the update state success to a dictionary:

  update_state_success = UpdateStateSuccess()
  update_state_success.to_dict()
  

Response Class

class ankaios_sdk._components.response.Response(message_buffer)

Bases: object

Represents a response received from the Ankaios system.

buffer

The received message buffer.

Type:

bytes

content_type

The type of the response content (e.g., “error”, “complete_state”, “update_state_success”).

Type:

str

content

The content of the response, which can be a string, CompleteState, or UpdateStateSuccess.

__init__(message_buffer)

Initializes the Response object with the received message buffer.

Parameters:

message_buffer (bytes) – The received message buffer.

get_request_id()

Gets the request id of the response.

Returns:

The request id of the response.

Return type:

str

get_content()

Gets the content of the response. It can be either a string (if error), a CompleteState instance, or a UpdateStateSuccess instance.

Returns:

the content type and the content.

Return type:

tuple[ResponseType, any]

UpdateStateSuccess Class

class ankaios_sdk._components.response.UpdateStateSuccess

Bases: object

Represents an object that holds the added and deleted workloads. This is automatically returned whenever a state update is successful.

__init__()

Initializes the UpdateStateSuccess.

to_dict()

Converts the UpdateStateSuccess to a dictionary.

Returns:

The dictionary representation.

Return type:

dict

__str__()

Converts the UpdateStateSuccess to a string.

Returns:

The string representation.

Return type:

str

ResponseType Enum

class ankaios_sdk._components.response.ResponseType(value)

Bases: Enum

Enumeration for the different types of response.

ERROR = 1

Got an error from Ankaios.

Type:

(int)

COMPLETE_STATE = 2

Got the complete state.

Type:

(int)

UPDATE_STATE_SUCCESS = 3

Got a successful update state response.

Type:

(int)

CONNECTION_CLOSED = 4

Connection closed by the server.

Type:

(int)

__str__()

Converts the ResponseType to a string.

Returns:

The string representation of the ResponseType.

Return type:

str