oathkeeper: github.com/ory/oathkeeper/internal/httpclient/client/health Index | Files

package health

import "github.com/ory/oathkeeper/internal/httpclient/client/health"

Index

Package Files

health_client.go is_instance_alive_parameters.go is_instance_alive_responses.go is_instance_ready_parameters.go is_instance_ready_responses.go

type Client Uses

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

Client for health API

func (*Client) IsInstanceAlive Uses

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 Uses

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) SetTransport Uses

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

SetTransport changes the transport on the client

type ClientService Uses

type ClientService interface {
    IsInstanceAlive(params *IsInstanceAliveParams) (*IsInstanceAliveOK, error)

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

    SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New Uses

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

New creates a new health API client.

type IsInstanceAliveInternalServerError Uses

type IsInstanceAliveInternalServerError struct {
    Payload *IsInstanceAliveInternalServerErrorBody
}

IsInstanceAliveInternalServerError handles this case with default header values.

The standard error format

func NewIsInstanceAliveInternalServerError Uses

func NewIsInstanceAliveInternalServerError() *IsInstanceAliveInternalServerError

NewIsInstanceAliveInternalServerError creates a IsInstanceAliveInternalServerError with default headers values

func (*IsInstanceAliveInternalServerError) Error Uses

func (o *IsInstanceAliveInternalServerError) Error() string

func (*IsInstanceAliveInternalServerError) GetPayload Uses

func (o *IsInstanceAliveInternalServerError) GetPayload() *IsInstanceAliveInternalServerErrorBody

type IsInstanceAliveInternalServerErrorBody Uses

type IsInstanceAliveInternalServerErrorBody struct {

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

    // details
    Details []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"`
}

IsInstanceAliveInternalServerErrorBody is instance alive internal server error body swagger:model IsInstanceAliveInternalServerErrorBody

func (*IsInstanceAliveInternalServerErrorBody) MarshalBinary Uses

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

MarshalBinary interface implementation

func (*IsInstanceAliveInternalServerErrorBody) UnmarshalBinary Uses

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

UnmarshalBinary interface implementation

func (*IsInstanceAliveInternalServerErrorBody) Validate Uses

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

Validate validates this is instance alive internal server error body

type IsInstanceAliveOK Uses

type IsInstanceAliveOK struct {
    Payload *models.HealthStatus
}

IsInstanceAliveOK handles this case with default header values.

healthStatus

func NewIsInstanceAliveOK Uses

func NewIsInstanceAliveOK() *IsInstanceAliveOK

NewIsInstanceAliveOK creates a IsInstanceAliveOK with default headers values

func (*IsInstanceAliveOK) Error Uses

func (o *IsInstanceAliveOK) Error() string

func (*IsInstanceAliveOK) GetPayload Uses

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

type IsInstanceAliveParams Uses

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 Uses

func NewIsInstanceAliveParams() *IsInstanceAliveParams

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

func NewIsInstanceAliveParamsWithContext Uses

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 Uses

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 Uses

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 Uses

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

SetContext adds the context to the is instance alive params

func (*IsInstanceAliveParams) SetHTTPClient Uses

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

SetHTTPClient adds the HTTPClient to the is instance alive params

func (*IsInstanceAliveParams) SetTimeout Uses

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

SetTimeout adds the timeout to the is instance alive params

func (*IsInstanceAliveParams) WithContext Uses

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

WithContext adds the context to the is instance alive params

func (*IsInstanceAliveParams) WithHTTPClient Uses

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

WithHTTPClient adds the HTTPClient to the is instance alive params

func (*IsInstanceAliveParams) WithTimeout Uses

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

WithTimeout adds the timeout to the is instance alive params

func (*IsInstanceAliveParams) WriteToRequest Uses

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

WriteToRequest writes these params to a swagger request

type IsInstanceAliveReader Uses

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

IsInstanceAliveReader is a Reader for the IsInstanceAlive structure.

func (*IsInstanceAliveReader) ReadResponse Uses

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

ReadResponse reads a server response into the received o.

type IsInstanceReadyOK Uses

type IsInstanceReadyOK struct {
    Payload *models.HealthStatus
}

IsInstanceReadyOK handles this case with default header values.

healthStatus

func NewIsInstanceReadyOK Uses

func NewIsInstanceReadyOK() *IsInstanceReadyOK

NewIsInstanceReadyOK creates a IsInstanceReadyOK with default headers values

func (*IsInstanceReadyOK) Error Uses

func (o *IsInstanceReadyOK) Error() string

func (*IsInstanceReadyOK) GetPayload Uses

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

type IsInstanceReadyParams Uses

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 Uses

func NewIsInstanceReadyParams() *IsInstanceReadyParams

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

func NewIsInstanceReadyParamsWithContext Uses

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 Uses

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 Uses

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 Uses

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

SetContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) SetHTTPClient Uses

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

SetHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) SetTimeout Uses

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

SetTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WithContext Uses

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

WithContext adds the context to the is instance ready params

func (*IsInstanceReadyParams) WithHTTPClient Uses

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

WithHTTPClient adds the HTTPClient to the is instance ready params

func (*IsInstanceReadyParams) WithTimeout Uses

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

WithTimeout adds the timeout to the is instance ready params

func (*IsInstanceReadyParams) WriteToRequest Uses

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

WriteToRequest writes these params to a swagger request

type IsInstanceReadyReader Uses

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

IsInstanceReadyReader is a Reader for the IsInstanceReady structure.

func (*IsInstanceReadyReader) ReadResponse Uses

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

ReadResponse reads a server response into the received o.

type IsInstanceReadyServiceUnavailable Uses

type IsInstanceReadyServiceUnavailable struct {
    Payload *models.HealthNotReadyStatus
}

IsInstanceReadyServiceUnavailable handles this case with default header values.

healthNotReadyStatus

func NewIsInstanceReadyServiceUnavailable Uses

func NewIsInstanceReadyServiceUnavailable() *IsInstanceReadyServiceUnavailable

NewIsInstanceReadyServiceUnavailable creates a IsInstanceReadyServiceUnavailable with default headers values

func (*IsInstanceReadyServiceUnavailable) Error Uses

func (o *IsInstanceReadyServiceUnavailable) Error() string

func (*IsInstanceReadyServiceUnavailable) GetPayload Uses

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

Package health imports 11 packages (graph) and is imported by 2 packages. Updated 2020-07-29. Refresh now. Tools for package owners.