package
0.26.33
Repository: https://github.com/openziti/edge-api.git
Documentation: pkg.go.dev

# Functions

NewCreateEdgeRouterPolicy creates a new http.Handler for the create edge router policy operation.
NewCreateEdgeRouterPolicyBadRequest creates CreateEdgeRouterPolicyBadRequest with default headers values.
NewCreateEdgeRouterPolicyCreated creates CreateEdgeRouterPolicyCreated with default headers values.
NewCreateEdgeRouterPolicyParams creates a new CreateEdgeRouterPolicyParams object There are no default values defined in the spec.
NewCreateEdgeRouterPolicyTooManyRequests creates CreateEdgeRouterPolicyTooManyRequests with default headers values.
NewCreateEdgeRouterPolicyUnauthorized creates CreateEdgeRouterPolicyUnauthorized with default headers values.
NewDeleteEdgeRouterPolicy creates a new http.Handler for the delete edge router policy operation.
NewDeleteEdgeRouterPolicyBadRequest creates DeleteEdgeRouterPolicyBadRequest with default headers values.
NewDeleteEdgeRouterPolicyConflict creates DeleteEdgeRouterPolicyConflict with default headers values.
NewDeleteEdgeRouterPolicyOK creates DeleteEdgeRouterPolicyOK with default headers values.
NewDeleteEdgeRouterPolicyParams creates a new DeleteEdgeRouterPolicyParams object There are no default values defined in the spec.
NewDeleteEdgeRouterPolicyTooManyRequests creates DeleteEdgeRouterPolicyTooManyRequests with default headers values.
NewDeleteEdgeRouterPolicyUnauthorized creates DeleteEdgeRouterPolicyUnauthorized with default headers values.
NewDetailEdgeRouterPolicy creates a new http.Handler for the detail edge router policy operation.
NewDetailEdgeRouterPolicyNotFound creates DetailEdgeRouterPolicyNotFound with default headers values.
NewDetailEdgeRouterPolicyOK creates DetailEdgeRouterPolicyOK with default headers values.
NewDetailEdgeRouterPolicyParams creates a new DetailEdgeRouterPolicyParams object There are no default values defined in the spec.
NewDetailEdgeRouterPolicyTooManyRequests creates DetailEdgeRouterPolicyTooManyRequests with default headers values.
NewDetailEdgeRouterPolicyUnauthorized creates DetailEdgeRouterPolicyUnauthorized with default headers values.
NewListEdgeRouterPolicies creates a new http.Handler for the list edge router policies operation.
NewListEdgeRouterPoliciesBadRequest creates ListEdgeRouterPoliciesBadRequest with default headers values.
NewListEdgeRouterPoliciesOK creates ListEdgeRouterPoliciesOK with default headers values.
NewListEdgeRouterPoliciesParams creates a new ListEdgeRouterPoliciesParams object There are no default values defined in the spec.
NewListEdgeRouterPoliciesTooManyRequests creates ListEdgeRouterPoliciesTooManyRequests with default headers values.
NewListEdgeRouterPoliciesUnauthorized creates ListEdgeRouterPoliciesUnauthorized with default headers values.
NewListEdgeRouterPolicyEdgeRouters creates a new http.Handler for the list edge router policy edge routers operation.
NewListEdgeRouterPolicyEdgeRoutersNotFound creates ListEdgeRouterPolicyEdgeRoutersNotFound with default headers values.
NewListEdgeRouterPolicyEdgeRoutersOK creates ListEdgeRouterPolicyEdgeRoutersOK with default headers values.
NewListEdgeRouterPolicyEdgeRoutersParams creates a new ListEdgeRouterPolicyEdgeRoutersParams object There are no default values defined in the spec.
NewListEdgeRouterPolicyEdgeRoutersTooManyRequests creates ListEdgeRouterPolicyEdgeRoutersTooManyRequests with default headers values.
NewListEdgeRouterPolicyEdgeRoutersUnauthorized creates ListEdgeRouterPolicyEdgeRoutersUnauthorized with default headers values.
NewListEdgeRouterPolicyIdentities creates a new http.Handler for the list edge router policy identities operation.
NewListEdgeRouterPolicyIdentitiesNotFound creates ListEdgeRouterPolicyIdentitiesNotFound with default headers values.
NewListEdgeRouterPolicyIdentitiesOK creates ListEdgeRouterPolicyIdentitiesOK with default headers values.
NewListEdgeRouterPolicyIdentitiesParams creates a new ListEdgeRouterPolicyIdentitiesParams object There are no default values defined in the spec.
NewListEdgeRouterPolicyIdentitiesTooManyRequests creates ListEdgeRouterPolicyIdentitiesTooManyRequests with default headers values.
NewListEdgeRouterPolicyIdentitiesUnauthorized creates ListEdgeRouterPolicyIdentitiesUnauthorized with default headers values.
NewPatchEdgeRouterPolicy creates a new http.Handler for the patch edge router policy operation.
NewPatchEdgeRouterPolicyBadRequest creates PatchEdgeRouterPolicyBadRequest with default headers values.
NewPatchEdgeRouterPolicyNotFound creates PatchEdgeRouterPolicyNotFound with default headers values.
NewPatchEdgeRouterPolicyOK creates PatchEdgeRouterPolicyOK with default headers values.
NewPatchEdgeRouterPolicyParams creates a new PatchEdgeRouterPolicyParams object There are no default values defined in the spec.
NewPatchEdgeRouterPolicyTooManyRequests creates PatchEdgeRouterPolicyTooManyRequests with default headers values.
NewPatchEdgeRouterPolicyUnauthorized creates PatchEdgeRouterPolicyUnauthorized with default headers values.
NewUpdateEdgeRouterPolicy creates a new http.Handler for the update edge router policy operation.
NewUpdateEdgeRouterPolicyBadRequest creates UpdateEdgeRouterPolicyBadRequest with default headers values.
NewUpdateEdgeRouterPolicyNotFound creates UpdateEdgeRouterPolicyNotFound with default headers values.
NewUpdateEdgeRouterPolicyOK creates UpdateEdgeRouterPolicyOK with default headers values.
NewUpdateEdgeRouterPolicyParams creates a new UpdateEdgeRouterPolicyParams object There are no default values defined in the spec.
NewUpdateEdgeRouterPolicyTooManyRequests creates UpdateEdgeRouterPolicyTooManyRequests with default headers values.
NewUpdateEdgeRouterPolicyUnauthorized creates UpdateEdgeRouterPolicyUnauthorized with default headers values.

# Constants

CreateEdgeRouterPolicyBadRequestCode is the HTTP code returned for type CreateEdgeRouterPolicyBadRequest.
CreateEdgeRouterPolicyCreatedCode is the HTTP code returned for type CreateEdgeRouterPolicyCreated.
CreateEdgeRouterPolicyTooManyRequestsCode is the HTTP code returned for type CreateEdgeRouterPolicyTooManyRequests.
CreateEdgeRouterPolicyUnauthorizedCode is the HTTP code returned for type CreateEdgeRouterPolicyUnauthorized.
DeleteEdgeRouterPolicyBadRequestCode is the HTTP code returned for type DeleteEdgeRouterPolicyBadRequest.
DeleteEdgeRouterPolicyConflictCode is the HTTP code returned for type DeleteEdgeRouterPolicyConflict.
DeleteEdgeRouterPolicyOKCode is the HTTP code returned for type DeleteEdgeRouterPolicyOK.
DeleteEdgeRouterPolicyTooManyRequestsCode is the HTTP code returned for type DeleteEdgeRouterPolicyTooManyRequests.
DeleteEdgeRouterPolicyUnauthorizedCode is the HTTP code returned for type DeleteEdgeRouterPolicyUnauthorized.
DetailEdgeRouterPolicyNotFoundCode is the HTTP code returned for type DetailEdgeRouterPolicyNotFound.
DetailEdgeRouterPolicyOKCode is the HTTP code returned for type DetailEdgeRouterPolicyOK.
DetailEdgeRouterPolicyTooManyRequestsCode is the HTTP code returned for type DetailEdgeRouterPolicyTooManyRequests.
DetailEdgeRouterPolicyUnauthorizedCode is the HTTP code returned for type DetailEdgeRouterPolicyUnauthorized.
ListEdgeRouterPoliciesBadRequestCode is the HTTP code returned for type ListEdgeRouterPoliciesBadRequest.
ListEdgeRouterPoliciesOKCode is the HTTP code returned for type ListEdgeRouterPoliciesOK.
ListEdgeRouterPoliciesTooManyRequestsCode is the HTTP code returned for type ListEdgeRouterPoliciesTooManyRequests.
ListEdgeRouterPoliciesUnauthorizedCode is the HTTP code returned for type ListEdgeRouterPoliciesUnauthorized.
ListEdgeRouterPolicyEdgeRoutersNotFoundCode is the HTTP code returned for type ListEdgeRouterPolicyEdgeRoutersNotFound.
ListEdgeRouterPolicyEdgeRoutersOKCode is the HTTP code returned for type ListEdgeRouterPolicyEdgeRoutersOK.
ListEdgeRouterPolicyEdgeRoutersTooManyRequestsCode is the HTTP code returned for type ListEdgeRouterPolicyEdgeRoutersTooManyRequests.
ListEdgeRouterPolicyEdgeRoutersUnauthorizedCode is the HTTP code returned for type ListEdgeRouterPolicyEdgeRoutersUnauthorized.
ListEdgeRouterPolicyIdentitiesNotFoundCode is the HTTP code returned for type ListEdgeRouterPolicyIdentitiesNotFound.
ListEdgeRouterPolicyIdentitiesOKCode is the HTTP code returned for type ListEdgeRouterPolicyIdentitiesOK.
ListEdgeRouterPolicyIdentitiesTooManyRequestsCode is the HTTP code returned for type ListEdgeRouterPolicyIdentitiesTooManyRequests.
ListEdgeRouterPolicyIdentitiesUnauthorizedCode is the HTTP code returned for type ListEdgeRouterPolicyIdentitiesUnauthorized.
PatchEdgeRouterPolicyBadRequestCode is the HTTP code returned for type PatchEdgeRouterPolicyBadRequest.
PatchEdgeRouterPolicyNotFoundCode is the HTTP code returned for type PatchEdgeRouterPolicyNotFound.
PatchEdgeRouterPolicyOKCode is the HTTP code returned for type PatchEdgeRouterPolicyOK.
PatchEdgeRouterPolicyTooManyRequestsCode is the HTTP code returned for type PatchEdgeRouterPolicyTooManyRequests.
PatchEdgeRouterPolicyUnauthorizedCode is the HTTP code returned for type PatchEdgeRouterPolicyUnauthorized.
UpdateEdgeRouterPolicyBadRequestCode is the HTTP code returned for type UpdateEdgeRouterPolicyBadRequest.
UpdateEdgeRouterPolicyNotFoundCode is the HTTP code returned for type UpdateEdgeRouterPolicyNotFound.
UpdateEdgeRouterPolicyOKCode is the HTTP code returned for type UpdateEdgeRouterPolicyOK.
UpdateEdgeRouterPolicyTooManyRequestsCode is the HTTP code returned for type UpdateEdgeRouterPolicyTooManyRequests.
UpdateEdgeRouterPolicyUnauthorizedCode is the HTTP code returned for type UpdateEdgeRouterPolicyUnauthorized.

# Structs

CreateEdgeRouterPolicy swagger:route POST /edge-router-policies Edge Router Policy createEdgeRouterPolicy Create an edge router policy resource Create an edge router policy resource.
CreateEdgeRouterPolicyBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
CreateEdgeRouterPolicyCreated The create request was successful and the resource has been added at the following location swagger:response createEdgeRouterPolicyCreated */.
CreateEdgeRouterPolicyParams contains all the bound params for the create edge router policy operation typically these are obtained from a http.Request swagger:parameters createEdgeRouterPolicy.
CreateEdgeRouterPolicyTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response createEdgeRouterPolicyTooManyRequests */.
CreateEdgeRouterPolicyUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createEdgeRouterPolicyUnauthorized */.
CreateEdgeRouterPolicyURL generates an URL for the create edge router policy operation.
DeleteEdgeRouterPolicy swagger:route DELETE /edge-router-policies/{id} Edge Router Policy deleteEdgeRouterPolicy Delete an edge router policy Delete an edge router policy by id.
DeleteEdgeRouterPolicyBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
DeleteEdgeRouterPolicyConflict The resource requested to be removed/altered cannot be as it is referenced by another object.
DeleteEdgeRouterPolicyOK The delete request was successful and the resource has been removed swagger:response deleteEdgeRouterPolicyOK */.
DeleteEdgeRouterPolicyParams contains all the bound params for the delete edge router policy operation typically these are obtained from a http.Request swagger:parameters deleteEdgeRouterPolicy.
DeleteEdgeRouterPolicyTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response deleteEdgeRouterPolicyTooManyRequests */.
DeleteEdgeRouterPolicyUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteEdgeRouterPolicyUnauthorized */.
DeleteEdgeRouterPolicyURL generates an URL for the delete edge router policy operation.
DetailEdgeRouterPolicy swagger:route GET /edge-router-policies/{id} Edge Router Policy detailEdgeRouterPolicy Retrieves a single edge router policy Retrieves a single edge router policy by id.
DetailEdgeRouterPolicyNotFound The requested resource does not exist swagger:response detailEdgeRouterPolicyNotFound */.
DetailEdgeRouterPolicyOK A single edge router policy swagger:response detailEdgeRouterPolicyOK */.
DetailEdgeRouterPolicyParams contains all the bound params for the detail edge router policy operation typically these are obtained from a http.Request swagger:parameters detailEdgeRouterPolicy.
DetailEdgeRouterPolicyTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response detailEdgeRouterPolicyTooManyRequests */.
DetailEdgeRouterPolicyUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailEdgeRouterPolicyUnauthorized */.
DetailEdgeRouterPolicyURL generates an URL for the detail edge router policy operation.
ListEdgeRouterPolicies swagger:route GET /edge-router-policies Edge Router Policy listEdgeRouterPolicies List edge router policies Retrieves a list of edge router policy resources; supports filtering, sorting, and pagination.
ListEdgeRouterPoliciesBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListEdgeRouterPoliciesOK A list of edge router policies swagger:response listEdgeRouterPoliciesOK */.
ListEdgeRouterPoliciesParams contains all the bound params for the list edge router policies operation typically these are obtained from a http.Request swagger:parameters listEdgeRouterPolicies.
ListEdgeRouterPoliciesTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listEdgeRouterPoliciesTooManyRequests */.
ListEdgeRouterPoliciesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listEdgeRouterPoliciesUnauthorized */.
ListEdgeRouterPoliciesURL generates an URL for the list edge router policies operation.
ListEdgeRouterPolicyEdgeRouters swagger:route GET /edge-router-policies/{id}/edge-routers Edge Router Policy listEdgeRouterPolicyEdgeRouters List edge routers a policy affects Retrieves a list of edge routers an edge router policy resources affects; supports filtering, sorting, and pagination.
ListEdgeRouterPolicyEdgeRoutersNotFound The requested resource does not exist swagger:response listEdgeRouterPolicyEdgeRoutersNotFound */.
ListEdgeRouterPolicyEdgeRoutersOK A list of edge routers swagger:response listEdgeRouterPolicyEdgeRoutersOK */.
ListEdgeRouterPolicyEdgeRoutersParams contains all the bound params for the list edge router policy edge routers operation typically these are obtained from a http.Request swagger:parameters listEdgeRouterPolicyEdgeRouters.
ListEdgeRouterPolicyEdgeRoutersTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listEdgeRouterPolicyEdgeRoutersTooManyRequests */.
ListEdgeRouterPolicyEdgeRoutersUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listEdgeRouterPolicyEdgeRoutersUnauthorized */.
ListEdgeRouterPolicyEdgeRoutersURL generates an URL for the list edge router policy edge routers operation.
ListEdgeRouterPolicyIdentities swagger:route GET /edge-router-policies/{id}/identities Edge Router Policy listEdgeRouterPolicyIdentities List identities an edge router policy affects Retrieves a list of identities an edge router policy resources affects; supports filtering, sorting, and pagination.
ListEdgeRouterPolicyIdentitiesNotFound The requested resource does not exist swagger:response listEdgeRouterPolicyIdentitiesNotFound */.
ListEdgeRouterPolicyIdentitiesOK A list of identities swagger:response listEdgeRouterPolicyIdentitiesOK */.
ListEdgeRouterPolicyIdentitiesParams contains all the bound params for the list edge router policy identities operation typically these are obtained from a http.Request swagger:parameters listEdgeRouterPolicyIdentities.
ListEdgeRouterPolicyIdentitiesTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listEdgeRouterPolicyIdentitiesTooManyRequests */.
ListEdgeRouterPolicyIdentitiesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listEdgeRouterPolicyIdentitiesUnauthorized */.
ListEdgeRouterPolicyIdentitiesURL generates an URL for the list edge router policy identities operation.
PatchEdgeRouterPolicy swagger:route PATCH /edge-router-policies/{id} Edge Router Policy patchEdgeRouterPolicy Update the supplied fields on an edge router policy Update the supplied fields on an edge router policy.
PatchEdgeRouterPolicyBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
PatchEdgeRouterPolicyNotFound The requested resource does not exist swagger:response patchEdgeRouterPolicyNotFound */.
PatchEdgeRouterPolicyOK The patch request was successful and the resource has been altered swagger:response patchEdgeRouterPolicyOK */.
PatchEdgeRouterPolicyParams contains all the bound params for the patch edge router policy operation typically these are obtained from a http.Request swagger:parameters patchEdgeRouterPolicy.
PatchEdgeRouterPolicyTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response patchEdgeRouterPolicyTooManyRequests */.
PatchEdgeRouterPolicyUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response patchEdgeRouterPolicyUnauthorized */.
PatchEdgeRouterPolicyURL generates an URL for the patch edge router policy operation.
UpdateEdgeRouterPolicy swagger:route PUT /edge-router-policies/{id} Edge Router Policy updateEdgeRouterPolicy Update all fields on an edge router policy Update all fields on an edge router policy by id.
UpdateEdgeRouterPolicyBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
UpdateEdgeRouterPolicyNotFound The requested resource does not exist swagger:response updateEdgeRouterPolicyNotFound */.
UpdateEdgeRouterPolicyOK The update request was successful and the resource has been altered swagger:response updateEdgeRouterPolicyOK */.
UpdateEdgeRouterPolicyParams contains all the bound params for the update edge router policy operation typically these are obtained from a http.Request swagger:parameters updateEdgeRouterPolicy.
UpdateEdgeRouterPolicyTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response updateEdgeRouterPolicyTooManyRequests */.
UpdateEdgeRouterPolicyUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response updateEdgeRouterPolicyUnauthorized */.
UpdateEdgeRouterPolicyURL generates an URL for the update edge router policy operation.

# Interfaces

CreateEdgeRouterPolicyHandler interface for that can handle valid create edge router policy params.
DeleteEdgeRouterPolicyHandler interface for that can handle valid delete edge router policy params.
DetailEdgeRouterPolicyHandler interface for that can handle valid detail edge router policy params.
ListEdgeRouterPoliciesHandler interface for that can handle valid list edge router policies params.
ListEdgeRouterPolicyEdgeRoutersHandler interface for that can handle valid list edge router policy edge routers params.
ListEdgeRouterPolicyIdentitiesHandler interface for that can handle valid list edge router policy identities params.
PatchEdgeRouterPolicyHandler interface for that can handle valid patch edge router policy params.
UpdateEdgeRouterPolicyHandler interface for that can handle valid update edge router policy params.

# Type aliases

CreateEdgeRouterPolicyHandlerFunc turns a function with the right signature into a create edge router policy handler.
DeleteEdgeRouterPolicyHandlerFunc turns a function with the right signature into a delete edge router policy handler.
DetailEdgeRouterPolicyHandlerFunc turns a function with the right signature into a detail edge router policy handler.
ListEdgeRouterPoliciesHandlerFunc turns a function with the right signature into a list edge router policies handler.
ListEdgeRouterPolicyEdgeRoutersHandlerFunc turns a function with the right signature into a list edge router policy edge routers handler.
ListEdgeRouterPolicyIdentitiesHandlerFunc turns a function with the right signature into a list edge router policy identities handler.
PatchEdgeRouterPolicyHandlerFunc turns a function with the right signature into a patch edge router policy handler.
UpdateEdgeRouterPolicyHandlerFunc turns a function with the right signature into a update edge router policy handler.