version

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: 10 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 version API

func (*Client) GetVersion

func (a *Client) GetVersion(params *GetVersionParams, opts ...ClientOption) (*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

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

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

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

type GetVersionOK

type GetVersionOK struct {
	Payload *models.Version
}

GetVersionOK describes a response with status code 200, 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

func (*GetVersionOK) IsClientError

func (o *GetVersionOK) IsClientError() bool

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

func (*GetVersionOK) IsCode

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

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

func (*GetVersionOK) IsRedirect

func (o *GetVersionOK) IsRedirect() bool

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

func (*GetVersionOK) IsServerError

func (o *GetVersionOK) IsServerError() bool

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

func (*GetVersionOK) IsSuccess

func (o *GetVersionOK) IsSuccess() bool

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

func (*GetVersionOK) String

func (o *GetVersionOK) String() string

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 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 NewGetVersionParamsWithContext

func NewGetVersionParamsWithContext(ctx context.Context) *GetVersionParams

NewGetVersionParamsWithContext creates a new GetVersionParams object with 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 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 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) SetDefaults

func (o *GetVersionParams) SetDefaults()

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

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

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

func (o *GetVersionParams) WithDefaults() *GetVersionParams

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

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

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.

Jump to

Keyboard shortcuts

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