operations

package
v0.0.0-...-953e845 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 30, 2020 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const DescribeInternalServerErrorCode int = 500

DescribeInternalServerErrorCode is the HTTP code returned for type DescribeInternalServerError

View Source
const DescribeOKCode int = 200

DescribeOKCode is the HTTP code returned for type DescribeOK

View Source
const ListInternalServerErrorCode int = 500

ListInternalServerErrorCode is the HTTP code returned for type ListInternalServerError

View Source
const ListOKCode int = 200

ListOKCode is the HTTP code returned for type ListOK

Variables

This section is empty.

Functions

This section is empty.

Types

type Describe

type Describe struct {
	Context *middleware.Context
	Handler DescribeHandler
}

Describe swagger:route GET /v1/describe/stacks/{stackName}/versions/{version} describe

Describe describe API

func NewDescribe

func NewDescribe(ctx *middleware.Context, handler DescribeHandler) *Describe

NewDescribe creates a new http.Handler for the describe operation

func (*Describe) ServeHTTP

func (o *Describe) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type DescribeDefault

type DescribeDefault struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
	// contains filtered or unexported fields
}

DescribeDefault error

swagger:response describeDefault

func NewDescribeDefault

func NewDescribeDefault(code int) *DescribeDefault

NewDescribeDefault creates DescribeDefault with default headers values

func (*DescribeDefault) SetPayload

func (o *DescribeDefault) SetPayload(payload *models.Error)

SetPayload sets the payload to the describe default response

func (*DescribeDefault) SetStatusCode

func (o *DescribeDefault) SetStatusCode(code int)

SetStatusCode sets the status to the describe default response

func (*DescribeDefault) WithPayload

func (o *DescribeDefault) WithPayload(payload *models.Error) *DescribeDefault

WithPayload adds the payload to the describe default response

func (*DescribeDefault) WithStatusCode

func (o *DescribeDefault) WithStatusCode(code int) *DescribeDefault

WithStatusCode adds the status to the describe default response

func (*DescribeDefault) WriteResponse

func (o *DescribeDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DescribeHandler

type DescribeHandler interface {
	Handle(DescribeParams) middleware.Responder
}

DescribeHandler interface for that can handle valid describe params

type DescribeHandlerFunc

type DescribeHandlerFunc func(DescribeParams) middleware.Responder

DescribeHandlerFunc turns a function with the right signature into a describe handler

func (DescribeHandlerFunc) Handle

Handle executing the request and returning a response

type DescribeInternalServerError

type DescribeInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.Message `json:"body,omitempty"`
}

DescribeInternalServerError describe stack error

swagger:response describeInternalServerError

func NewDescribeInternalServerError

func NewDescribeInternalServerError() *DescribeInternalServerError

NewDescribeInternalServerError creates DescribeInternalServerError with default headers values

func (*DescribeInternalServerError) SetPayload

func (o *DescribeInternalServerError) SetPayload(payload *models.Message)

SetPayload sets the payload to the describe internal server error response

func (*DescribeInternalServerError) WithPayload

WithPayload adds the payload to the describe internal server error response

func (*DescribeInternalServerError) WriteResponse

func (o *DescribeInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DescribeOK

type DescribeOK struct {

	/*
	  In: Body
	*/
	Payload *models.DescribeStack `json:"body,omitempty"`
}

DescribeOK describe stack

swagger:response describeOK

func NewDescribeOK

func NewDescribeOK() *DescribeOK

NewDescribeOK creates DescribeOK with default headers values

func (*DescribeOK) SetPayload

func (o *DescribeOK) SetPayload(payload *models.DescribeStack)

SetPayload sets the payload to the describe o k response

func (*DescribeOK) WithPayload

func (o *DescribeOK) WithPayload(payload *models.DescribeStack) *DescribeOK

WithPayload adds the payload to the describe o k response

func (*DescribeOK) WriteResponse

func (o *DescribeOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type DescribeParams

type DescribeParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  Required: true
	  In: path
	*/
	StackName string
	/*
	  Required: true
	  In: path
	*/
	Version string
}

DescribeParams contains all the bound params for the describe operation typically these are obtained from a http.Request

swagger:parameters describe

func NewDescribeParams

func NewDescribeParams() DescribeParams

NewDescribeParams creates a new DescribeParams object no default values defined in spec.

func (*DescribeParams) BindRequest

func (o *DescribeParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewDescribeParams() beforehand.

type DescribeURL

type DescribeURL struct {
	StackName string
	Version   string
	// contains filtered or unexported fields
}

DescribeURL generates an URL for the describe operation

func (*DescribeURL) Build

func (o *DescribeURL) Build() (*url.URL, error)

Build a url path and query string

func (*DescribeURL) BuildFull

func (o *DescribeURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*DescribeURL) Must

func (o *DescribeURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*DescribeURL) SetBasePath

func (o *DescribeURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*DescribeURL) String

func (o *DescribeURL) String() string

String returns the string representation of the path with query string

func (*DescribeURL) StringFull

func (o *DescribeURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*DescribeURL) WithBasePath

func (o *DescribeURL) WithBasePath(bp string) *DescribeURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type KabaneroRestServicesAPI

type KabaneroRestServicesAPI 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/io.goswagger.examples.todo-list.v1+json
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/io.goswagger.examples.todo-list.v1+json
	JSONProducer runtime.Producer

	// MessageGetHandler sets the operation handler for the get operation
	MessageGetHandler message.GetHandler
	// MessageGetTestHandler sets the operation handler for the get test operation
	MessageGetTestHandler message.GetTestHandler
	// MessageGetVersionHandler sets the operation handler for the get version operation
	MessageGetVersionHandler message.GetVersionHandler
	// DescribeHandler sets the operation handler for the describe operation
	DescribeHandler DescribeHandler
	// ListHandler sets the operation handler for the list operation
	ListHandler ListHandler
	// 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
}

KabaneroRestServicesAPI For the Kabanero REST service

func NewKabaneroRestServicesAPI

func NewKabaneroRestServicesAPI(spec *loads.Document) *KabaneroRestServicesAPI

NewKabaneroRestServicesAPI creates a new KabaneroRestServices instance

func (*KabaneroRestServicesAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*KabaneroRestServicesAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*KabaneroRestServicesAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*KabaneroRestServicesAPI) ConsumersFor

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

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

func (*KabaneroRestServicesAPI) Context

Context returns the middleware context for the kabanero rest services API

func (*KabaneroRestServicesAPI) DefaultConsumes

func (o *KabaneroRestServicesAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*KabaneroRestServicesAPI) DefaultProduces

func (o *KabaneroRestServicesAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*KabaneroRestServicesAPI) Formats

Formats returns the registered string formats

func (*KabaneroRestServicesAPI) HandlerFor

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

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

func (*KabaneroRestServicesAPI) Init

func (o *KabaneroRestServicesAPI) Init()

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

func (*KabaneroRestServicesAPI) ProducersFor

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

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

func (*KabaneroRestServicesAPI) RegisterConsumer

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

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

func (*KabaneroRestServicesAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*KabaneroRestServicesAPI) RegisterProducer

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

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

func (*KabaneroRestServicesAPI) Serve

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

func (*KabaneroRestServicesAPI) ServeErrorFor

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

ServeErrorFor gets a error handler for a given operation id

func (*KabaneroRestServicesAPI) SetDefaultConsumes

func (o *KabaneroRestServicesAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*KabaneroRestServicesAPI) SetDefaultProduces

func (o *KabaneroRestServicesAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*KabaneroRestServicesAPI) SetSpec

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

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

func (*KabaneroRestServicesAPI) Validate

func (o *KabaneroRestServicesAPI) Validate() error

Validate validates the registrations in the KabaneroRestServicesAPI

type List

type List struct {
	Context *middleware.Context
	Handler ListHandler
}

List swagger:route GET /v1/stacks list

List list API

func NewList

func NewList(ctx *middleware.Context, handler ListHandler) *List

NewList creates a new http.Handler for the list operation

func (*List) ServeHTTP

func (o *List) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type ListDefault

type ListDefault struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
	// contains filtered or unexported fields
}

ListDefault error

swagger:response listDefault

func NewListDefault

func NewListDefault(code int) *ListDefault

NewListDefault creates ListDefault with default headers values

func (*ListDefault) SetPayload

func (o *ListDefault) SetPayload(payload *models.Error)

SetPayload sets the payload to the list default response

func (*ListDefault) SetStatusCode

func (o *ListDefault) SetStatusCode(code int)

SetStatusCode sets the status to the list default response

func (*ListDefault) WithPayload

func (o *ListDefault) WithPayload(payload *models.Error) *ListDefault

WithPayload adds the payload to the list default response

func (*ListDefault) WithStatusCode

func (o *ListDefault) WithStatusCode(code int) *ListDefault

WithStatusCode adds the status to the list default response

func (*ListDefault) WriteResponse

func (o *ListDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ListHandler

type ListHandler interface {
	Handle(ListParams) middleware.Responder
}

ListHandler interface for that can handle valid list params

type ListHandlerFunc

type ListHandlerFunc func(ListParams) middleware.Responder

ListHandlerFunc turns a function with the right signature into a list handler

func (ListHandlerFunc) Handle

func (fn ListHandlerFunc) Handle(params ListParams) middleware.Responder

Handle executing the request and returning a response

type ListInternalServerError

type ListInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.Message `json:"body,omitempty"`
}

ListInternalServerError list stack error

swagger:response listInternalServerError

func NewListInternalServerError

func NewListInternalServerError() *ListInternalServerError

NewListInternalServerError creates ListInternalServerError with default headers values

func (*ListInternalServerError) SetPayload

func (o *ListInternalServerError) SetPayload(payload *models.Message)

SetPayload sets the payload to the list internal server error response

func (*ListInternalServerError) WithPayload

WithPayload adds the payload to the list internal server error response

func (*ListInternalServerError) WriteResponse

func (o *ListInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ListOK

type ListOK struct {

	/*
	  In: Body
	*/
	Payload []*models.KabaneroStack `json:"body,omitempty"`
}

ListOK list successful

swagger:response listOK

func NewListOK

func NewListOK() *ListOK

NewListOK creates ListOK with default headers values

func (*ListOK) SetPayload

func (o *ListOK) SetPayload(payload []*models.KabaneroStack)

SetPayload sets the payload to the list o k response

func (*ListOK) WithPayload

func (o *ListOK) WithPayload(payload []*models.KabaneroStack) *ListOK

WithPayload adds the payload to the list o k response

func (*ListOK) WriteResponse

func (o *ListOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ListParams

type ListParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

ListParams contains all the bound params for the list operation typically these are obtained from a http.Request

swagger:parameters list

func NewListParams

func NewListParams() ListParams

NewListParams creates a new ListParams object no default values defined in spec.

func (*ListParams) BindRequest

func (o *ListParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewListParams() beforehand.

type ListURL

type ListURL struct {
	// contains filtered or unexported fields
}

ListURL generates an URL for the list operation

func (*ListURL) Build

func (o *ListURL) Build() (*url.URL, error)

Build a url path and query string

func (*ListURL) BuildFull

func (o *ListURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*ListURL) Must

func (o *ListURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*ListURL) SetBasePath

func (o *ListURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*ListURL) String

func (o *ListURL) String() string

String returns the string representation of the path with query string

func (*ListURL) StringFull

func (o *ListURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*ListURL) WithBasePath

func (o *ListURL) WithBasePath(bp string) *ListURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL