api

Documentation

Overview

Package api defines the data structure to be used in the request/response messages between libnetwork and the remote ipam plugin

Index

• type GetAddressSpacesResponse
• type ReleaseAddressRequest
• type ReleaseAddressResponse
• type ReleasePoolRequest
• type ReleasePoolResponse
• type RequestAddressRequest
• type RequestAddressResponse
• type RequestPoolRequest
• type RequestPoolResponse
• type Response
  • func (r *Response) GetError() string
  • func (r *Response) IsSuccess() bool

Types

type GetAddressSpacesResponse

type GetAddressSpacesResponse struct {
	Response
	LocalDefaultAddressSpace  string
	GlobalDefaultAddressSpace string
}

GetAddressSpacesResponse is the response to the “get default address spaces“ request message

type ReleaseAddressRequest

type ReleaseAddressRequest struct {
	PoolID  string
	Address string
}

ReleaseAddressRequest represents the expected data in a “release address“ request message

type ReleaseAddressResponse

type ReleaseAddressResponse struct {
	Response
}

ReleaseAddressResponse represents the response message to a “release address“ request

type ReleasePoolRequest

type ReleasePoolRequest struct {
	PoolID string
}

ReleasePoolRequest represents the expected data in a “release address pool“ request message

type ReleasePoolResponse

type ReleasePoolResponse struct {
	Response
}

ReleasePoolResponse represents the response message to a “release address pool“ request

type RequestAddressRequest

type RequestAddressRequest struct {
	PoolID  string
	Address string
	Options map[string]string
}

RequestAddressRequest represents the expected data in a “request address“ request message

type RequestAddressResponse

type RequestAddressResponse struct {
	Response
	Address string // in CIDR format
	Data    map[string]string
}

RequestAddressResponse represents the expected data in the response message to a “request address“ request

type RequestPoolRequest

type RequestPoolRequest struct {
	AddressSpace string
	Pool         string
	SubPool      string
	Options      map[string]string
	V6           bool
}

RequestPoolRequest represents the expected data in a “request address pool“ request message

type RequestPoolResponse

type RequestPoolResponse struct {
	Response
	PoolID string
	Pool   string // CIDR format
	Data   map[string]string
}

RequestPoolResponse represents the response message to a “request address pool“ request

type Response

type Response struct {
	Error string
}

Response is the basic response structure used in all responses

func (*Response) GetError

func (r *Response) GetError() string

GetError returns the error from the response, if any.

func (*Response) IsSuccess

func (r *Response) IsSuccess() bool

IsSuccess returns wheter the plugin response is successful