api

package
v0.35.0-alpha.1 Latest Latest
Warning

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

Go to latest
Published: Jan 13, 2020 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 New

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

New creates a new api API client.

func (*Client) Decisions

func (a *Client) Decisions(params *DecisionsParams) (*DecisionsOK, error)

Decisions accesses control decision API

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

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) (*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) (*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) (*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 DecisionsForbidden

type DecisionsForbidden struct {
	Payload *DecisionsForbiddenBody
}

DecisionsForbidden handles this case with default header values.

The standard error format

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() *DecisionsForbiddenBody

type DecisionsForbiddenBody

type DecisionsForbiddenBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

DecisionsForbiddenBody decisions forbidden body swagger:model DecisionsForbiddenBody

func (*DecisionsForbiddenBody) MarshalBinary

func (o *DecisionsForbiddenBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DecisionsForbiddenBody) UnmarshalBinary

func (o *DecisionsForbiddenBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DecisionsForbiddenBody) Validate

func (o *DecisionsForbiddenBody) Validate(formats strfmt.Registry) error

Validate validates this decisions forbidden body

type DecisionsInternalServerError

type DecisionsInternalServerError struct {
	Payload *DecisionsInternalServerErrorBody
}

DecisionsInternalServerError handles this case with default header values.

The standard error format

func NewDecisionsInternalServerError

func NewDecisionsInternalServerError() *DecisionsInternalServerError

NewDecisionsInternalServerError creates a DecisionsInternalServerError with default headers values

func (*DecisionsInternalServerError) Error

func (*DecisionsInternalServerError) GetPayload

type DecisionsInternalServerErrorBody

type DecisionsInternalServerErrorBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

DecisionsInternalServerErrorBody decisions internal server error body swagger:model DecisionsInternalServerErrorBody

func (*DecisionsInternalServerErrorBody) MarshalBinary

func (o *DecisionsInternalServerErrorBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DecisionsInternalServerErrorBody) UnmarshalBinary

func (o *DecisionsInternalServerErrorBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DecisionsInternalServerErrorBody) Validate

Validate validates this decisions internal server error body

type DecisionsNotFound

type DecisionsNotFound struct {
	Payload *DecisionsNotFoundBody
}

DecisionsNotFound handles this case with default header values.

The standard error format

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() *DecisionsNotFoundBody

type DecisionsNotFoundBody

type DecisionsNotFoundBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

DecisionsNotFoundBody decisions not found body swagger:model DecisionsNotFoundBody

func (*DecisionsNotFoundBody) MarshalBinary

func (o *DecisionsNotFoundBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DecisionsNotFoundBody) UnmarshalBinary

func (o *DecisionsNotFoundBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DecisionsNotFoundBody) Validate

func (o *DecisionsNotFoundBody) Validate(formats strfmt.Registry) error

Validate validates this decisions not found body

type DecisionsOK

type DecisionsOK struct {
}

DecisionsOK handles this case 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

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 values initialized.

func NewDecisionsParamsWithContext

func NewDecisionsParamsWithContext(ctx context.Context) *DecisionsParams

NewDecisionsParamsWithContext creates a new DecisionsParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) 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 *DecisionsUnauthorizedBody
}

DecisionsUnauthorized handles this case with default header values.

The standard error format

func NewDecisionsUnauthorized

func NewDecisionsUnauthorized() *DecisionsUnauthorized

NewDecisionsUnauthorized creates a DecisionsUnauthorized with default headers values

func (*DecisionsUnauthorized) Error

func (o *DecisionsUnauthorized) Error() string

func (*DecisionsUnauthorized) GetPayload

type DecisionsUnauthorizedBody

type DecisionsUnauthorizedBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

DecisionsUnauthorizedBody decisions unauthorized body swagger:model DecisionsUnauthorizedBody

func (*DecisionsUnauthorizedBody) MarshalBinary

func (o *DecisionsUnauthorizedBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DecisionsUnauthorizedBody) UnmarshalBinary

func (o *DecisionsUnauthorizedBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DecisionsUnauthorizedBody) Validate

func (o *DecisionsUnauthorizedBody) Validate(formats strfmt.Registry) error

Validate validates this decisions unauthorized body

type GetRuleInternalServerError

type GetRuleInternalServerError struct {
	Payload *GetRuleInternalServerErrorBody
}

GetRuleInternalServerError handles this case with default header values.

The standard error format

func NewGetRuleInternalServerError

func NewGetRuleInternalServerError() *GetRuleInternalServerError

NewGetRuleInternalServerError creates a GetRuleInternalServerError with default headers values

func (*GetRuleInternalServerError) Error

func (*GetRuleInternalServerError) GetPayload

type GetRuleInternalServerErrorBody

type GetRuleInternalServerErrorBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

GetRuleInternalServerErrorBody get rule internal server error body swagger:model GetRuleInternalServerErrorBody

func (*GetRuleInternalServerErrorBody) MarshalBinary

func (o *GetRuleInternalServerErrorBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetRuleInternalServerErrorBody) UnmarshalBinary

func (o *GetRuleInternalServerErrorBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetRuleInternalServerErrorBody) Validate

func (o *GetRuleInternalServerErrorBody) Validate(formats strfmt.Registry) error

Validate validates this get rule internal server error body

type GetRuleNotFound

type GetRuleNotFound struct {
	Payload *GetRuleNotFoundBody
}

GetRuleNotFound handles this case with default header values.

The standard error format

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() *GetRuleNotFoundBody

type GetRuleNotFoundBody

type GetRuleNotFoundBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

GetRuleNotFoundBody get rule not found body swagger:model GetRuleNotFoundBody

func (*GetRuleNotFoundBody) MarshalBinary

func (o *GetRuleNotFoundBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetRuleNotFoundBody) UnmarshalBinary

func (o *GetRuleNotFoundBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetRuleNotFoundBody) Validate

func (o *GetRuleNotFoundBody) Validate(formats strfmt.Registry) error

Validate validates this get rule not found body

type GetRuleOK

type GetRuleOK struct {
	Payload *models.Rule
}

GetRuleOK handles this case 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

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 values initialized.

func NewGetRuleParamsWithContext

func NewGetRuleParamsWithContext(ctx context.Context) *GetRuleParams

NewGetRuleParamsWithContext creates a new GetRuleParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) 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 *GetWellKnownJSONWebKeysInternalServerErrorBody
}

GetWellKnownJSONWebKeysInternalServerError handles this case with default header values.

The standard error format

func NewGetWellKnownJSONWebKeysInternalServerError

func NewGetWellKnownJSONWebKeysInternalServerError() *GetWellKnownJSONWebKeysInternalServerError

NewGetWellKnownJSONWebKeysInternalServerError creates a GetWellKnownJSONWebKeysInternalServerError with default headers values

func (*GetWellKnownJSONWebKeysInternalServerError) Error

func (*GetWellKnownJSONWebKeysInternalServerError) GetPayload

type GetWellKnownJSONWebKeysInternalServerErrorBody

type GetWellKnownJSONWebKeysInternalServerErrorBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

GetWellKnownJSONWebKeysInternalServerErrorBody get well known JSON web keys internal server error body swagger:model GetWellKnownJSONWebKeysInternalServerErrorBody

func (*GetWellKnownJSONWebKeysInternalServerErrorBody) MarshalBinary

MarshalBinary interface implementation

func (*GetWellKnownJSONWebKeysInternalServerErrorBody) UnmarshalBinary

UnmarshalBinary interface implementation

func (*GetWellKnownJSONWebKeysInternalServerErrorBody) Validate

Validate validates this get well known JSON web keys internal server error body

type GetWellKnownJSONWebKeysOK

type GetWellKnownJSONWebKeysOK struct {
	Payload *models.JSONWebKeySet
}

GetWellKnownJSONWebKeysOK handles this case 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

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 values initialized.

func NewGetWellKnownJSONWebKeysParamsWithContext

func NewGetWellKnownJSONWebKeysParamsWithContext(ctx context.Context) *GetWellKnownJSONWebKeysParams

NewGetWellKnownJSONWebKeysParamsWithContext creates a new GetWellKnownJSONWebKeysParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) 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 *ListRulesInternalServerErrorBody
}

ListRulesInternalServerError handles this case with default header values.

The standard error format

func NewListRulesInternalServerError

func NewListRulesInternalServerError() *ListRulesInternalServerError

NewListRulesInternalServerError creates a ListRulesInternalServerError with default headers values

func (*ListRulesInternalServerError) Error

func (*ListRulesInternalServerError) GetPayload

type ListRulesInternalServerErrorBody

type ListRulesInternalServerErrorBody struct {

	// code
	Code int64 `json:"code,omitempty"`

	// details
	Details []map[string]interface{} `json:"details"`

	// message
	Message string `json:"message,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`

	// request
	Request string `json:"request,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

ListRulesInternalServerErrorBody list rules internal server error body swagger:model ListRulesInternalServerErrorBody

func (*ListRulesInternalServerErrorBody) MarshalBinary

func (o *ListRulesInternalServerErrorBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListRulesInternalServerErrorBody) UnmarshalBinary

func (o *ListRulesInternalServerErrorBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListRulesInternalServerErrorBody) Validate

Validate validates this list rules internal server error body

type ListRulesOK

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

ListRulesOK handles this case 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

type ListRulesParams

type ListRulesParams struct {

	/*Limit
	  The maximum amount of rules returned.

	*/
	Limit *int64
	/*Offset
	  The offset from where to start looking.

	*/
	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 values initialized.

func NewListRulesParamsWithContext

func NewListRulesParamsWithContext(ctx context.Context) *ListRulesParams

NewListRulesParamsWithContext creates a new ListRulesParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) 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