package
3.1.3+incompatible
Repository: https://github.com/haproxytech/dataplaneapi.git
Documentation: pkg.go.dev
# Functions
NewCreateRing creates a new http.Handler for the create ring operation.
NewCreateRingAccepted creates CreateRingAccepted with default headers values.
NewCreateRingBadRequest creates CreateRingBadRequest with default headers values.
NewCreateRingConflict creates CreateRingConflict with default headers values.
NewCreateRingCreated creates CreateRingCreated with default headers values.
NewCreateRingDefault creates CreateRingDefault with default headers values.
NewCreateRingParams creates a new CreateRingParams object with the default values initialized.
NewDeleteRing creates a new http.Handler for the delete ring operation.
NewDeleteRingAccepted creates DeleteRingAccepted with default headers values.
NewDeleteRingDefault creates DeleteRingDefault with default headers values.
NewDeleteRingNoContent creates DeleteRingNoContent with default headers values.
NewDeleteRingNotFound creates DeleteRingNotFound with default headers values.
NewDeleteRingParams creates a new DeleteRingParams object with the default values initialized.
NewGetRing creates a new http.Handler for the get ring operation.
NewGetRingDefault creates GetRingDefault with default headers values.
NewGetRingNotFound creates GetRingNotFound with default headers values.
NewGetRingOK creates GetRingOK with default headers values.
NewGetRingParams creates a new GetRingParams object with the default values initialized.
NewGetRings creates a new http.Handler for the get rings operation.
NewGetRingsDefault creates GetRingsDefault with default headers values.
NewGetRingsOK creates GetRingsOK with default headers values.
NewGetRingsParams creates a new GetRingsParams object with the default values initialized.
NewReplaceRing creates a new http.Handler for the replace ring operation.
NewReplaceRingAccepted creates ReplaceRingAccepted with default headers values.
NewReplaceRingBadRequest creates ReplaceRingBadRequest with default headers values.
NewReplaceRingDefault creates ReplaceRingDefault with default headers values.
NewReplaceRingNotFound creates ReplaceRingNotFound with default headers values.
NewReplaceRingOK creates ReplaceRingOK with default headers values.
NewReplaceRingParams creates a new ReplaceRingParams object with the default values initialized.
# Constants
CreateRingAcceptedCode is the HTTP code returned for type CreateRingAccepted.
CreateRingBadRequestCode is the HTTP code returned for type CreateRingBadRequest.
CreateRingConflictCode is the HTTP code returned for type CreateRingConflict.
CreateRingCreatedCode is the HTTP code returned for type CreateRingCreated.
DeleteRingAcceptedCode is the HTTP code returned for type DeleteRingAccepted.
DeleteRingNoContentCode is the HTTP code returned for type DeleteRingNoContent.
DeleteRingNotFoundCode is the HTTP code returned for type DeleteRingNotFound.
GetRingNotFoundCode is the HTTP code returned for type GetRingNotFound.
GetRingOKCode is the HTTP code returned for type GetRingOK.
GetRingsOKCode is the HTTP code returned for type GetRingsOK.
ReplaceRingAcceptedCode is the HTTP code returned for type ReplaceRingAccepted.
ReplaceRingBadRequestCode is the HTTP code returned for type ReplaceRingBadRequest.
ReplaceRingNotFoundCode is the HTTP code returned for type ReplaceRingNotFound.
ReplaceRingOKCode is the HTTP code returned for type ReplaceRingOK.
# Structs
CreateRing swagger:route POST /services/haproxy/configuration/rings Ring createRing
# Add a ring
Adds a new ring to the configuration file.
CreateRingAccepted Configuration change accepted and reload requested
swagger:response createRingAccepted
*/.
CreateRingBadRequest Bad request
swagger:response createRingBadRequest
*/.
CreateRingConflict The specified resource already exists
swagger:response createRingConflict
*/.
CreateRingCreated Ring created
swagger:response createRingCreated
*/.
CreateRingDefault General Error
swagger:response createRingDefault
*/.
CreateRingParams contains all the bound params for the create ring operation typically these are obtained from a http.Request
swagger:parameters createRing.
CreateRingURL generates an URL for the create ring operation.
DeleteRing swagger:route DELETE /services/haproxy/configuration/rings/{name} Ring deleteRing
# Delete a ring
Deletes a ring from the configuration by it's name.
DeleteRingAccepted Configuration change accepted and reload requested
swagger:response deleteRingAccepted
*/.
DeleteRingDefault General Error
swagger:response deleteRingDefault
*/.
DeleteRingNoContent Ring deleted
swagger:response deleteRingNoContent
*/.
DeleteRingNotFound The specified resource was not found
swagger:response deleteRingNotFound
*/.
DeleteRingParams contains all the bound params for the delete ring operation typically these are obtained from a http.Request
swagger:parameters deleteRing.
DeleteRingURL generates an URL for the delete ring operation.
GetRing swagger:route GET /services/haproxy/configuration/rings/{name} Ring getRing
# Return a ring
Returns one ring configuration by it's name.
GetRingDefault General Error
swagger:response getRingDefault
*/.
GetRingNotFound The specified resource was not found
swagger:response getRingNotFound
*/.
GetRingOK Successful operation
swagger:response getRingOK
*/.
GetRingParams contains all the bound params for the get ring operation typically these are obtained from a http.Request
swagger:parameters getRing.
GetRings swagger:route GET /services/haproxy/configuration/rings Ring getRings
# Return an array of rings
Returns an array of all configured rings.
GetRingsDefault General Error
swagger:response getRingsDefault
*/.
GetRingsOK Successful operation
swagger:response getRingsOK
*/.
GetRingsParams contains all the bound params for the get rings operation typically these are obtained from a http.Request
swagger:parameters getRings.
GetRingsURL generates an URL for the get rings operation.
GetRingURL generates an URL for the get ring operation.
ReplaceRing swagger:route PUT /services/haproxy/configuration/rings/{name} Ring replaceRing
# Replace a ring
Replaces a ring configuration by it's name.
ReplaceRingAccepted Configuration change accepted and reload requested
swagger:response replaceRingAccepted
*/.
ReplaceRingBadRequest Bad request
swagger:response replaceRingBadRequest
*/.
ReplaceRingDefault General Error
swagger:response replaceRingDefault
*/.
ReplaceRingNotFound The specified resource was not found
swagger:response replaceRingNotFound
*/.
ReplaceRingOK Ring replaced
swagger:response replaceRingOK
*/.
ReplaceRingParams contains all the bound params for the replace ring operation typically these are obtained from a http.Request
swagger:parameters replaceRing.
ReplaceRingURL generates an URL for the replace ring operation.
# Interfaces
CreateRingHandler interface for that can handle valid create ring params.
DeleteRingHandler interface for that can handle valid delete ring params.
GetRingHandler interface for that can handle valid get ring params.
GetRingsHandler interface for that can handle valid get rings params.
ReplaceRingHandler interface for that can handle valid replace ring params.
# Type aliases
CreateRingHandlerFunc turns a function with the right signature into a create ring handler.
DeleteRingHandlerFunc turns a function with the right signature into a delete ring handler.
GetRingHandlerFunc turns a function with the right signature into a get ring handler.
GetRingsHandlerFunc turns a function with the right signature into a get rings handler.
ReplaceRingHandlerFunc turns a function with the right signature into a replace ring handler.