Request

This module defines the Request class for creating and handling requests to the Ankaios system.

Classes

• Request:

  Represents the base request to the Ankaios system. It is an abstract class that should be subclassed for specific request types.

• GetStateRequest:

  Represents a request to get the state of the Ankaios system.

• UpdateStateRequest:

  Represents a request to update the state of the Ankaios system.

• LogsRequest:

  Represents a request to get logs from the Ankaios system.

• LogsCancelRequest:

  Represents a request to stop the real-time log stream from the Ankaios system.

Usage

• Create a Request for updating the state:

  complete_state = CompleteState()
  request = UpdateStateRequest(
      complete_state, masks=["desiredState.workloads"]
  )
  

• Create a Request for getting the state:

  request = GetStateRequest(masks=["desiredState.workloads"])
  

• Create a Request for getting logs for a workload:

  workload_name: WorkloadInstanceName = ...
  request = LogsRequest(workload_names=[workload_name])
  

• Create a Request for getting a continuous stream of logs:

  workload_name: WorkloadInstanceName = ...
  request = LogsRequest(workload_names=[workload_name], follow=True)
  

• Create a Request for stopping the log stream:

  request = LogsCancelRequest()
  

• Get the request ID:

  request_id = request.get_id()
  

Request Class

class ankaios_sdk._components.request.Request(_id=None)

Bases: object

Represents a request to the Ankaios system.

__init__(_id=None)

Initializes a Request instance.

Parameters:

_id (str) – The request ID. If None, a new UUID will be generated.

Raises:

TypeError – If the Request class is instantiated directly.

__str__()

Returns the string representation of the request.

Returns:

The string representation of the request.

Return type:

str

get_id()

Gets the request ID.

Returns:

The request ID.

Return type:

str

RequestType Enum