Documentation ¶
Overview ¶
Package api represents all requests and responses suitable for conversation with a remote driver.
Index ¶
- type CreateEndpointRequest
- type CreateEndpointResponse
- type CreateNetworkRequest
- type CreateNetworkResponse
- type DeleteEndpointRequest
- type DeleteEndpointResponse
- type DeleteNetworkRequest
- type DeleteNetworkResponse
- type DiscoveryNotification
- type DiscoveryResponse
- type EndpointInfoRequest
- type EndpointInfoResponse
- type EndpointInterface
- type GetCapabilityResponse
- type Interface
- type InterfaceName
- type JoinRequest
- type JoinResponse
- type LeaveRequest
- type LeaveResponse
- type Response
- type StaticRoute
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateEndpointRequest ¶
type CreateEndpointRequest struct { // Provided at create time, this will be the network id referenced. NetworkID string // The ID of the endpoint for later reference. EndpointID string Interface *EndpointInterface Options map[string]interface{} }
CreateEndpointRequest is the request to create an endpoint within a network.
type CreateEndpointResponse ¶
type CreateEndpointResponse struct { Response Interface *EndpointInterface }
CreateEndpointResponse is the response to the CreateEndpoint action.
type CreateNetworkRequest ¶
type CreateNetworkRequest struct { // A network ID that remote plugins are expected to store for future // reference. NetworkID string // A free form map->object interface for communication of options. Options map[string]interface{} // IPAMData contains the address pool information for this network IPv4Data, IPv6Data []driverapi.IPAMData }
CreateNetworkRequest requests a new network.
type CreateNetworkResponse ¶
type CreateNetworkResponse struct {
Response
}
CreateNetworkResponse is the response to the CreateNetworkRequest.
type DeleteEndpointRequest ¶
DeleteEndpointRequest describes the API for deleting an endpoint.
type DeleteEndpointResponse ¶
type DeleteEndpointResponse struct {
Response
}
DeleteEndpointResponse is the response to the DeleteEndpoint action.
type DeleteNetworkRequest ¶
type DeleteNetworkRequest struct { // The ID of the network to delete. NetworkID string }
DeleteNetworkRequest is the request to delete an existing network.
type DeleteNetworkResponse ¶
type DeleteNetworkResponse struct {
Response
}
DeleteNetworkResponse is the response to a request for deleting a network.
type DiscoveryNotification ¶
type DiscoveryNotification struct { DiscoveryType driverapi.DiscoveryType DiscoveryData interface{} }
DiscoveryNotification represents a discovery notification
type DiscoveryResponse ¶
type DiscoveryResponse struct {
Response
}
DiscoveryResponse is used by libnetwork to log any plugin error processing the discovery notifications
type EndpointInfoRequest ¶
EndpointInfoRequest retrieves information about the endpoint from the network driver.
type EndpointInfoResponse ¶
EndpointInfoResponse is the response to an EndpointInfoRequest.
type EndpointInterface ¶
EndpointInterface represents an interface endpoint.
type GetCapabilityResponse ¶
GetCapabilityResponse is the response of GetCapability request
type InterfaceName ¶
InterfaceName is the struct represetation of a pair of devices with source and destination, for the purposes of putting an endpoint into a container.
type JoinRequest ¶
type JoinRequest struct { NetworkID string EndpointID string SandboxKey string Options map[string]interface{} }
JoinRequest describes the API for joining an endpoint to a sandbox.
type JoinResponse ¶
type JoinResponse struct { Response InterfaceName *InterfaceName Gateway string GatewayIPv6 string StaticRoutes []StaticRoute DisableGatewayService bool }
JoinResponse is the response to a JoinRequest.
type LeaveRequest ¶
LeaveRequest describes the API for detaching an endpoint from a sandbox.
type LeaveResponse ¶
type LeaveResponse struct {
Response
}
LeaveResponse is the answer to LeaveRequest.
type Response ¶
type Response struct {
Err string
}
Response is the basic response structure used in all responses.
type StaticRoute ¶
StaticRoute is the plain JSON representation of a static route.