operations

Documentation

Index

• type PlanManagerManagementAPIAPI
  • func NewPlanManagerManagementAPIAPI(spec *loads.Document) *PlanManagerManagementAPIAPI
  • func (o *PlanManagerManagementAPIAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
  • func (o *PlanManagerManagementAPIAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
  • func (o *PlanManagerManagementAPIAPI) Authorizer() runtime.Authorizer
  • func (o *PlanManagerManagementAPIAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
  • func (o *PlanManagerManagementAPIAPI) Context() *middleware.Context
  • func (o *PlanManagerManagementAPIAPI) DefaultConsumes() string
  • func (o *PlanManagerManagementAPIAPI) DefaultProduces() string
  • func (o *PlanManagerManagementAPIAPI) Formats() strfmt.Registry
  • func (o *PlanManagerManagementAPIAPI) HandlerFor(method, path string) (http.Handler, bool)
  • func (o *PlanManagerManagementAPIAPI) Init()
  • func (o *PlanManagerManagementAPIAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
  • func (o *PlanManagerManagementAPIAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
  • func (o *PlanManagerManagementAPIAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
  • func (o *PlanManagerManagementAPIAPI) RegisterProducer(mediaType string, producer runtime.Producer)
  • func (o *PlanManagerManagementAPIAPI) Serve(builder middleware.Builder) http.Handler
  • func (o *PlanManagerManagementAPIAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
  • func (o *PlanManagerManagementAPIAPI) SetDefaultConsumes(mediaType string)
  • func (o *PlanManagerManagementAPIAPI) SetDefaultProduces(mediaType string)
  • func (o *PlanManagerManagementAPIAPI) SetSpec(spec *loads.Document)
  • func (o *PlanManagerManagementAPIAPI) UseRedoc()
  • func (o *PlanManagerManagementAPIAPI) UseSwaggerUI()
  • func (o *PlanManagerManagementAPIAPI) Validate() error

Types

type PlanManagerManagementAPIAPI

type PlanManagerManagementAPIAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// APIKeyHeaderAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key X-API-KEY provided in the header
	APIKeyHeaderAuth func(string) (interface{}, error)

	// APIKeyParamAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key api_key provided in the query
	APIKeyParamAuth func(string) (interface{}, error)

	// KeycloakAuth registers a function that takes an access token and a collection of required scopes and returns a principal
	// it performs authentication based on an oauth2 bearer token provided in the request
	KeycloakAuth func(string, []string) (interface{}, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// CycleManagementCreateCycleHandler sets the operation handler for the create cycle operation
	CycleManagementCreateCycleHandler cycle_management.CreateCycleHandler
	// PlanManagementCreatePlanHandler sets the operation handler for the create plan operation
	PlanManagementCreatePlanHandler plan_management.CreatePlanHandler
	// SkuManagementCreateSkuHandler sets the operation handler for the create sku operation
	SkuManagementCreateSkuHandler sku_management.CreateSkuHandler
	// BundleManagementCreateSkuBundleHandler sets the operation handler for the create sku bundle operation
	BundleManagementCreateSkuBundleHandler bundle_management.CreateSkuBundleHandler
	// PriceManagementCreateSkuPriceHandler sets the operation handler for the create sku price operation
	PriceManagementCreateSkuPriceHandler price_management.CreateSkuPriceHandler
	// TriggerManagementExecSampleHandler sets the operation handler for the exec sample operation
	TriggerManagementExecSampleHandler trigger_management.ExecSampleHandler
	// PlanManagementGetCompletePlanHandler sets the operation handler for the get complete plan operation
	PlanManagementGetCompletePlanHandler plan_management.GetCompletePlanHandler
	// CycleManagementGetCycleHandler sets the operation handler for the get cycle operation
	CycleManagementGetCycleHandler cycle_management.GetCycleHandler
	// PlanManagementGetPlanHandler sets the operation handler for the get plan operation
	PlanManagementGetPlanHandler plan_management.GetPlanHandler
	// SkuManagementGetSkuHandler sets the operation handler for the get sku operation
	SkuManagementGetSkuHandler sku_management.GetSkuHandler
	// BundleManagementGetSkuBundleHandler sets the operation handler for the get sku bundle operation
	BundleManagementGetSkuBundleHandler bundle_management.GetSkuBundleHandler
	// BundleManagementGetSkuBundleByNameHandler sets the operation handler for the get sku bundle by name operation
	BundleManagementGetSkuBundleByNameHandler bundle_management.GetSkuBundleByNameHandler
	// PriceManagementGetSkuPriceHandler sets the operation handler for the get sku price operation
	PriceManagementGetSkuPriceHandler price_management.GetSkuPriceHandler
	// StatusManagementGetStatusHandler sets the operation handler for the get status operation
	StatusManagementGetStatusHandler status_management.GetStatusHandler
	// PlanManagementListCompletePlansHandler sets the operation handler for the list complete plans operation
	PlanManagementListCompletePlansHandler plan_management.ListCompletePlansHandler
	// CycleManagementListCyclesHandler sets the operation handler for the list cycles operation
	CycleManagementListCyclesHandler cycle_management.ListCyclesHandler
	// PlanManagementListPlansHandler sets the operation handler for the list plans operation
	PlanManagementListPlansHandler plan_management.ListPlansHandler
	// BundleManagementListSkuBundlesHandler sets the operation handler for the list sku bundles operation
	BundleManagementListSkuBundlesHandler bundle_management.ListSkuBundlesHandler
	// PriceManagementListSkuPricesHandler sets the operation handler for the list sku prices operation
	PriceManagementListSkuPricesHandler price_management.ListSkuPricesHandler
	// SkuManagementListSkusHandler sets the operation handler for the list skus operation
	SkuManagementListSkusHandler sku_management.ListSkusHandler
	// StatusManagementShowStatusHandler sets the operation handler for the show status operation
	StatusManagementShowStatusHandler status_management.ShowStatusHandler
	// CycleManagementUpdateCycleHandler sets the operation handler for the update cycle operation
	CycleManagementUpdateCycleHandler cycle_management.UpdateCycleHandler
	// PlanManagementUpdatePlanHandler sets the operation handler for the update plan operation
	PlanManagementUpdatePlanHandler plan_management.UpdatePlanHandler
	// SkuManagementUpdateSkuHandler sets the operation handler for the update sku operation
	SkuManagementUpdateSkuHandler sku_management.UpdateSkuHandler
	// BundleManagementUpdateSkuBundleHandler sets the operation handler for the update sku bundle operation
	BundleManagementUpdateSkuBundleHandler bundle_management.UpdateSkuBundleHandler
	// PriceManagementUpdateSkuPriceHandler sets the operation handler for the update sku price operation
	PriceManagementUpdateSkuPriceHandler price_management.UpdateSkuPriceHandler
	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

PlanManagerManagementAPIAPI An API which supports creation, deletion, listing etc of Plan Manager

func NewPlanManagerManagementAPIAPI

func NewPlanManagerManagementAPIAPI(spec *loads.Document) *PlanManagerManagementAPIAPI

NewPlanManagerManagementAPIAPI creates a new PlanManagerManagementAPI instance

func (*PlanManagerManagementAPIAPI) AddMiddlewareFor

func (o *PlanManagerManagementAPIAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*PlanManagerManagementAPIAPI) AuthenticatorsFor

func (o *PlanManagerManagementAPIAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*PlanManagerManagementAPIAPI) Authorizer

func (o *PlanManagerManagementAPIAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*PlanManagerManagementAPIAPI) ConsumersFor

func (o *PlanManagerManagementAPIAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*PlanManagerManagementAPIAPI) Context

func (o *PlanManagerManagementAPIAPI) Context() *middleware.Context

Context returns the middleware context for the plan manager management API API

func (*PlanManagerManagementAPIAPI) DefaultConsumes

func (o *PlanManagerManagementAPIAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*PlanManagerManagementAPIAPI) DefaultProduces

func (o *PlanManagerManagementAPIAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*PlanManagerManagementAPIAPI) Formats

func (o *PlanManagerManagementAPIAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*PlanManagerManagementAPIAPI) HandlerFor

func (o *PlanManagerManagementAPIAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*PlanManagerManagementAPIAPI) Init

func (o *PlanManagerManagementAPIAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*PlanManagerManagementAPIAPI) ProducersFor

func (o *PlanManagerManagementAPIAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*PlanManagerManagementAPIAPI) RegisterConsumer

func (o *PlanManagerManagementAPIAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*PlanManagerManagementAPIAPI) RegisterFormat

func (o *PlanManagerManagementAPIAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*PlanManagerManagementAPIAPI) RegisterProducer

func (o *PlanManagerManagementAPIAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*PlanManagerManagementAPIAPI) Serve

func (o *PlanManagerManagementAPIAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*PlanManagerManagementAPIAPI) ServeErrorFor

func (o *PlanManagerManagementAPIAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*PlanManagerManagementAPIAPI) SetDefaultConsumes

func (o *PlanManagerManagementAPIAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*PlanManagerManagementAPIAPI) SetDefaultProduces

func (o *PlanManagerManagementAPIAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*PlanManagerManagementAPIAPI) SetSpec

func (o *PlanManagerManagementAPIAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*PlanManagerManagementAPIAPI) UseRedoc

func (o *PlanManagerManagementAPIAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*PlanManagerManagementAPIAPI) UseSwaggerUI

func (o *PlanManagerManagementAPIAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*PlanManagerManagementAPIAPI) Validate

func (o *PlanManagerManagementAPIAPI) Validate() error

Validate validates the registrations in the PlanManagerManagementAPIAPI