1. Overview
  2. Docs

kinetic.proto Types

Types

type local = {
  1. protocol_version : string option;
}
type message_auth_type =
  1. | Invalid_auth_type
  2. | Hmacauth
  3. | Pinauth
  4. | Unsolicitedstatus
type message_hmacauth = {
  1. identity : int64 option;
  2. hmac : bytes option;
}
type message_pinauth = {
  1. pin : bytes option;
}
type message = {
  1. auth_type : message_auth_type option;
  2. hmac_auth : message_hmacauth option;
  3. pin_auth : message_pinauth option;
  4. command_bytes : bytes option;
}
type command_message_type =
  1. | Invalid_message_type
  2. | Get
  3. | Get_response
  4. | Put
  5. | Put_response
  6. | Delete
  7. | Delete_response
  8. | Getnext
  9. | Getnext_response
  10. | Getprevious
  11. | Getprevious_response
  12. | Getkeyrange
  13. | Getkeyrange_response
  14. | Getversion
  15. | Getversion_response
  16. | Setup
  17. | Setup_response
  18. | Getlog
  19. | Getlog_response
  20. | Security
  21. | Security_response
  22. | Peer2_peerpush
  23. | Peer2_peerpush_response
  24. | Noop
  25. | Noop_response
  26. | Flushalldata
  27. | Flushalldata_response
  28. | Pinop
  29. | Pinop_response
  30. | Mediascan
  31. | Mediascan_response
  32. | Mediaoptimize
  33. | Mediaoptimize_response
  34. | Start_batch
  35. | Start_batch_response
  36. | End_batch
  37. | End_batch_response
  38. | Abort_batch
  39. | Abort_batch_response
  40. | Set_power_level
  41. | Set_power_level_response
type command_priority =
  1. | Normal
  2. | Lowest
  3. | Lower
  4. | Low
  5. | Lowernormal
  6. | Highernormal
  7. | High
  8. | Higher
  9. | Highest
type command_header = {
  1. cluster_version : int64 option;
  2. connection_id : int64 option;
  3. sequence : int64 option;
  4. ack_sequence : int64 option;
  5. message_type : command_message_type option;
  6. timeout : int64 option;
  7. early_exit : bool option;
  8. priority : command_priority option;
  9. time_quanta : int64 option;
  10. batch_id : int32 option;
}
type command_algorithm =
  1. | Invalid_algorithm
  2. | Sha1
  3. | Sha2
  4. | Sha3
  5. | Crc32_c
  6. | Crc64
  7. | Crc32
type command_synchronization =
  1. | Invalid_synchronization
  2. | Writethrough
  3. | Writeback
  4. | Flush
type command_key_value = {
  1. new_version : bytes option;
  2. force : bool option;
  3. key : bytes option;
  4. db_version : bytes option;
  5. tag : bytes option;
  6. algorithm : command_algorithm option;
  7. metadata_only : bool option;
  8. synchronization : command_synchronization option;
}
type command_range = {
  1. start_key : bytes option;
  2. end_key : bytes option;
  3. start_key_inclusive : bool option;
  4. end_key_inclusive : bool option;
  5. max_returned : int32 option;
  6. reverse : bool option;
  7. keys : bytes list;
}
type command_setup_setup_op_type =
  1. | Invalid_setupop
  2. | Firmware_setupop
  3. | Cluster_version_setupop
type command_setup = {
  1. new_cluster_version : int64 option;
  2. setup_op_type : command_setup_setup_op_type option;
}
type command_p2_poperation_peer = {
  1. hostname : string option;
  2. port : int32 option;
  3. tls : bool option;
}
type command_status_status_code =
  1. | Invalid_status_code
  2. | Not_attempted
  3. | Success
  4. | Hmac_failure
  5. | Not_authorized
  6. | Version_failure
  7. | Internal_error
  8. | Header_required
  9. | Not_found
  10. | Version_mismatch
  11. | Service_busy
  12. | Expired
  13. | Data_error
  14. | Perm_data_error
  15. | Remote_connection_error
  16. | No_space
  17. | No_such_hmac_algorithm
  18. | Invalid_request
  19. | Nested_operation_errors
  20. | Device_locked
  21. | Device_already_unlocked
  22. | Connection_terminated
  23. | Invalid_batch
  24. | Hibernate
  25. | Shutdown
type command_status = {
  1. code : command_status_status_code option;
  2. status_message : string option;
  3. detailed_message : bytes option;
}
type command_p2_poperation = {
  1. peer : command_p2_poperation_peer option;
  2. operation : command_p2_poperation_operation list;
  3. all_child_operations_succeeded : bool option;
}
and command_p2_poperation_operation = {
  1. key : bytes option;
  2. version : bytes option;
  3. new_key : bytes option;
  4. force : bool option;
  5. status : command_status option;
  6. p2pop : command_p2_poperation option;
}
type command_get_log_type =
  1. | Invalid_type
  2. | Utilizations
  3. | Temperatures
  4. | Capacities
  5. | Configuration
  6. | Statistics
  7. | Messages
  8. | Limits
  9. | Device
type command_get_log_utilization = {
  1. name : string option;
  2. value : float option;
}
type command_get_log_temperature = {
  1. name : string option;
  2. current : float option;
  3. minimum : float option;
  4. maximum : float option;
  5. target : float option;
}
type command_get_log_capacity = {
  1. nominal_capacity_in_bytes : int64 option;
  2. portion_full : float option;
}
type command_get_log_configuration_interface = {
  1. name : string option;
  2. mac : bytes option;
  3. ipv4_address : bytes option;
  4. ipv6_address : bytes option;
}
type command_power_level =
  1. | Invalid_level
  2. | Operational
  3. | Hibernate
  4. | Shutdown
  5. | Fail
type command_get_log_configuration = {
  1. vendor : string option;
  2. model : string option;
  3. serial_number : bytes option;
  4. world_wide_name : bytes option;
  5. version : string option;
  6. compilation_date : string option;
  7. source_hash : string option;
  8. protocol_version : string option;
  9. protocol_compilation_date : string option;
  10. protocol_source_hash : string option;
  11. interface : command_get_log_configuration_interface list;
  12. port : int32 option;
  13. tls_port : int32 option;
  14. current_power_level : command_power_level option;
}
type command_get_log_statistics = {
  1. message_type : command_message_type option;
  2. count : int64 option;
  3. bytes : int64 option;
}
type command_get_log_limits = {
  1. max_key_size : int32 option;
  2. max_value_size : int32 option;
  3. max_version_size : int32 option;
  4. max_tag_size : int32 option;
  5. max_connections : int32 option;
  6. max_outstanding_read_requests : int32 option;
  7. max_outstanding_write_requests : int32 option;
  8. max_message_size : int32 option;
  9. max_key_range_count : int32 option;
  10. max_identity_count : int32 option;
  11. max_pin_size : int32 option;
  12. max_operation_count_per_batch : int32 option;
  13. max_batch_count_per_device : int32 option;
  14. max_batch_size : int32 option;
  15. max_deletes_per_batch : int32 option;
}
type command_get_log_device = {
  1. name : bytes option;
}
type command_get_log = {
  1. types : command_get_log_type list;
  2. utilizations : command_get_log_utilization list;
  3. temperatures : command_get_log_temperature list;
  4. capacity : command_get_log_capacity option;
  5. configuration : command_get_log_configuration option;
  6. statistics : command_get_log_statistics list;
  7. messages : bytes option;
  8. limits : command_get_log_limits option;
  9. device : command_get_log_device option;
}
type command_security_acl_hmacalgorithm =
  1. | Invalid_hmac_algorithm
  2. | Hmac_sha1
type command_security_acl_permission =
  1. | Invalid_permission
  2. | Read
  3. | Write
  4. | Delete
  5. | Range
  6. | Setup
  7. | P2_pop
  8. | Getlog
  9. | Security
  10. | Power_management
type command_security_acl_scope = {
  1. offset : int64 option;
  2. value : bytes option;
  3. permission : command_security_acl_permission list;
  4. tls_required : bool option;
}
type command_security_acl = {
  1. identity : int64 option;
  2. key : bytes option;
  3. hmac_algorithm : command_security_acl_hmacalgorithm option;
  4. scope : command_security_acl_scope list;
  5. max_priority : command_priority option;
}
type command_security_security_op_type =
  1. | Invalid_securityop
  2. | Acl_securityop
  3. | Erase_pin_securityop
  4. | Lock_pin_securityop
type command_security = {
  1. acl : command_security_acl list;
  2. old_lock_pin : bytes option;
  3. new_lock_pin : bytes option;
  4. old_erase_pin : bytes option;
  5. new_erase_pin : bytes option;
  6. security_op_type : command_security_security_op_type option;
}
type command_pin_operation_pin_op_type =
  1. | Invalid_pinop
  2. | Unlock_pinop
  3. | Lock_pinop
  4. | Erase_pinop
  5. | Secure_erase_pinop
type command_pin_operation = {
  1. pin_op_type : command_pin_operation_pin_op_type option;
}
type command_batch = {
  1. count : int32 option;
  2. sequence : int64 list;
  3. failed_sequence : int64 option;
}
type command_power_management = {
  1. level : command_power_level option;
}
type command_body = {
  1. key_value : command_key_value option;
  2. range : command_range option;
  3. setup : command_setup option;
  4. p2p_operation : command_p2_poperation option;
  5. get_log : command_get_log option;
  6. security : command_security option;
  7. pin_op : command_pin_operation option;
  8. batch : command_batch option;
  9. power : command_power_management option;
}
type command = {
  1. header : command_header option;
  2. body : command_body option;
  3. status : command_status option;
}

Default values

val default_local : ?protocol_version:string option -> unit -> local

default_local () is the default value for type local

val default_message_auth_type : unit -> message_auth_type

default_message_auth_type () is the default value for type message_auth_type

val default_message_hmacauth : ?identity:int64 option -> ?hmac:bytes option -> unit -> message_hmacauth

default_message_hmacauth () is the default value for type message_hmacauth

val default_message_pinauth : ?pin:bytes option -> unit -> message_pinauth

default_message_pinauth () is the default value for type message_pinauth

val default_message : ?auth_type:message_auth_type option -> ?hmac_auth:message_hmacauth option -> ?pin_auth:message_pinauth option -> ?command_bytes:bytes option -> unit -> message

default_message () is the default value for type message

val default_command_message_type : unit -> command_message_type

default_command_message_type () is the default value for type command_message_type

val default_command_priority : unit -> command_priority

default_command_priority () is the default value for type command_priority

val default_command_header : ?cluster_version:int64 option -> ?connection_id:int64 option -> ?sequence:int64 option -> ?ack_sequence:int64 option -> ?message_type:command_message_type option -> ?timeout:int64 option -> ?early_exit:bool option -> ?priority:command_priority option -> ?time_quanta:int64 option -> ?batch_id:int32 option -> unit -> command_header

default_command_header () is the default value for type command_header

val default_command_algorithm : unit -> command_algorithm

default_command_algorithm () is the default value for type command_algorithm

val default_command_synchronization : unit -> command_synchronization

default_command_synchronization () is the default value for type command_synchronization

val default_command_key_value : ?new_version:bytes option -> ?force:bool option -> ?key:bytes option -> ?db_version:bytes option -> ?tag:bytes option -> ?algorithm:command_algorithm option -> ?metadata_only:bool option -> ?synchronization:command_synchronization option -> unit -> command_key_value

default_command_key_value () is the default value for type command_key_value

val default_command_range : ?start_key:bytes option -> ?end_key:bytes option -> ?start_key_inclusive:bool option -> ?end_key_inclusive:bool option -> ?max_returned:int32 option -> ?reverse:bool option -> ?keys:bytes list -> unit -> command_range

default_command_range () is the default value for type command_range

val default_command_setup_setup_op_type : unit -> command_setup_setup_op_type

default_command_setup_setup_op_type () is the default value for type command_setup_setup_op_type

val default_command_setup : ?new_cluster_version:int64 option -> ?setup_op_type:command_setup_setup_op_type option -> unit -> command_setup

default_command_setup () is the default value for type command_setup

val default_command_p2_poperation_peer : ?hostname:string option -> ?port:int32 option -> ?tls:bool option -> unit -> command_p2_poperation_peer

default_command_p2_poperation_peer () is the default value for type command_p2_poperation_peer

val default_command_status_status_code : unit -> command_status_status_code

default_command_status_status_code () is the default value for type command_status_status_code

val default_command_status : ?code:command_status_status_code option -> ?status_message:string option -> ?detailed_message:bytes option -> unit -> command_status

default_command_status () is the default value for type command_status

val default_command_p2_poperation : ?peer:command_p2_poperation_peer option -> ?operation:command_p2_poperation_operation list -> ?all_child_operations_succeeded:bool option -> unit -> command_p2_poperation

default_command_p2_poperation () is the default value for type command_p2_poperation

val default_command_p2_poperation_operation : ?key:bytes option -> ?version:bytes option -> ?new_key:bytes option -> ?force:bool option -> ?status:command_status option -> ?p2pop:command_p2_poperation option -> unit -> command_p2_poperation_operation

default_command_p2_poperation_operation () is the default value for type command_p2_poperation_operation

val default_command_get_log_type : unit -> command_get_log_type

default_command_get_log_type () is the default value for type command_get_log_type

val default_command_get_log_utilization : ?name:string option -> ?value:float option -> unit -> command_get_log_utilization

default_command_get_log_utilization () is the default value for type command_get_log_utilization

val default_command_get_log_temperature : ?name:string option -> ?current:float option -> ?minimum:float option -> ?maximum:float option -> ?target:float option -> unit -> command_get_log_temperature

default_command_get_log_temperature () is the default value for type command_get_log_temperature

val default_command_get_log_capacity : ?nominal_capacity_in_bytes:int64 option -> ?portion_full:float option -> unit -> command_get_log_capacity

default_command_get_log_capacity () is the default value for type command_get_log_capacity

val default_command_get_log_configuration_interface : ?name:string option -> ?mac:bytes option -> ?ipv4_address:bytes option -> ?ipv6_address:bytes option -> unit -> command_get_log_configuration_interface

default_command_get_log_configuration_interface () is the default value for type command_get_log_configuration_interface

val default_command_power_level : unit -> command_power_level

default_command_power_level () is the default value for type command_power_level

val default_command_get_log_configuration : ?vendor:string option -> ?model:string option -> ?serial_number:bytes option -> ?world_wide_name:bytes option -> ?version:string option -> ?compilation_date:string option -> ?source_hash:string option -> ?protocol_version:string option -> ?protocol_compilation_date:string option -> ?protocol_source_hash:string option -> ?interface:command_get_log_configuration_interface list -> ?port:int32 option -> ?tls_port:int32 option -> ?current_power_level:command_power_level option -> unit -> command_get_log_configuration

default_command_get_log_configuration () is the default value for type command_get_log_configuration

val default_command_get_log_statistics : ?message_type:command_message_type option -> ?count:int64 option -> ?bytes:int64 option -> unit -> command_get_log_statistics

default_command_get_log_statistics () is the default value for type command_get_log_statistics

val default_command_get_log_limits : ?max_key_size:int32 option -> ?max_value_size:int32 option -> ?max_version_size:int32 option -> ?max_tag_size:int32 option -> ?max_connections:int32 option -> ?max_outstanding_read_requests:int32 option -> ?max_outstanding_write_requests:int32 option -> ?max_message_size:int32 option -> ?max_key_range_count:int32 option -> ?max_identity_count:int32 option -> ?max_pin_size:int32 option -> ?max_operation_count_per_batch:int32 option -> ?max_batch_count_per_device:int32 option -> ?max_batch_size:int32 option -> ?max_deletes_per_batch:int32 option -> unit -> command_get_log_limits

default_command_get_log_limits () is the default value for type command_get_log_limits

val default_command_get_log_device : ?name:bytes option -> unit -> command_get_log_device

default_command_get_log_device () is the default value for type command_get_log_device

val default_command_get_log : ?types:command_get_log_type list -> ?utilizations:command_get_log_utilization list -> ?temperatures:command_get_log_temperature list -> ?capacity:command_get_log_capacity option -> ?configuration:command_get_log_configuration option -> ?statistics:command_get_log_statistics list -> ?messages:bytes option -> ?limits:command_get_log_limits option -> ?device:command_get_log_device option -> unit -> command_get_log

default_command_get_log () is the default value for type command_get_log

val default_command_security_acl_hmacalgorithm : unit -> command_security_acl_hmacalgorithm

default_command_security_acl_hmacalgorithm () is the default value for type command_security_acl_hmacalgorithm

val default_command_security_acl_permission : unit -> command_security_acl_permission

default_command_security_acl_permission () is the default value for type command_security_acl_permission

val default_command_security_acl_scope : ?offset:int64 option -> ?value:bytes option -> ?permission:command_security_acl_permission list -> ?tls_required:bool option -> unit -> command_security_acl_scope

default_command_security_acl_scope () is the default value for type command_security_acl_scope

val default_command_security_acl : ?identity:int64 option -> ?key:bytes option -> ?hmac_algorithm:command_security_acl_hmacalgorithm option -> ?scope:command_security_acl_scope list -> ?max_priority:command_priority option -> unit -> command_security_acl

default_command_security_acl () is the default value for type command_security_acl

val default_command_security_security_op_type : unit -> command_security_security_op_type

default_command_security_security_op_type () is the default value for type command_security_security_op_type

val default_command_security : ?acl:command_security_acl list -> ?old_lock_pin:bytes option -> ?new_lock_pin:bytes option -> ?old_erase_pin:bytes option -> ?new_erase_pin:bytes option -> ?security_op_type:command_security_security_op_type option -> unit -> command_security

default_command_security () is the default value for type command_security

val default_command_pin_operation_pin_op_type : unit -> command_pin_operation_pin_op_type

default_command_pin_operation_pin_op_type () is the default value for type command_pin_operation_pin_op_type

val default_command_pin_operation : ?pin_op_type:command_pin_operation_pin_op_type option -> unit -> command_pin_operation

default_command_pin_operation () is the default value for type command_pin_operation

val default_command_batch : ?count:int32 option -> ?sequence:int64 list -> ?failed_sequence:int64 option -> unit -> command_batch

default_command_batch () is the default value for type command_batch

val default_command_power_management : ?level:command_power_level option -> unit -> command_power_management

default_command_power_management () is the default value for type command_power_management

val default_command_body : ?key_value:command_key_value option -> ?range:command_range option -> ?setup:command_setup option -> ?p2p_operation:command_p2_poperation option -> ?get_log:command_get_log option -> ?security:command_security option -> ?pin_op:command_pin_operation option -> ?batch:command_batch option -> ?power:command_power_management option -> unit -> command_body

default_command_body () is the default value for type command_body

val default_command : ?header:command_header option -> ?body:command_body option -> ?status:command_status option -> unit -> command

default_command () is the default value for type command