server

Documentation

Index

• type Client
  • func (a *Client) Heartbeat(params *HeartbeatParams, authInfo runtime.ClientAuthInfoWriter) (*HeartbeatNoContent, *HeartbeatBadRequest, *HeartbeatInternalServerError, ...)
  • func (a *Client) HeartbeatShort(params *HeartbeatParams, authInfo runtime.ClientAuthInfoWriter) (*HeartbeatNoContent, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
• type HeartbeatBadRequest
  • func NewHeartbeatBadRequest() *HeartbeatBadRequest
  • func (o *HeartbeatBadRequest) Error() string
  • func (o *HeartbeatBadRequest) GetPayload() *qosmclientmodels.ResponseError
  • func (o *HeartbeatBadRequest) ToJSONString() string
• type HeartbeatInternalServerError
  • func NewHeartbeatInternalServerError() *HeartbeatInternalServerError
  • func (o *HeartbeatInternalServerError) Error() string
  • func (o *HeartbeatInternalServerError) GetPayload() *qosmclientmodels.ResponseError
  • func (o *HeartbeatInternalServerError) ToJSONString() string
• type HeartbeatNoContent
  • func NewHeartbeatNoContent() *HeartbeatNoContent
  • func (o *HeartbeatNoContent) Error() string
• type HeartbeatParams
  • func NewHeartbeatParams() *HeartbeatParams
  • func NewHeartbeatParamsWithContext(ctx context.Context) *HeartbeatParams
  • func NewHeartbeatParamsWithHTTPClient(client *http.Client) *HeartbeatParams
  • func NewHeartbeatParamsWithTimeout(timeout time.Duration) *HeartbeatParams
  • func (o *HeartbeatParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
  • func (o *HeartbeatParams) SetBody(body *qosmclientmodels.ModelsHeartbeatRequest)
  • func (o *HeartbeatParams) SetContext(ctx context.Context)
  • func (o *HeartbeatParams) SetFlightId(flightId string)
  • func (o *HeartbeatParams) SetHTTPClient(client *http.Client)
  • func (o *HeartbeatParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
  • func (o *HeartbeatParams) SetTimeout(timeout time.Duration)
  • func (o *HeartbeatParams) WithBody(body *qosmclientmodels.ModelsHeartbeatRequest) *HeartbeatParams
  • func (o *HeartbeatParams) WithContext(ctx context.Context) *HeartbeatParams
  • func (o *HeartbeatParams) WithHTTPClient(client *http.Client) *HeartbeatParams
  • func (o *HeartbeatParams) WithTimeout(timeout time.Duration) *HeartbeatParams
  • func (o *HeartbeatParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type HeartbeatReader
  • func (o *HeartbeatReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

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

Client for server API

func (*Client) Heartbeat

func (a *Client) Heartbeat(params *HeartbeatParams, authInfo runtime.ClientAuthInfoWriter) (*HeartbeatNoContent, *HeartbeatBadRequest, *HeartbeatInternalServerError, error)

Deprecated: 2022-08-10 - Use HeartbeatShort instead.

Heartbeat send heartbeat ``` Required permission: QOS:SERVER [CREATE][UPDATE] Required scope: social

This endpoint is intended to be called by QoS service to register and periodically let QoS Manager know that it is still alive. ```

func (*Client) HeartbeatShort

func (a *Client) HeartbeatShort(params *HeartbeatParams, authInfo runtime.ClientAuthInfoWriter) (*HeartbeatNoContent, error)

HeartbeatShort send heartbeat ``` Required permission: QOS:SERVER [CREATE][UPDATE] Required scope: social

This endpoint is intended to be called by QoS service to register and periodically let QoS Manager know that it is still alive. ```

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	Heartbeat(params *HeartbeatParams, authInfo runtime.ClientAuthInfoWriter) (*HeartbeatNoContent, *HeartbeatBadRequest, *HeartbeatInternalServerError, error)
	HeartbeatShort(params *HeartbeatParams, authInfo runtime.ClientAuthInfoWriter) (*HeartbeatNoContent, 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 server API client.

type HeartbeatBadRequest

type HeartbeatBadRequest struct {
	Payload *qosmclientmodels.ResponseError
}

HeartbeatBadRequest handles this case with default header values.

malformed request

func NewHeartbeatBadRequest

func NewHeartbeatBadRequest() *HeartbeatBadRequest

NewHeartbeatBadRequest creates a HeartbeatBadRequest with default headers values

func (*HeartbeatBadRequest) Error

func (o *HeartbeatBadRequest) Error() string

func (*HeartbeatBadRequest) GetPayload

func (o *HeartbeatBadRequest) GetPayload() *qosmclientmodels.ResponseError

func (*HeartbeatBadRequest) ToJSONString

func (o *HeartbeatBadRequest) ToJSONString() string

type HeartbeatInternalServerError

type HeartbeatInternalServerError struct {
	Payload *qosmclientmodels.ResponseError
}

HeartbeatInternalServerError handles this case with default header values.

Internal Server Error

func NewHeartbeatInternalServerError

func NewHeartbeatInternalServerError() *HeartbeatInternalServerError

NewHeartbeatInternalServerError creates a HeartbeatInternalServerError with default headers values

func (*HeartbeatInternalServerError) Error

func (o *HeartbeatInternalServerError) Error() string

func (*HeartbeatInternalServerError) GetPayload

func (o *HeartbeatInternalServerError) GetPayload() *qosmclientmodels.ResponseError

func (*HeartbeatInternalServerError) ToJSONString

func (o *HeartbeatInternalServerError) ToJSONString() string

type HeartbeatNoContent

type HeartbeatNoContent struct {
}

HeartbeatNoContent handles this case with default header values.

heartbeat received

func NewHeartbeatNoContent

func NewHeartbeatNoContent() *HeartbeatNoContent

NewHeartbeatNoContent creates a HeartbeatNoContent with default headers values

func (*HeartbeatNoContent) Error

func (o *HeartbeatNoContent) Error() string

type HeartbeatParams

type HeartbeatParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Body*/
	Body *qosmclientmodels.ModelsHeartbeatRequest

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client

	// XFlightId is an optional parameter from this SDK
	XFlightId *string
	// contains filtered or unexported fields
}

HeartbeatParams contains all the parameters to send to the API endpoint for the heartbeat operation typically these are written to a http.Request

func NewHeartbeatParams

func NewHeartbeatParams() *HeartbeatParams

NewHeartbeatParams creates a new HeartbeatParams object with the default values initialized.

func NewHeartbeatParamsWithContext

func NewHeartbeatParamsWithContext(ctx context.Context) *HeartbeatParams

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

func NewHeartbeatParamsWithHTTPClient

func NewHeartbeatParamsWithHTTPClient(client *http.Client) *HeartbeatParams

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

func NewHeartbeatParamsWithTimeout

func NewHeartbeatParamsWithTimeout(timeout time.Duration) *HeartbeatParams

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

func (*HeartbeatParams) SetAuthInfoWriter

func (o *HeartbeatParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the heartbeat params

func (*HeartbeatParams) SetBody

func (o *HeartbeatParams) SetBody(body *qosmclientmodels.ModelsHeartbeatRequest)

SetBody adds the body to the heartbeat params

func (*HeartbeatParams) SetContext

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

SetContext adds the context to the heartbeat params

func (*HeartbeatParams) SetFlightId

func (o *HeartbeatParams) SetFlightId(flightId string)

SetFlightId adds the flightId as the header value for this specific endpoint

func (*HeartbeatParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the heartbeat params

func (*HeartbeatParams) SetHTTPClientTransport

func (o *HeartbeatParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the heartbeat params

func (*HeartbeatParams) SetTimeout

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

SetTimeout adds the timeout to the heartbeat params

func (*HeartbeatParams) WithBody

func (o *HeartbeatParams) WithBody(body *qosmclientmodels.ModelsHeartbeatRequest) *HeartbeatParams

WithBody adds the body to the heartbeat params

func (*HeartbeatParams) WithContext

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

WithContext adds the context to the heartbeat params

func (*HeartbeatParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the heartbeat params

func (*HeartbeatParams) WithTimeout

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

WithTimeout adds the timeout to the heartbeat params

func (*HeartbeatParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type HeartbeatReader

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

HeartbeatReader is a Reader for the Heartbeat structure.

func (*HeartbeatReader) ReadResponse

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

ReadResponse reads a server response into the received o.