index

package
v1.3.7 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const SearchIndexBadRequestCode int = 400

SearchIndexBadRequestCode is the HTTP code returned for type SearchIndexBadRequest

View Source 
const SearchIndexOKCode int = 200

SearchIndexOKCode is the HTTP code returned for type SearchIndexOK

Variables

This section is empty.

Functions

This section is empty.

Types

type SearchIndex 

type SearchIndex struct {
	Context *middleware.Context
	Handler SearchIndexHandler
}
SearchIndex swagger:route POST /api/v1/index/retrieve index searchIndex

Searches index by entry metadata

EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases. The results returned from this endpoint may be incomplete.

func NewSearchIndex 

func NewSearchIndex(ctx *middleware.Context, handler SearchIndexHandler) *SearchIndex

NewSearchIndex creates a new http.Handler for the search index operation

func (*SearchIndex) ServeHTTP 

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

type SearchIndexBadRequest 

type SearchIndexBadRequest struct {

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

SearchIndexBadRequest The content supplied to the server was invalid

swagger:response searchIndexBadRequest

func NewSearchIndexBadRequest 

func NewSearchIndexBadRequest() *SearchIndexBadRequest

NewSearchIndexBadRequest creates SearchIndexBadRequest with default headers values

func (*SearchIndexBadRequest) SetPayload 

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

SetPayload sets the payload to the search index bad request response

func (*SearchIndexBadRequest) WithPayload 

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

WithPayload adds the payload to the search index bad request response

func (*SearchIndexBadRequest) WriteResponse 

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

WriteResponse to the client

type SearchIndexDefault 

type SearchIndexDefault struct {

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

SearchIndexDefault There was an internal error in the server while processing the request

swagger:response searchIndexDefault

func NewSearchIndexDefault 

func NewSearchIndexDefault(code int) *SearchIndexDefault

NewSearchIndexDefault creates SearchIndexDefault with default headers values

func (*SearchIndexDefault) SetPayload 

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

SetPayload sets the payload to the search index default response

func (*SearchIndexDefault) SetStatusCode 

func (o *SearchIndexDefault) SetStatusCode(code int)

SetStatusCode sets the status to the search index default response

func (*SearchIndexDefault) WithPayload 

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

WithPayload adds the payload to the search index default response

func (*SearchIndexDefault) WithStatusCode 

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

WithStatusCode adds the status to the search index default response

func (*SearchIndexDefault) WriteResponse 

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

WriteResponse to the client

type SearchIndexHandler 

type SearchIndexHandler interface {
	Handle(SearchIndexParams) middleware.Responder
}

SearchIndexHandler interface for that can handle valid search index params

type SearchIndexHandlerFunc 

type SearchIndexHandlerFunc func(SearchIndexParams) middleware.Responder

SearchIndexHandlerFunc turns a function with the right signature into a search index handler

func (SearchIndexHandlerFunc) Handle 

func (fn SearchIndexHandlerFunc) Handle(params SearchIndexParams) middleware.Responder

Handle executing the request and returning a response

type SearchIndexOK 

type SearchIndexOK struct {

	/*
	  In: Body
	*/
	Payload []string `json:"body,omitempty"`
}

SearchIndexOK Returns zero or more entry UUIDs from the transparency log based on search query

swagger:response searchIndexOK

func NewSearchIndexOK 

func NewSearchIndexOK() *SearchIndexOK

NewSearchIndexOK creates SearchIndexOK with default headers values

func (*SearchIndexOK) SetPayload 

func (o *SearchIndexOK) SetPayload(payload []string)

SetPayload sets the payload to the search index o k response

func (*SearchIndexOK) WithPayload 

func (o *SearchIndexOK) WithPayload(payload []string) *SearchIndexOK

WithPayload adds the payload to the search index o k response

func (*SearchIndexOK) WriteResponse 

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

WriteResponse to the client

type SearchIndexParams 

type SearchIndexParams struct {

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

	/*
	  Required: true
	  In: body
	*/
	Query *models.SearchIndex
}

SearchIndexParams contains all the bound params for the search index operation typically these are obtained from a http.Request

swagger:parameters searchIndex

func NewSearchIndexParams 

func NewSearchIndexParams() SearchIndexParams

NewSearchIndexParams creates a new SearchIndexParams object

There are no default values defined in the spec.

func (*SearchIndexParams) BindRequest 

func (o *SearchIndexParams) 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 NewSearchIndexParams() beforehand.

type SearchIndexURL 

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

SearchIndexURL generates an URL for the search index operation

func (*SearchIndexURL) Build 

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

Build a url path and query string

func (*SearchIndexURL) BuildFull 

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

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

func (*SearchIndexURL) Must 

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

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

func (*SearchIndexURL) SetBasePath 

func (o *SearchIndexURL) 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 (*SearchIndexURL) String 

func (o *SearchIndexURL) String() string

String returns the string representation of the path with query string

func (*SearchIndexURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*SearchIndexURL) WithBasePath 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.