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

package version

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

Index

Package Files

get_version_parameters.go get_version_responses.go version_client.go

type Client Uses

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

Client for version API

func (*Client) GetVersion Uses

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

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

SetTransport changes the transport on the client

type ClientService Uses

type ClientService interface {
    GetVersion(params *GetVersionParams) (*GetVersionOK, 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 version API client.

type GetVersionOK Uses

type GetVersionOK struct {
    Payload *models.Version
}

GetVersionOK handles this case with default header values.

version

func NewGetVersionOK Uses

func NewGetVersionOK() *GetVersionOK

NewGetVersionOK creates a GetVersionOK with default headers values

func (*GetVersionOK) Error Uses

func (o *GetVersionOK) Error() string

func (*GetVersionOK) GetPayload Uses

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

type GetVersionParams Uses

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 Uses

func NewGetVersionParams() *GetVersionParams

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

func NewGetVersionParamsWithContext Uses

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 Uses

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 Uses

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 Uses

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

SetContext adds the context to the get version params

func (*GetVersionParams) SetHTTPClient Uses

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

SetHTTPClient adds the HTTPClient to the get version params

func (*GetVersionParams) SetTimeout Uses

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

SetTimeout adds the timeout to the get version params

func (*GetVersionParams) WithContext Uses

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

WithContext adds the context to the get version params

func (*GetVersionParams) WithHTTPClient Uses

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

WithHTTPClient adds the HTTPClient to the get version params

func (*GetVersionParams) WithTimeout Uses

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

WithTimeout adds the timeout to the get version params

func (*GetVersionParams) WriteToRequest Uses

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

WriteToRequest writes these params to a swagger request

type GetVersionReader Uses

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

GetVersionReader is a Reader for the GetVersion structure.

func (*GetVersionReader) ReadResponse Uses

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

ReadResponse reads a server response into the received o.

Package version imports 10 packages (graph) and is imported by 1 packages. Updated 2020-07-29. Refresh now. Tools for package owners.