geo_region

package
v0.17.62 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const DetailGeoRegionNotFoundCode int = 404

DetailGeoRegionNotFoundCode is the HTTP code returned for type DetailGeoRegionNotFound

View Source 
const DetailGeoRegionOKCode int = 200

DetailGeoRegionOKCode is the HTTP code returned for type DetailGeoRegionOK

View Source 
const DetailGeoRegionUnauthorizedCode int = 401

DetailGeoRegionUnauthorizedCode is the HTTP code returned for type DetailGeoRegionUnauthorized

View Source 
const ListGeoRegionsOKCode int = 200

ListGeoRegionsOKCode is the HTTP code returned for type ListGeoRegionsOK

View Source 
const ListGeoRegionsUnauthorizedCode int = 401

ListGeoRegionsUnauthorizedCode is the HTTP code returned for type ListGeoRegionsUnauthorized

Variables

This section is empty.

Functions

This section is empty.

Types

type DetailGeoRegion 

type DetailGeoRegion struct {
	Context *middleware.Context
	Handler DetailGeoRegionHandler
}

DetailGeoRegion swagger:route GET /geo-regions/{id} Geo Region detailGeoRegion

Retrieves a geo-region

Retrieves a single geo-region by id. Requires admin access.

func NewDetailGeoRegion 

func NewDetailGeoRegion(ctx *middleware.Context, handler DetailGeoRegionHandler) *DetailGeoRegion

NewDetailGeoRegion creates a new http.Handler for the detail geo region operation

func (*DetailGeoRegion) ServeHTTP 

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

type DetailGeoRegionHandler 

type DetailGeoRegionHandler interface {
	Handle(DetailGeoRegionParams, interface{}) middleware.Responder
}

DetailGeoRegionHandler interface for that can handle valid detail geo region params

type DetailGeoRegionHandlerFunc 

type DetailGeoRegionHandlerFunc func(DetailGeoRegionParams, interface{}) middleware.Responder

DetailGeoRegionHandlerFunc turns a function with the right signature into a detail geo region handler

func (DetailGeoRegionHandlerFunc) Handle 

func (fn DetailGeoRegionHandlerFunc) Handle(params DetailGeoRegionParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type DetailGeoRegionNotFound 

type DetailGeoRegionNotFound struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DetailGeoRegionNotFound The requested resource does not exist

swagger:response detailGeoRegionNotFound

func NewDetailGeoRegionNotFound 

func NewDetailGeoRegionNotFound() *DetailGeoRegionNotFound

NewDetailGeoRegionNotFound creates DetailGeoRegionNotFound with default headers values

func (*DetailGeoRegionNotFound) SetPayload 

func (o *DetailGeoRegionNotFound) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the detail geo region not found response

func (*DetailGeoRegionNotFound) WithPayload 

func (o *DetailGeoRegionNotFound) WithPayload(payload *rest_model.APIErrorEnvelope) *DetailGeoRegionNotFound

WithPayload adds the payload to the detail geo region not found response

func (*DetailGeoRegionNotFound) WriteResponse 

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

WriteResponse to the client

type DetailGeoRegionOK 

type DetailGeoRegionOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.DetailGeoRegionEnvelope `json:"body,omitempty"`
}

DetailGeoRegionOK A single geo-region

swagger:response detailGeoRegionOK

func NewDetailGeoRegionOK 

func NewDetailGeoRegionOK() *DetailGeoRegionOK

NewDetailGeoRegionOK creates DetailGeoRegionOK with default headers values

func (*DetailGeoRegionOK) SetPayload 

func (o *DetailGeoRegionOK) SetPayload(payload *rest_model.DetailGeoRegionEnvelope)

SetPayload sets the payload to the detail geo region o k response

func (*DetailGeoRegionOK) WithPayload 

func (o *DetailGeoRegionOK) WithPayload(payload *rest_model.DetailGeoRegionEnvelope) *DetailGeoRegionOK

WithPayload adds the payload to the detail geo region o k response

func (*DetailGeoRegionOK) WriteResponse 

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

WriteResponse to the client

type DetailGeoRegionParams 

type DetailGeoRegionParams struct {

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

	/*The id of the requested resource
	  Required: true
	  In: path
	*/
	ID string
}

DetailGeoRegionParams contains all the bound params for the detail geo region operation typically these are obtained from a http.Request

swagger:parameters detailGeoRegion

func NewDetailGeoRegionParams 

func NewDetailGeoRegionParams() DetailGeoRegionParams

NewDetailGeoRegionParams creates a new DetailGeoRegionParams object no default values defined in spec.

func (*DetailGeoRegionParams) BindRequest 

func (o *DetailGeoRegionParams) 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 NewDetailGeoRegionParams() beforehand.

type DetailGeoRegionURL 

type DetailGeoRegionURL struct {
	ID string
	// contains filtered or unexported fields
}

DetailGeoRegionURL generates an URL for the detail geo region operation

func (*DetailGeoRegionURL) Build 

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

Build a url path and query string

func (*DetailGeoRegionURL) BuildFull 

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

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

func (*DetailGeoRegionURL) Must 

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

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

func (*DetailGeoRegionURL) SetBasePath 

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

func (o *DetailGeoRegionURL) String() string

String returns the string representation of the path with query string

func (*DetailGeoRegionURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*DetailGeoRegionURL) WithBasePath 

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

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 DetailGeoRegionUnauthorized 

type DetailGeoRegionUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DetailGeoRegionUnauthorized The currently supplied session does not have the correct access rights to request this resource

swagger:response detailGeoRegionUnauthorized

func NewDetailGeoRegionUnauthorized 

func NewDetailGeoRegionUnauthorized() *DetailGeoRegionUnauthorized

NewDetailGeoRegionUnauthorized creates DetailGeoRegionUnauthorized with default headers values

func (*DetailGeoRegionUnauthorized) SetPayload 

func (o *DetailGeoRegionUnauthorized) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the detail geo region unauthorized response

func (*DetailGeoRegionUnauthorized) WithPayload 

func (o *DetailGeoRegionUnauthorized) WithPayload(payload *rest_model.APIErrorEnvelope) *DetailGeoRegionUnauthorized

WithPayload adds the payload to the detail geo region unauthorized response

func (*DetailGeoRegionUnauthorized) WriteResponse 

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

WriteResponse to the client

type ListGeoRegions 

type ListGeoRegions struct {
	Context *middleware.Context
	Handler ListGeoRegionsHandler
}

ListGeoRegions swagger:route GET /geo-regions Geo Region listGeoRegions

List available geo-regions

Retrieves a list of geo-regions; supports filtering, sorting, and pagination. Requires admin access.

func NewListGeoRegions 

func NewListGeoRegions(ctx *middleware.Context, handler ListGeoRegionsHandler) *ListGeoRegions

NewListGeoRegions creates a new http.Handler for the list geo regions operation

func (*ListGeoRegions) ServeHTTP 

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

type ListGeoRegionsHandler 

type ListGeoRegionsHandler interface {
	Handle(ListGeoRegionsParams, interface{}) middleware.Responder
}

ListGeoRegionsHandler interface for that can handle valid list geo regions params

type ListGeoRegionsHandlerFunc 

type ListGeoRegionsHandlerFunc func(ListGeoRegionsParams, interface{}) middleware.Responder

ListGeoRegionsHandlerFunc turns a function with the right signature into a list geo regions handler

func (ListGeoRegionsHandlerFunc) Handle 

func (fn ListGeoRegionsHandlerFunc) Handle(params ListGeoRegionsParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type ListGeoRegionsOK 

type ListGeoRegionsOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.ListGeoRegionsEnvelope `json:"body,omitempty"`
}

ListGeoRegionsOK A list of geo-regions

swagger:response listGeoRegionsOK

func NewListGeoRegionsOK 

func NewListGeoRegionsOK() *ListGeoRegionsOK

NewListGeoRegionsOK creates ListGeoRegionsOK with default headers values

func (*ListGeoRegionsOK) SetPayload 

func (o *ListGeoRegionsOK) SetPayload(payload *rest_model.ListGeoRegionsEnvelope)

SetPayload sets the payload to the list geo regions o k response

func (*ListGeoRegionsOK) WithPayload 

func (o *ListGeoRegionsOK) WithPayload(payload *rest_model.ListGeoRegionsEnvelope) *ListGeoRegionsOK

WithPayload adds the payload to the list geo regions o k response

func (*ListGeoRegionsOK) WriteResponse 

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

WriteResponse to the client

type ListGeoRegionsParams 

type ListGeoRegionsParams struct {

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

	/*
	  In: query
	*/
	Filter *string
	/*
	  In: query
	*/
	Limit *int64
	/*
	  In: query
	*/
	Offset *int64
}

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

swagger:parameters listGeoRegions

func NewListGeoRegionsParams 

func NewListGeoRegionsParams() ListGeoRegionsParams

NewListGeoRegionsParams creates a new ListGeoRegionsParams object no default values defined in spec.

func (*ListGeoRegionsParams) BindRequest 

func (o *ListGeoRegionsParams) 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 NewListGeoRegionsParams() beforehand.

type ListGeoRegionsURL 

type ListGeoRegionsURL struct {
	Filter *string
	Limit  *int64
	Offset *int64
	// contains filtered or unexported fields
}

ListGeoRegionsURL generates an URL for the list geo regions operation

func (*ListGeoRegionsURL) Build 

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

Build a url path and query string

func (*ListGeoRegionsURL) BuildFull 

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

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

func (*ListGeoRegionsURL) Must 

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

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

func (*ListGeoRegionsURL) SetBasePath 

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

func (o *ListGeoRegionsURL) String() string

String returns the string representation of the path with query string

func (*ListGeoRegionsURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*ListGeoRegionsURL) WithBasePath 

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

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 ListGeoRegionsUnauthorized 

type ListGeoRegionsUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

ListGeoRegionsUnauthorized The currently supplied session does not have the correct access rights to request this resource

swagger:response listGeoRegionsUnauthorized

func NewListGeoRegionsUnauthorized 

func NewListGeoRegionsUnauthorized() *ListGeoRegionsUnauthorized

NewListGeoRegionsUnauthorized creates ListGeoRegionsUnauthorized with default headers values

func (*ListGeoRegionsUnauthorized) SetPayload 

func (o *ListGeoRegionsUnauthorized) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the list geo regions unauthorized response

func (*ListGeoRegionsUnauthorized) WithPayload 

func (o *ListGeoRegionsUnauthorized) WithPayload(payload *rest_model.APIErrorEnvelope) *ListGeoRegionsUnauthorized

WithPayload adds the payload to the list geo regions unauthorized response

func (*ListGeoRegionsUnauthorized) WriteResponse 

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

WriteResponse to the client

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.