package proto_docker

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: ListContainersResponse

• string uuid = 1

• string name = 2

• string status = 3

Used in: Request

• string container_name = 1

• string image_name = 2

• optional PortMaps ports = 3

• optional StringList init_command = 4

• map<string, string> environment_variables = 5

• optional StringList volumes = 6

Used in: Response

• string uuid = 1

  The UUID of the created container

• string error = 2

Used in: Request

• string driver = 1

• string name = 2

  Must start with polypheny_ followed by the Polypheny UUID and another underscore

• map<string, string> options = 3

Used in: Response

• string error = 16

  Length > 0 when an error occurred

Used in: Request

• string uuid = 1

Used in: Response

• string error = 1

Used in: Request

• string name = 1

Used in: Response

• string error = 1

Used in: Request

• string uuid = 1

• optional StringList command = 2

Used in: Response

• int32 exit_code = 1

• string error = 2

  Set when there was another error

Used in: Request

• repeated string uuid = 1

Used in: Response

• map<string, PortMapOrError> ports = 1

Used in: Request

• string uuid = 1

Used in: Response

• string error = 16

  Length > 0 when an error occurred

• string name = 1

• string status = 2

  See https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect

This only lists the containers belonging to the Polypheny instance issuing the request. Ownership is determined by enforcing a naming scheme which includes the Polypheny UUID in the container name.

Used in: Request

(message has no fields)

Used in: Response

• repeated ContainerInfo containers = 1

• string error = 2

Used in: Request

(message has no fields)

Used in: Response

• string error = 1

See https://pkg.go.dev/github.com/docker/go-connections/nat#PortMap

Used in: PortMap

• string host_ip = 1

• uint32 host_port = 2

  When zero in the CreateContainerRequest, docker will use a random port

Used in: PortMaps

• uint32 container_port = 1

• string proto = 2

• repeated PortBinding bindings = 3

Used in: GetPortsResponse

• oneof result

  • PortMaps ok = 1

  • string error = 2

Used in: CreateContainerRequest, PortMapOrError

• repeated PortMap mappings = 1

In general we do not keep the strict protobuf field numbering policies, because we never store messages. The exception is the message_id, version and upgrade field numbers for both Request and Response are fixed, as are the VersionRequest, VersionResponse, UpgradeRequest and UpgradeResponse messages. All other fields can be changed if the version is increased.

• uint64 message_id = 1

• oneof inner_message

  • VersionRequest version = 2047

  • UpgradeRequest upgrade = 2046

  • CreateContainerRequest create_container = 2

  • StartContainerRequest start_container = 3

  • InspectContainerRequest inspect_container = 4

  • StopContainerRequest stop_container = 5

  • DeleteContainerRequest delete_container = 6

  • ListContainersRequest list_containers = 7

  • GetPortsRequest get_ports = 8

  • ExecuteCommandRequest execute_command = 9

  • CreateVolumeRequest create_volume = 10

  • DeleteVolumeRequest delete_volume = 11

  • PingRequest ping = 12

• uint64 message_id = 1

• oneof inner_message

  • VersionResponse version = 2047

  • UpgradeResponse upgrade = 2046

  • CreateContainerResponse create_container = 2

  • StartContainerResponse start_container = 3

  • InspectContainerResponse inspect_container = 4

  • StopContainerResponse stop_container = 5

  • DeleteContainerResponse delete_container = 6

  • ListContainersResponse list_containers = 7

  • GetPortsResponse get_ports = 8

  • ExecuteCommandResponse execute_command = 9

  • CreateVolumeResponse create_volume = 10

  • DeleteVolumeResponse delete_volume = 11

  • PingResponse ping = 12

Used in: Request

• string uuid = 1

Used in: Response

• string error = 1

Used in: Request

• string uuid = 1

Used in: Response

• string error = 1

Used in: CreateContainerRequest, ExecuteCommandRequest

• repeated string strings = 1

Used in: Request

• string image_name = 1

Used in: Response

• string error = 1

  "" if no error

Used in: Request

• uint32 version = 1

Used in: Response

• uint32 version = 1

• string uuid = 2

  A identifier for that docker instance, see https://docs.docker.com/engine/api/v1.43/#tag/System/operation/SystemInfo