Documentation
¶
Overview ¶
Package engineclient provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- func NewEvaluateRequestRequest(server string, body EvaluateRequestJSONRequestBody) (*http.Request, error)
- func NewEvaluateRequestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- type Client
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) EvaluateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*EvaluateRequestResponse, error)
- func (c *ClientWithResponses) EvaluateRequestWithResponse(ctx context.Context, body EvaluateRequestJSONRequestBody, ...) (*EvaluateRequestResponse, error)
- type ClientWithResponsesInterface
- type EvaluateRequestResponse
- type HttpRequestDoer
- type RequestEditorFn
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) EvaluateRequest ¶
type ClientInterface ¶
type ClientInterface interface {
// EvaluateRequestWithBody request with any body
EvaluateRequestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
EvaluateRequest(ctx context.Context, body EvaluateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) EvaluateRequestWithBodyWithResponse ¶
func (c *ClientWithResponses) EvaluateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EvaluateRequestResponse, error)
EvaluateRequestWithBodyWithResponse request with arbitrary body returning *EvaluateRequestResponse
func (*ClientWithResponses) EvaluateRequestWithResponse ¶
func (c *ClientWithResponses) EvaluateRequestWithResponse(ctx context.Context, body EvaluateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*EvaluateRequestResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// EvaluateRequestWithBodyWithResponse request with any body
EvaluateRequestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EvaluateRequestResponse, error)
EvaluateRequestWithResponse(ctx context.Context, body EvaluateRequestJSONRequestBody, reqEditors ...RequestEditorFn) (*EvaluateRequestResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type EvaluateRequestResponse ¶
type EvaluateRequestResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *EvaluateResponse
JSON400 *BadRequest
JSON401 *Unauthorized
JSON403 *Forbidden
JSON406 *Rejected
JSON409 *PolicyConflict
JSON500 *InternalServerError
}
func ParseEvaluateRequestResponse ¶
func ParseEvaluateRequestResponse(rsp *http.Response) (*EvaluateRequestResponse, error)
ParseEvaluateRequestResponse parses an HTTP response from a EvaluateRequestWithResponse call
func (EvaluateRequestResponse) Status ¶
func (r EvaluateRequestResponse) Status() string
Status returns HTTPResponse.Status
func (EvaluateRequestResponse) StatusCode ¶
func (r EvaluateRequestResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.