api

package
v0.38.24-beta.1 Latest Latest
Warning

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

 Go to latest Published: Apr 6, 2022 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) (*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) GetVersion 

func (a *Client) GetVersion(params *GetVersionParams) (*GetVersionOK, error)
GetVersion gets service version

This endpoint returns the service version typically notated using semantic versioning.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

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) IsInstanceAlive 

func (a *Client) IsInstanceAlive(params *IsInstanceAliveParams) (*IsInstanceAliveOK, error)
IsInstanceAlive checks alive status

This endpoint returns a 200 status code when the HTTP server is up running.

This status does currently not include checks whether the database connection is working.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

func (*Client) IsInstanceReady 

func (a *Client) IsInstanceReady(params *IsInstanceReadyParams) (*IsInstanceReadyOK, error)
IsInstanceReady checks readiness status

This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.

the database) are responsive as well.

If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

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 ClientService 

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

	GetRule(params *GetRuleParams) (*GetRuleOK, error)

	GetVersion(params *GetVersionParams) (*GetVersionOK, error)

	GetWellKnownJSONWebKeys(params *GetWellKnownJSONWebKeysParams) (*GetWellKnownJSONWebKeysOK, error)

	IsInstanceAlive(params *IsInstanceAliveParams) (*IsInstanceAliveOK, error)

	IsInstanceReady(params *IsInstanceReadyParams) (*IsInstanceReadyOK, error)

	ListRules(params *ListRulesParams) (*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 handles this case 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

type DecisionsInternalServerError 

type DecisionsInternalServerError struct {
	Payload *models.GenericError
}

DecisionsInternalServerError handles this case with default header values.

genericError

func NewDecisionsInternalServerError 

func NewDecisionsInternalServerError() *DecisionsInternalServerError

NewDecisionsInternalServerError creates a DecisionsInternalServerError with default headers values

func (*DecisionsInternalServerError) Error 

func (o *DecisionsInternalServerError) Error() string

func (*DecisionsInternalServerError) GetPayload 

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

type DecisionsNotFound 

type DecisionsNotFound struct {
	Payload *models.GenericError
}

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

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 *models.GenericError
}

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

type GetRuleInternalServerError 

type GetRuleInternalServerError struct {
	Payload *models.GenericError
}

GetRuleInternalServerError handles this case with default header values.

genericError

func NewGetRuleInternalServerError 

func NewGetRuleInternalServerError() *GetRuleInternalServerError

NewGetRuleInternalServerError creates a GetRuleInternalServerError with default headers values

func (*GetRuleInternalServerError) Error 

func (o *GetRuleInternalServerError) Error() string

func (*GetRuleInternalServerError) GetPayload 

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

type GetRuleNotFound 

type GetRuleNotFound struct {
	Payload *models.GenericError
}

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

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 GetVersionOK 

type GetVersionOK struct {
	Payload *models.Version
}

GetVersionOK handles this case with default header values.

version

func NewGetVersionOK 

func NewGetVersionOK() *GetVersionOK

NewGetVersionOK creates a GetVersionOK with default headers values

func (*GetVersionOK) Error 

func (o *GetVersionOK) Error() string

func (*GetVersionOK) GetPayload 

func (o *GetVersionOK) GetPayload() *models.Version

type GetVersionParams 

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

GetVersionParams contains all the parameters to send to the API endpoint for the get version operation typically these are written to a http.Request

func NewGetVersionParams 

func NewGetVersionParams() *GetVersionParams

NewGetVersionParams creates a new GetVersionParams object with the default values initialized.

func NewGetVersionParamsWithContext 

func NewGetVersionParamsWithContext(ctx context.Context) *GetVersionParams

NewGetVersionParamsWithContext creates a new GetVersionParams object with the default values initialized, and the ability to set a context for a request

func NewGetVersionParamsWithHTTPClient 

func NewGetVersionParamsWithHTTPClient(client *http.Client) *GetVersionParams

NewGetVersionParamsWithHTTPClient creates a new GetVersionParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetVersionParamsWithTimeout 

func NewGetVersionParamsWithTimeout(timeout time.Duration) *GetVersionParams

NewGetVersionParamsWithTimeout creates a new GetVersionParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetVersionParams) SetContext 

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

SetContext adds the context to the get version params

func (*GetVersionParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get version params

func (*GetVersionParams) SetTimeout 

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

SetTimeout adds the timeout to the get version params

func (*GetVersionParams) WithContext 

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

WithContext adds the context to the get version params

func (*GetVersionParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get version params

func (*GetVersionParams) WithTimeout 

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

WithTimeout adds the timeout to the get version params

func (*GetVersionParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetVersionReader 

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

GetVersionReader is a Reader for the GetVersion structure.

func (*GetVersionReader) ReadResponse 

func (o *GetVersionReader) 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 handles this case with default header values.

genericError

func NewGetWellKnownJSONWebKeysInternalServerError 

func NewGetWellKnownJSONWebKeysInternalServerError() *GetWellKnownJSONWebKeysInternalServerError

NewGetWellKnownJSONWebKeysInternalServerError creates a GetWellKnownJSONWebKeysInternalServerError with default headers values

func (*GetWellKnownJSONWebKeysInternalServerError) Error 

func (o *GetWellKnownJSONWebKeysInternalServerError) Error() string

func (*GetWellKnownJSONWebKeysInternalServerError) GetPayload 

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

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 

func (o *GetWellKnownJSONWebKeysOK) GetPayload() *models.JSONWebKeySet

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 

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

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

func (*GetWellKnownJSONWebKeysParams) WithHTTPClient 

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

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

func (*GetWellKnownJSONWebKeysParams) WithTimeout 

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

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

func (*GetWellKnownJSONWebKeysParams) WriteToRequest 

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

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 IsInstanceAliveInternalServerError 

type IsInstanceAliveInternalServerError struct {
	Payload *models.GenericError
}

IsInstanceAliveInternalServerError handles this case with default header values.

genericError

func NewIsInstanceAliveInternalServerError 

func NewIsInstanceAliveInternalServerError() *IsInstanceAliveInternalServerError

NewIsInstanceAliveInternalServerError creates a IsInstanceAliveInternalServerError with default headers values

func (*IsInstanceAliveInternalServerError) Error 

func (o *IsInstanceAliveInternalServerError) Error() string

func (*IsInstanceAliveInternalServerError) GetPayload 

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

type IsInstanceAliveOK 

type IsInstanceAliveOK struct {
	Payload *models.HealthStatus
}

IsInstanceAliveOK handles this case with default header values.

healthStatus

func NewIsInstanceAliveOK 

func NewIsInstanceAliveOK() *IsInstanceAliveOK

NewIsInstanceAliveOK creates a IsInstanceAliveOK with default headers values

func (*IsInstanceAliveOK) Error 

func (o *IsInstanceAliveOK) Error() string

func (*IsInstanceAliveOK) GetPayload 

func (o *IsInstanceAliveOK) GetPayload() *models.HealthStatus

type IsInstanceAliveParams 

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

IsInstanceAliveParams contains all the parameters to send to the API endpoint for the is instance alive operation typically these are written to a http.Request

func NewIsInstanceAliveParams 

func NewIsInstanceAliveParams() *IsInstanceAliveParams

NewIsInstanceAliveParams creates a new IsInstanceAliveParams object with the default values initialized.

func NewIsInstanceAliveParamsWithContext 

func NewIsInstanceAliveParamsWithContext(ctx context.Context) *IsInstanceAliveParams

NewIsInstanceAliveParamsWithContext creates a new IsInstanceAliveParams object with the default values initialized, and the ability to set a context for a request

func NewIsInstanceAliveParamsWithHTTPClient 

func NewIsInstanceAliveParamsWithHTTPClient(client *http.Client) *IsInstanceAliveParams

NewIsInstanceAliveParamsWithHTTPClient creates a new IsInstanceAliveParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewIsInstanceAliveParamsWithTimeout 

func NewIsInstanceAliveParamsWithTimeout(timeout time.Duration) *IsInstanceAliveParams

NewIsInstanceAliveParamsWithTimeout creates a new IsInstanceAliveParams object with the default values initialized, and the ability to set a timeout on a request

func (*IsInstanceAliveParams) SetContext 

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

SetContext adds the context to the is instance alive params

func (*IsInstanceAliveParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the is instance alive params

func (*IsInstanceAliveParams) SetTimeout 

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

SetTimeout adds the timeout to the is instance alive params

func (*IsInstanceAliveParams) WithContext 

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

WithContext adds the context to the is instance alive params

func (*IsInstanceAliveParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the is instance alive params

func (*IsInstanceAliveParams) WithTimeout 

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

WithTimeout adds the timeout to the is instance alive params

func (*IsInstanceAliveParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type IsInstanceAliveReader 

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

IsInstanceAliveReader is a Reader for the IsInstanceAlive structure.

func (*IsInstanceAliveReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type IsInstanceReadyOK 

type IsInstanceReadyOK struct {
	Payload *models.HealthStatus
}

IsInstanceReadyOK handles this case with default header values.

healthStatus

func NewIsInstanceReadyOK 

func NewIsInstanceReadyOK() *IsInstanceReadyOK

NewIsInstanceReadyOK creates a IsInstanceReadyOK with default headers values

func (*IsInstanceReadyOK) Error 

func (o *IsInstanceReadyOK) Error() string

func (*IsInstanceReadyOK) GetPayload 

func (o *IsInstanceReadyOK) GetPayload() *models.HealthStatus

type IsInstanceReadyParams 

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

IsInstanceReadyParams contains all the parameters to send to the API endpoint for the is instance ready operation typically these are written to a http.Request

func NewIsInstanceReadyParams 

func NewIsInstanceReadyParams() *IsInstanceReadyParams

NewIsInstanceReadyParams creates a new IsInstanceReadyParams object with the default values initialized.

func NewIsInstanceReadyParamsWithContext 

func NewIsInstanceReadyParamsWithContext(ctx context.Context) *IsInstanceReadyParams

NewIsInstanceReadyParamsWithContext creates a new IsInstanceReadyParams object with the default values initialized, and the ability to set a context for a request

func NewIsInstanceReadyParamsWithHTTPClient 

func NewIsInstanceReadyParamsWithHTTPClient(client *http.Client) *IsInstanceReadyParams

NewIsInstanceReadyParamsWithHTTPClient creates a new IsInstanceReadyParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewIsInstanceReadyParamsWithTimeout 

func NewIsInstanceReadyParamsWithTimeout(timeout time.Duration) *IsInstanceReadyParams

NewIsInstanceReadyParamsWithTimeout creates a new IsInstanceReadyParams object with the default values initialized, and the ability to set a timeout on a request

func (*IsInstanceReadyParams) SetContext 

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

SetContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) SetTimeout 

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

SetTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WithContext 

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

WithContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) WithTimeout 

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

WithTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type IsInstanceReadyReader 

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

IsInstanceReadyReader is a Reader for the IsInstanceReady structure.

func (*IsInstanceReadyReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type IsInstanceReadyServiceUnavailable 

type IsInstanceReadyServiceUnavailable struct {
	Payload *models.HealthNotReadyStatus
}

IsInstanceReadyServiceUnavailable handles this case with default header values.

healthNotReadyStatus

func NewIsInstanceReadyServiceUnavailable 

func NewIsInstanceReadyServiceUnavailable() *IsInstanceReadyServiceUnavailable

NewIsInstanceReadyServiceUnavailable creates a IsInstanceReadyServiceUnavailable with default headers values

func (*IsInstanceReadyServiceUnavailable) Error 

func (o *IsInstanceReadyServiceUnavailable) Error() string

func (*IsInstanceReadyServiceUnavailable) GetPayload 

func (o *IsInstanceReadyServiceUnavailable) GetPayload() *models.HealthNotReadyStatus

type ListRulesInternalServerError 

type ListRulesInternalServerError struct {
	Payload *models.GenericError
}

ListRulesInternalServerError handles this case with default header values.

genericError

func NewListRulesInternalServerError 

func NewListRulesInternalServerError() *ListRulesInternalServerError

NewListRulesInternalServerError creates a ListRulesInternalServerError with default headers values

func (*ListRulesInternalServerError) Error 

func (o *ListRulesInternalServerError) Error() string

func (*ListRulesInternalServerError) GetPayload 

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

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.

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.