get_log

OCPP 2.1 GetLog action.

Request/Response payload types with their OCPP-J codecs (request_to_json/request_decoder, response_to_json/ response_decoder). Transport-agnostic; the action-string mapping lives in ocpp/v2_1/dispatch.

Types

Request

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`log`	`LogParameters`	✓
`log_type`	`Log`	✓
`request_id`	`Int`	✓	The Id of this request
`retries`	`Int`	—	This specifies how many times the Charging Station must retry to upload the log before giving up. If this field is not present, it is left to Charging Station to decide how many times it wants to retry. If the value is 0, it means: no retries. (≥ 0)
`retry_interval`	`Int`	—	The interval in seconds after which a retry may be attempted. If this field is not present, it is left to Charging Station to decide how long to wait between attempts.

Schema: GetLogRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    log: log_parameters.LogParameters,
    log_type: log.Log,
    request_id: Int,
    retries: option.Option(Int),
    retry_interval: option.Option(Int),
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  log: log_parameters.LogParameters,
  log_type: log.Log,
  request_id: Int,
  retries: option.Option(Int),
  retry_interval: option.Option(Int),
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`filename`	`String`	—	This contains the name of the log file that will be uploaded. This field is not present when no logging information is available. (max 255 chars)
`status`	`LogStatus`	✓
`status_info`	`StatusInfo`	—

Schema: GetLogResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    filename: option.Option(String),
    status: log_status.LogStatus,
    status_info: option.Option(status_info.StatusInfo),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  filename: option.Option(String),
  status: log_status.LogStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(
  log log: log_parameters.LogParameters,
  log_type log_type: log.Log,
  request_id request_id: Int,
) -> Request

Construct a Request from its required fields, with every optional field set to None.

new_response

</>

pub fn new_response(
  status status: log_status.LogStatus,
) -> Response

Construct a Response from its required fields, with every optional field set to None.

request_decoder

</>

pub fn request_decoder() -> decode.Decoder(Request)

Decode a Request from its OCPP-J JSON object, enforcing schema constraints.

request_to_json

</>

pub fn request_to_json(value: Request) -> json.Json

Encode a Request to its OCPP-J JSON object.

response_decoder

</>

pub fn response_decoder() -> decode.Decoder(Response)

Decode a Response from its OCPP-J JSON object, enforcing schema constraints.

response_to_json

</>

pub fn response_to_json(value: Response) -> json.Json

Encode a Response to its OCPP-J JSON object.