api

package
v0.40.7 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client for api API

func (*Client) Decisions

func (a *Client) Decisions(params *DecisionsParams, opts ...ClientOption) (*DecisionsOK, error)
Decisions accesses control decision API

> This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decisions.

This endpoint mirrors the proxy capability of ORY Oathkeeper's proxy functionality but instead of forwarding the request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden) status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.

func (*Client) GetRule

func (a *Client) GetRule(params *GetRuleParams, opts ...ClientOption) (*GetRuleOK, error)

GetRule retrieves a rule

Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.

func (*Client) GetWellKnownJSONWebKeys

func (a *Client) GetWellKnownJSONWebKeys(params *GetWellKnownJSONWebKeysParams, opts ...ClientOption) (*GetWellKnownJSONWebKeysOK, error)

GetWellKnownJSONWebKeys lists cryptographic keys

This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.

func (*Client) ListRules

func (a *Client) ListRules(params *ListRulesParams, opts ...ClientOption) (*ListRulesOK, error)
ListRules lists all rules

This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full

view of what rules you have currently in place.

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption added in v0.40.0

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	Decisions(params *DecisionsParams, opts ...ClientOption) (*DecisionsOK, error)

	GetRule(params *GetRuleParams, opts ...ClientOption) (*GetRuleOK, error)

	GetWellKnownJSONWebKeys(params *GetWellKnownJSONWebKeysParams, opts ...ClientOption) (*GetWellKnownJSONWebKeysOK, error)

	ListRules(params *ListRulesParams, opts ...ClientOption) (*ListRulesOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new api API client.

type DecisionsForbidden

type DecisionsForbidden struct {
	Payload *models.GenericError
}

DecisionsForbidden describes a response with status code 403, with default header values.

genericError

func NewDecisionsForbidden

func NewDecisionsForbidden() *DecisionsForbidden

NewDecisionsForbidden creates a DecisionsForbidden with default headers values

func (*DecisionsForbidden) Error

func (o *DecisionsForbidden) Error() string

func (*DecisionsForbidden) GetPayload

func (o *DecisionsForbidden) GetPayload() *models.GenericError

func (*DecisionsForbidden) IsClientError added in v0.40.0

func (o *DecisionsForbidden) IsClientError() bool

IsClientError returns true when this decisions forbidden response has a 4xx status code

func (*DecisionsForbidden) IsCode added in v0.40.0

func (o *DecisionsForbidden) IsCode(code int) bool

IsCode returns true when this decisions forbidden response a status code equal to that given

func (*DecisionsForbidden) IsRedirect added in v0.40.0

func (o *DecisionsForbidden) IsRedirect() bool

IsRedirect returns true when this decisions forbidden response has a 3xx status code

func (*DecisionsForbidden) IsServerError added in v0.40.0

func (o *DecisionsForbidden) IsServerError() bool

IsServerError returns true when this decisions forbidden response has a 5xx status code

func (*DecisionsForbidden) IsSuccess added in v0.40.0

func (o *DecisionsForbidden) IsSuccess() bool

IsSuccess returns true when this decisions forbidden response has a 2xx status code

func (*DecisionsForbidden) String added in v0.40.0

func (o *DecisionsForbidden) String() string

type DecisionsInternalServerError

type DecisionsInternalServerError struct {
	Payload *models.GenericError
}

DecisionsInternalServerError describes a response with status code 500, with default header values.

genericError

func NewDecisionsInternalServerError

func NewDecisionsInternalServerError() *DecisionsInternalServerError

NewDecisionsInternalServerError creates a DecisionsInternalServerError with default headers values

func (*DecisionsInternalServerError) Error

func (*DecisionsInternalServerError) GetPayload

func (*DecisionsInternalServerError) IsClientError added in v0.40.0

func (o *DecisionsInternalServerError) IsClientError() bool

IsClientError returns true when this decisions internal server error response has a 4xx status code

func (*DecisionsInternalServerError) IsCode added in v0.40.0

func (o *DecisionsInternalServerError) IsCode(code int) bool

IsCode returns true when this decisions internal server error response a status code equal to that given

func (*DecisionsInternalServerError) IsRedirect added in v0.40.0

func (o *DecisionsInternalServerError) IsRedirect() bool

IsRedirect returns true when this decisions internal server error response has a 3xx status code

func (*DecisionsInternalServerError) IsServerError added in v0.40.0

func (o *DecisionsInternalServerError) IsServerError() bool

IsServerError returns true when this decisions internal server error response has a 5xx status code

func (*DecisionsInternalServerError) IsSuccess added in v0.40.0

func (o *DecisionsInternalServerError) IsSuccess() bool

IsSuccess returns true when this decisions internal server error response has a 2xx status code

func (*DecisionsInternalServerError) String added in v0.40.0

type DecisionsNotFound

type DecisionsNotFound struct {
	Payload *models.GenericError
}

DecisionsNotFound describes a response with status code 404, with default header values.

genericError

func NewDecisionsNotFound

func NewDecisionsNotFound() *DecisionsNotFound

NewDecisionsNotFound creates a DecisionsNotFound with default headers values

func (*DecisionsNotFound) Error

func (o *DecisionsNotFound) Error() string

func (*DecisionsNotFound) GetPayload

func (o *DecisionsNotFound) GetPayload() *models.GenericError

func (*DecisionsNotFound) IsClientError added in v0.40.0

func (o *DecisionsNotFound) IsClientError() bool

IsClientError returns true when this decisions not found response has a 4xx status code

func (*DecisionsNotFound) IsCode added in v0.40.0

func (o *DecisionsNotFound) IsCode(code int) bool

IsCode returns true when this decisions not found response a status code equal to that given

func (*DecisionsNotFound) IsRedirect added in v0.40.0

func (o *DecisionsNotFound) IsRedirect() bool

IsRedirect returns true when this decisions not found response has a 3xx status code

func (*DecisionsNotFound) IsServerError added in v0.40.0

func (o *DecisionsNotFound) IsServerError() bool

IsServerError returns true when this decisions not found response has a 5xx status code

func (*DecisionsNotFound) IsSuccess added in v0.40.0

func (o *DecisionsNotFound) IsSuccess() bool

IsSuccess returns true when this decisions not found response has a 2xx status code

func (*DecisionsNotFound) String added in v0.40.0

func (o *DecisionsNotFound) String() string

type DecisionsOK

type DecisionsOK struct {
}

DecisionsOK describes a response with status code 200, with default header values.

An empty response

func NewDecisionsOK

func NewDecisionsOK() *DecisionsOK

NewDecisionsOK creates a DecisionsOK with default headers values

func (*DecisionsOK) Error

func (o *DecisionsOK) Error() string

func (*DecisionsOK) IsClientError added in v0.40.0

func (o *DecisionsOK) IsClientError() bool

IsClientError returns true when this decisions o k response has a 4xx status code

func (*DecisionsOK) IsCode added in v0.40.0

func (o *DecisionsOK) IsCode(code int) bool

IsCode returns true when this decisions o k response a status code equal to that given

func (*DecisionsOK) IsRedirect added in v0.40.0

func (o *DecisionsOK) IsRedirect() bool

IsRedirect returns true when this decisions o k response has a 3xx status code

func (*DecisionsOK) IsServerError added in v0.40.0

func (o *DecisionsOK) IsServerError() bool

IsServerError returns true when this decisions o k response has a 5xx status code

func (*DecisionsOK) IsSuccess added in v0.40.0

func (o *DecisionsOK) IsSuccess() bool

IsSuccess returns true when this decisions o k response has a 2xx status code

func (*DecisionsOK) String added in v0.40.0

func (o *DecisionsOK) String() string

type DecisionsParams

type DecisionsParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

DecisionsParams contains all the parameters to send to the API endpoint

for the decisions operation.

Typically these are written to a http.Request.

func NewDecisionsParams

func NewDecisionsParams() *DecisionsParams

NewDecisionsParams creates a new DecisionsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewDecisionsParamsWithContext

func NewDecisionsParamsWithContext(ctx context.Context) *DecisionsParams

NewDecisionsParamsWithContext creates a new DecisionsParams object with the ability to set a context for a request.

func NewDecisionsParamsWithHTTPClient

func NewDecisionsParamsWithHTTPClient(client *http.Client) *DecisionsParams

NewDecisionsParamsWithHTTPClient creates a new DecisionsParams object with the ability to set a custom HTTPClient for a request.

func NewDecisionsParamsWithTimeout

func NewDecisionsParamsWithTimeout(timeout time.Duration) *DecisionsParams

NewDecisionsParamsWithTimeout creates a new DecisionsParams object with the ability to set a timeout on a request.

func (*DecisionsParams) SetContext

func (o *DecisionsParams) SetContext(ctx context.Context)

SetContext adds the context to the decisions params

func (*DecisionsParams) SetDefaults added in v0.40.0

func (o *DecisionsParams) SetDefaults()

SetDefaults hydrates default values in the decisions params (not the query body).

All values with no default are reset to their zero value.

func (*DecisionsParams) SetHTTPClient

func (o *DecisionsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the decisions params

func (*DecisionsParams) SetTimeout

func (o *DecisionsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the decisions params

func (*DecisionsParams) WithContext

func (o *DecisionsParams) WithContext(ctx context.Context) *DecisionsParams

WithContext adds the context to the decisions params

func (*DecisionsParams) WithDefaults added in v0.40.0

func (o *DecisionsParams) WithDefaults() *DecisionsParams

WithDefaults hydrates default values in the decisions params (not the query body).

All values with no default are reset to their zero value.

func (*DecisionsParams) WithHTTPClient

func (o *DecisionsParams) WithHTTPClient(client *http.Client) *DecisionsParams

WithHTTPClient adds the HTTPClient to the decisions params

func (*DecisionsParams) WithTimeout

func (o *DecisionsParams) WithTimeout(timeout time.Duration) *DecisionsParams

WithTimeout adds the timeout to the decisions params

func (*DecisionsParams) WriteToRequest

func (o *DecisionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type DecisionsReader

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

DecisionsReader is a Reader for the Decisions structure.

func (*DecisionsReader) ReadResponse

func (o *DecisionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type DecisionsUnauthorized

type DecisionsUnauthorized struct {
	Payload *models.GenericError
}

DecisionsUnauthorized describes a response with status code 401, with default header values.

genericError

func NewDecisionsUnauthorized

func NewDecisionsUnauthorized() *DecisionsUnauthorized

NewDecisionsUnauthorized creates a DecisionsUnauthorized with default headers values

func (*DecisionsUnauthorized) Error

func (o *DecisionsUnauthorized) Error() string

func (*DecisionsUnauthorized) GetPayload

func (o *DecisionsUnauthorized) GetPayload() *models.GenericError

func (*DecisionsUnauthorized) IsClientError added in v0.40.0

func (o *DecisionsUnauthorized) IsClientError() bool

IsClientError returns true when this decisions unauthorized response has a 4xx status code

func (*DecisionsUnauthorized) IsCode added in v0.40.0

func (o *DecisionsUnauthorized) IsCode(code int) bool

IsCode returns true when this decisions unauthorized response a status code equal to that given

func (*DecisionsUnauthorized) IsRedirect added in v0.40.0

func (o *DecisionsUnauthorized) IsRedirect() bool

IsRedirect returns true when this decisions unauthorized response has a 3xx status code

func (*DecisionsUnauthorized) IsServerError added in v0.40.0

func (o *DecisionsUnauthorized) IsServerError() bool

IsServerError returns true when this decisions unauthorized response has a 5xx status code

func (*DecisionsUnauthorized) IsSuccess added in v0.40.0

func (o *DecisionsUnauthorized) IsSuccess() bool

IsSuccess returns true when this decisions unauthorized response has a 2xx status code

func (*DecisionsUnauthorized) String added in v0.40.0

func (o *DecisionsUnauthorized) String() string

type GetRuleInternalServerError

type GetRuleInternalServerError struct {
	Payload *models.GenericError
}

GetRuleInternalServerError describes a response with status code 500, with default header values.

genericError

func NewGetRuleInternalServerError

func NewGetRuleInternalServerError() *GetRuleInternalServerError

NewGetRuleInternalServerError creates a GetRuleInternalServerError with default headers values

func (*GetRuleInternalServerError) Error

func (*GetRuleInternalServerError) GetPayload

func (*GetRuleInternalServerError) IsClientError added in v0.40.0

func (o *GetRuleInternalServerError) IsClientError() bool

IsClientError returns true when this get rule internal server error response has a 4xx status code

func (*GetRuleInternalServerError) IsCode added in v0.40.0

func (o *GetRuleInternalServerError) IsCode(code int) bool

IsCode returns true when this get rule internal server error response a status code equal to that given

func (*GetRuleInternalServerError) IsRedirect added in v0.40.0

func (o *GetRuleInternalServerError) IsRedirect() bool

IsRedirect returns true when this get rule internal server error response has a 3xx status code

func (*GetRuleInternalServerError) IsServerError added in v0.40.0

func (o *GetRuleInternalServerError) IsServerError() bool

IsServerError returns true when this get rule internal server error response has a 5xx status code

func (*GetRuleInternalServerError) IsSuccess added in v0.40.0

func (o *GetRuleInternalServerError) IsSuccess() bool

IsSuccess returns true when this get rule internal server error response has a 2xx status code

func (*GetRuleInternalServerError) String added in v0.40.0

func (o *GetRuleInternalServerError) String() string

type GetRuleNotFound

type GetRuleNotFound struct {
	Payload *models.GenericError
}

GetRuleNotFound describes a response with status code 404, with default header values.

genericError

func NewGetRuleNotFound

func NewGetRuleNotFound() *GetRuleNotFound

NewGetRuleNotFound creates a GetRuleNotFound with default headers values

func (*GetRuleNotFound) Error

func (o *GetRuleNotFound) Error() string

func (*GetRuleNotFound) GetPayload

func (o *GetRuleNotFound) GetPayload() *models.GenericError

func (*GetRuleNotFound) IsClientError added in v0.40.0

func (o *GetRuleNotFound) IsClientError() bool

IsClientError returns true when this get rule not found response has a 4xx status code

func (*GetRuleNotFound) IsCode added in v0.40.0

func (o *GetRuleNotFound) IsCode(code int) bool

IsCode returns true when this get rule not found response a status code equal to that given

func (*GetRuleNotFound) IsRedirect added in v0.40.0

func (o *GetRuleNotFound) IsRedirect() bool

IsRedirect returns true when this get rule not found response has a 3xx status code

func (*GetRuleNotFound) IsServerError added in v0.40.0

func (o *GetRuleNotFound) IsServerError() bool

IsServerError returns true when this get rule not found response has a 5xx status code

func (*GetRuleNotFound) IsSuccess added in v0.40.0

func (o *GetRuleNotFound) IsSuccess() bool

IsSuccess returns true when this get rule not found response has a 2xx status code

func (*GetRuleNotFound) String added in v0.40.0

func (o *GetRuleNotFound) String() string

type GetRuleOK

type GetRuleOK struct {
	Payload *models.Rule
}

GetRuleOK describes a response with status code 200, with default header values.

A rule

func NewGetRuleOK

func NewGetRuleOK() *GetRuleOK

NewGetRuleOK creates a GetRuleOK with default headers values

func (*GetRuleOK) Error

func (o *GetRuleOK) Error() string

func (*GetRuleOK) GetPayload

func (o *GetRuleOK) GetPayload() *models.Rule

func (*GetRuleOK) IsClientError added in v0.40.0

func (o *GetRuleOK) IsClientError() bool

IsClientError returns true when this get rule o k response has a 4xx status code

func (*GetRuleOK) IsCode added in v0.40.0

func (o *GetRuleOK) IsCode(code int) bool

IsCode returns true when this get rule o k response a status code equal to that given

func (*GetRuleOK) IsRedirect added in v0.40.0

func (o *GetRuleOK) IsRedirect() bool

IsRedirect returns true when this get rule o k response has a 3xx status code

func (*GetRuleOK) IsServerError added in v0.40.0

func (o *GetRuleOK) IsServerError() bool

IsServerError returns true when this get rule o k response has a 5xx status code

func (*GetRuleOK) IsSuccess added in v0.40.0

func (o *GetRuleOK) IsSuccess() bool

IsSuccess returns true when this get rule o k response has a 2xx status code

func (*GetRuleOK) String added in v0.40.0

func (o *GetRuleOK) String() string

type GetRuleParams

type GetRuleParams struct {

	// ID.
	ID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetRuleParams contains all the parameters to send to the API endpoint

for the get rule operation.

Typically these are written to a http.Request.

func NewGetRuleParams

func NewGetRuleParams() *GetRuleParams

NewGetRuleParams creates a new GetRuleParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetRuleParamsWithContext

func NewGetRuleParamsWithContext(ctx context.Context) *GetRuleParams

NewGetRuleParamsWithContext creates a new GetRuleParams object with the ability to set a context for a request.

func NewGetRuleParamsWithHTTPClient

func NewGetRuleParamsWithHTTPClient(client *http.Client) *GetRuleParams

NewGetRuleParamsWithHTTPClient creates a new GetRuleParams object with the ability to set a custom HTTPClient for a request.

func NewGetRuleParamsWithTimeout

func NewGetRuleParamsWithTimeout(timeout time.Duration) *GetRuleParams

NewGetRuleParamsWithTimeout creates a new GetRuleParams object with the ability to set a timeout on a request.

func (*GetRuleParams) SetContext

func (o *GetRuleParams) SetContext(ctx context.Context)

SetContext adds the context to the get rule params

func (*GetRuleParams) SetDefaults added in v0.40.0

func (o *GetRuleParams) SetDefaults()

SetDefaults hydrates default values in the get rule params (not the query body).

All values with no default are reset to their zero value.

func (*GetRuleParams) SetHTTPClient

func (o *GetRuleParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get rule params

func (*GetRuleParams) SetID

func (o *GetRuleParams) SetID(id string)

SetID adds the id to the get rule params

func (*GetRuleParams) SetTimeout

func (o *GetRuleParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get rule params

func (*GetRuleParams) WithContext

func (o *GetRuleParams) WithContext(ctx context.Context) *GetRuleParams

WithContext adds the context to the get rule params

func (*GetRuleParams) WithDefaults added in v0.40.0

func (o *GetRuleParams) WithDefaults() *GetRuleParams

WithDefaults hydrates default values in the get rule params (not the query body).

All values with no default are reset to their zero value.

func (*GetRuleParams) WithHTTPClient

func (o *GetRuleParams) WithHTTPClient(client *http.Client) *GetRuleParams

WithHTTPClient adds the HTTPClient to the get rule params

func (*GetRuleParams) WithID

func (o *GetRuleParams) WithID(id string) *GetRuleParams

WithID adds the id to the get rule params

func (*GetRuleParams) WithTimeout

func (o *GetRuleParams) WithTimeout(timeout time.Duration) *GetRuleParams

WithTimeout adds the timeout to the get rule params

func (*GetRuleParams) WriteToRequest

func (o *GetRuleParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetRuleReader

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

GetRuleReader is a Reader for the GetRule structure.

func (*GetRuleReader) ReadResponse

func (o *GetRuleReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetWellKnownJSONWebKeysInternalServerError

type GetWellKnownJSONWebKeysInternalServerError struct {
	Payload *models.GenericError
}

GetWellKnownJSONWebKeysInternalServerError describes a response with status code 500, with default header values.

genericError

func NewGetWellKnownJSONWebKeysInternalServerError

func NewGetWellKnownJSONWebKeysInternalServerError() *GetWellKnownJSONWebKeysInternalServerError

NewGetWellKnownJSONWebKeysInternalServerError creates a GetWellKnownJSONWebKeysInternalServerError with default headers values

func (*GetWellKnownJSONWebKeysInternalServerError) Error

func (*GetWellKnownJSONWebKeysInternalServerError) GetPayload

func (*GetWellKnownJSONWebKeysInternalServerError) IsClientError added in v0.40.0

IsClientError returns true when this get well known Json web keys internal server error response has a 4xx status code

func (*GetWellKnownJSONWebKeysInternalServerError) IsCode added in v0.40.0

IsCode returns true when this get well known Json web keys internal server error response a status code equal to that given

func (*GetWellKnownJSONWebKeysInternalServerError) IsRedirect added in v0.40.0

IsRedirect returns true when this get well known Json web keys internal server error response has a 3xx status code

func (*GetWellKnownJSONWebKeysInternalServerError) IsServerError added in v0.40.0

IsServerError returns true when this get well known Json web keys internal server error response has a 5xx status code

func (*GetWellKnownJSONWebKeysInternalServerError) IsSuccess added in v0.40.0

IsSuccess returns true when this get well known Json web keys internal server error response has a 2xx status code

func (*GetWellKnownJSONWebKeysInternalServerError) String added in v0.40.0

type GetWellKnownJSONWebKeysOK

type GetWellKnownJSONWebKeysOK struct {
	Payload *models.JSONWebKeySet
}

GetWellKnownJSONWebKeysOK describes a response with status code 200, with default header values.

jsonWebKeySet

func NewGetWellKnownJSONWebKeysOK

func NewGetWellKnownJSONWebKeysOK() *GetWellKnownJSONWebKeysOK

NewGetWellKnownJSONWebKeysOK creates a GetWellKnownJSONWebKeysOK with default headers values

func (*GetWellKnownJSONWebKeysOK) Error

func (o *GetWellKnownJSONWebKeysOK) Error() string

func (*GetWellKnownJSONWebKeysOK) GetPayload

func (*GetWellKnownJSONWebKeysOK) IsClientError added in v0.40.0

func (o *GetWellKnownJSONWebKeysOK) IsClientError() bool

IsClientError returns true when this get well known Json web keys o k response has a 4xx status code

func (*GetWellKnownJSONWebKeysOK) IsCode added in v0.40.0

func (o *GetWellKnownJSONWebKeysOK) IsCode(code int) bool

IsCode returns true when this get well known Json web keys o k response a status code equal to that given

func (*GetWellKnownJSONWebKeysOK) IsRedirect added in v0.40.0

func (o *GetWellKnownJSONWebKeysOK) IsRedirect() bool

IsRedirect returns true when this get well known Json web keys o k response has a 3xx status code

func (*GetWellKnownJSONWebKeysOK) IsServerError added in v0.40.0

func (o *GetWellKnownJSONWebKeysOK) IsServerError() bool

IsServerError returns true when this get well known Json web keys o k response has a 5xx status code

func (*GetWellKnownJSONWebKeysOK) IsSuccess added in v0.40.0

func (o *GetWellKnownJSONWebKeysOK) IsSuccess() bool

IsSuccess returns true when this get well known Json web keys o k response has a 2xx status code

func (*GetWellKnownJSONWebKeysOK) String added in v0.40.0

func (o *GetWellKnownJSONWebKeysOK) String() string

type GetWellKnownJSONWebKeysParams

type GetWellKnownJSONWebKeysParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetWellKnownJSONWebKeysParams contains all the parameters to send to the API endpoint

for the get well known JSON web keys operation.

Typically these are written to a http.Request.

func NewGetWellKnownJSONWebKeysParams

func NewGetWellKnownJSONWebKeysParams() *GetWellKnownJSONWebKeysParams

NewGetWellKnownJSONWebKeysParams creates a new GetWellKnownJSONWebKeysParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetWellKnownJSONWebKeysParamsWithContext

func NewGetWellKnownJSONWebKeysParamsWithContext(ctx context.Context) *GetWellKnownJSONWebKeysParams

NewGetWellKnownJSONWebKeysParamsWithContext creates a new GetWellKnownJSONWebKeysParams object with the ability to set a context for a request.

func NewGetWellKnownJSONWebKeysParamsWithHTTPClient

func NewGetWellKnownJSONWebKeysParamsWithHTTPClient(client *http.Client) *GetWellKnownJSONWebKeysParams

NewGetWellKnownJSONWebKeysParamsWithHTTPClient creates a new GetWellKnownJSONWebKeysParams object with the ability to set a custom HTTPClient for a request.

func NewGetWellKnownJSONWebKeysParamsWithTimeout

func NewGetWellKnownJSONWebKeysParamsWithTimeout(timeout time.Duration) *GetWellKnownJSONWebKeysParams

NewGetWellKnownJSONWebKeysParamsWithTimeout creates a new GetWellKnownJSONWebKeysParams object with the ability to set a timeout on a request.

func (*GetWellKnownJSONWebKeysParams) SetContext

func (o *GetWellKnownJSONWebKeysParams) SetContext(ctx context.Context)

SetContext adds the context to the get well known JSON web keys params

func (*GetWellKnownJSONWebKeysParams) SetDefaults added in v0.40.0

func (o *GetWellKnownJSONWebKeysParams) SetDefaults()

SetDefaults hydrates default values in the get well known JSON web keys params (not the query body).

All values with no default are reset to their zero value.

func (*GetWellKnownJSONWebKeysParams) SetHTTPClient

func (o *GetWellKnownJSONWebKeysParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get well known JSON web keys params

func (*GetWellKnownJSONWebKeysParams) SetTimeout

func (o *GetWellKnownJSONWebKeysParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get well known JSON web keys params

func (*GetWellKnownJSONWebKeysParams) WithContext

WithContext adds the context to the get well known JSON web keys params

func (*GetWellKnownJSONWebKeysParams) WithDefaults added in v0.40.0

WithDefaults hydrates default values in the get well known JSON web keys params (not the query body).

All values with no default are reset to their zero value.

func (*GetWellKnownJSONWebKeysParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get well known JSON web keys params

func (*GetWellKnownJSONWebKeysParams) WithTimeout

WithTimeout adds the timeout to the get well known JSON web keys params

func (*GetWellKnownJSONWebKeysParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetWellKnownJSONWebKeysReader

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

GetWellKnownJSONWebKeysReader is a Reader for the GetWellKnownJSONWebKeys structure.

func (*GetWellKnownJSONWebKeysReader) ReadResponse

func (o *GetWellKnownJSONWebKeysReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListRulesInternalServerError

type ListRulesInternalServerError struct {
	Payload *models.GenericError
}

ListRulesInternalServerError describes a response with status code 500, with default header values.

genericError

func NewListRulesInternalServerError

func NewListRulesInternalServerError() *ListRulesInternalServerError

NewListRulesInternalServerError creates a ListRulesInternalServerError with default headers values

func (*ListRulesInternalServerError) Error

func (*ListRulesInternalServerError) GetPayload

func (*ListRulesInternalServerError) IsClientError added in v0.40.0

func (o *ListRulesInternalServerError) IsClientError() bool

IsClientError returns true when this list rules internal server error response has a 4xx status code

func (*ListRulesInternalServerError) IsCode added in v0.40.0

func (o *ListRulesInternalServerError) IsCode(code int) bool

IsCode returns true when this list rules internal server error response a status code equal to that given

func (*ListRulesInternalServerError) IsRedirect added in v0.40.0

func (o *ListRulesInternalServerError) IsRedirect() bool

IsRedirect returns true when this list rules internal server error response has a 3xx status code

func (*ListRulesInternalServerError) IsServerError added in v0.40.0

func (o *ListRulesInternalServerError) IsServerError() bool

IsServerError returns true when this list rules internal server error response has a 5xx status code

func (*ListRulesInternalServerError) IsSuccess added in v0.40.0

func (o *ListRulesInternalServerError) IsSuccess() bool

IsSuccess returns true when this list rules internal server error response has a 2xx status code

func (*ListRulesInternalServerError) String added in v0.40.0

type ListRulesOK

type ListRulesOK struct {
	Payload []*models.Rule
}

ListRulesOK describes a response with status code 200, with default header values.

A list of rules

func NewListRulesOK

func NewListRulesOK() *ListRulesOK

NewListRulesOK creates a ListRulesOK with default headers values

func (*ListRulesOK) Error

func (o *ListRulesOK) Error() string

func (*ListRulesOK) GetPayload

func (o *ListRulesOK) GetPayload() []*models.Rule

func (*ListRulesOK) IsClientError added in v0.40.0

func (o *ListRulesOK) IsClientError() bool

IsClientError returns true when this list rules o k response has a 4xx status code

func (*ListRulesOK) IsCode added in v0.40.0

func (o *ListRulesOK) IsCode(code int) bool

IsCode returns true when this list rules o k response a status code equal to that given

func (*ListRulesOK) IsRedirect added in v0.40.0

func (o *ListRulesOK) IsRedirect() bool

IsRedirect returns true when this list rules o k response has a 3xx status code

func (*ListRulesOK) IsServerError added in v0.40.0

func (o *ListRulesOK) IsServerError() bool

IsServerError returns true when this list rules o k response has a 5xx status code

func (*ListRulesOK) IsSuccess added in v0.40.0

func (o *ListRulesOK) IsSuccess() bool

IsSuccess returns true when this list rules o k response has a 2xx status code

func (*ListRulesOK) String added in v0.40.0

func (o *ListRulesOK) String() string

type ListRulesParams

type ListRulesParams struct {

	/* Limit.

	   The maximum amount of rules returned.

	   Format: int64
	*/
	Limit *int64

	/* Offset.

	   The offset from where to start looking.

	   Format: int64
	*/
	Offset *int64

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListRulesParams contains all the parameters to send to the API endpoint

for the list rules operation.

Typically these are written to a http.Request.

func NewListRulesParams

func NewListRulesParams() *ListRulesParams

NewListRulesParams creates a new ListRulesParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewListRulesParamsWithContext

func NewListRulesParamsWithContext(ctx context.Context) *ListRulesParams

NewListRulesParamsWithContext creates a new ListRulesParams object with the ability to set a context for a request.

func NewListRulesParamsWithHTTPClient

func NewListRulesParamsWithHTTPClient(client *http.Client) *ListRulesParams

NewListRulesParamsWithHTTPClient creates a new ListRulesParams object with the ability to set a custom HTTPClient for a request.

func NewListRulesParamsWithTimeout

func NewListRulesParamsWithTimeout(timeout time.Duration) *ListRulesParams

NewListRulesParamsWithTimeout creates a new ListRulesParams object with the ability to set a timeout on a request.

func (*ListRulesParams) SetContext

func (o *ListRulesParams) SetContext(ctx context.Context)

SetContext adds the context to the list rules params

func (*ListRulesParams) SetDefaults added in v0.40.0

func (o *ListRulesParams) SetDefaults()

SetDefaults hydrates default values in the list rules params (not the query body).

All values with no default are reset to their zero value.

func (*ListRulesParams) SetHTTPClient

func (o *ListRulesParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list rules params

func (*ListRulesParams) SetLimit

func (o *ListRulesParams) SetLimit(limit *int64)

SetLimit adds the limit to the list rules params

func (*ListRulesParams) SetOffset

func (o *ListRulesParams) SetOffset(offset *int64)

SetOffset adds the offset to the list rules params

func (*ListRulesParams) SetTimeout

func (o *ListRulesParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list rules params

func (*ListRulesParams) WithContext

func (o *ListRulesParams) WithContext(ctx context.Context) *ListRulesParams

WithContext adds the context to the list rules params

func (*ListRulesParams) WithDefaults added in v0.40.0

func (o *ListRulesParams) WithDefaults() *ListRulesParams

WithDefaults hydrates default values in the list rules params (not the query body).

All values with no default are reset to their zero value.

func (*ListRulesParams) WithHTTPClient

func (o *ListRulesParams) WithHTTPClient(client *http.Client) *ListRulesParams

WithHTTPClient adds the HTTPClient to the list rules params

func (*ListRulesParams) WithLimit

func (o *ListRulesParams) WithLimit(limit *int64) *ListRulesParams

WithLimit adds the limit to the list rules params

func (*ListRulesParams) WithOffset

func (o *ListRulesParams) WithOffset(offset *int64) *ListRulesParams

WithOffset adds the offset to the list rules params

func (*ListRulesParams) WithTimeout

func (o *ListRulesParams) WithTimeout(timeout time.Duration) *ListRulesParams

WithTimeout adds the timeout to the list rules params

func (*ListRulesParams) WriteToRequest

func (o *ListRulesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListRulesReader

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

ListRulesReader is a Reader for the ListRules structure.

func (*ListRulesReader) ReadResponse

func (o *ListRulesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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