about_the_service

Documentation

Index

• type AboutOK
  • func NewAboutOK() *AboutOK
  • func (o *AboutOK) Error() string
  • func (o *AboutOK) GetPayload() *models.AboutResponse
  • func (o *AboutOK) IsClientError() bool
  • func (o *AboutOK) IsCode(code int) bool
  • func (o *AboutOK) IsRedirect() bool
  • func (o *AboutOK) IsServerError() bool
  • func (o *AboutOK) IsSuccess() bool
  • func (o *AboutOK) String() string
• type AboutParams
  • func NewAboutParams() *AboutParams
  • func NewAboutParamsWithContext(ctx context.Context) *AboutParams
  • func NewAboutParamsWithHTTPClient(client *http.Client) *AboutParams
  • func NewAboutParamsWithTimeout(timeout time.Duration) *AboutParams
  • func (o *AboutParams) SetContext(ctx context.Context)
  • func (o *AboutParams) SetDefaults()
  • func (o *AboutParams) SetHTTPClient(client *http.Client)
  • func (o *AboutParams) SetTimeout(timeout time.Duration)
  • func (o *AboutParams) WithContext(ctx context.Context) *AboutParams
  • func (o *AboutParams) WithDefaults() *AboutParams
  • func (o *AboutParams) WithHTTPClient(client *http.Client) *AboutParams
  • func (o *AboutParams) WithTimeout(timeout time.Duration) *AboutParams
  • func (o *AboutParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type AboutReader
  • func (o *AboutReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
• type AboutUnauthorized
  • func NewAboutUnauthorized() *AboutUnauthorized
  • func (o *AboutUnauthorized) Error() string
  • func (o *AboutUnauthorized) IsClientError() bool
  • func (o *AboutUnauthorized) IsCode(code int) bool
  • func (o *AboutUnauthorized) IsRedirect() bool
  • func (o *AboutUnauthorized) IsServerError() bool
  • func (o *AboutUnauthorized) IsSuccess() bool
  • func (o *AboutUnauthorized) String() string
• type Client
  • func (a *Client) About(params *AboutParams, opts ...ClientOption) (*AboutOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type ClientOption
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

Types

type AboutOK

type AboutOK struct {
	Payload *models.AboutResponse
}

AboutOK describes a response with status code 200, with default header values.

Success

func NewAboutOK

func NewAboutOK() *AboutOK

NewAboutOK creates a AboutOK with default headers values

func (*AboutOK) Error

func (o *AboutOK) Error() string

func (*AboutOK) GetPayload

func (o *AboutOK) GetPayload() *models.AboutResponse

func (*AboutOK) IsClientError

func (o *AboutOK) IsClientError() bool

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

func (*AboutOK) IsCode

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

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

func (*AboutOK) IsRedirect

func (o *AboutOK) IsRedirect() bool

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

func (*AboutOK) IsServerError

func (o *AboutOK) IsServerError() bool

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

func (*AboutOK) IsSuccess

func (o *AboutOK) IsSuccess() bool

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

func (*AboutOK) String

func (o *AboutOK) String() string

type AboutParams

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

AboutParams contains all the parameters to send to the API endpoint

for the about operation.

Typically these are written to a http.Request.

func NewAboutParams

func NewAboutParams() *AboutParams

NewAboutParams creates a new AboutParams 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 NewAboutParamsWithContext

func NewAboutParamsWithContext(ctx context.Context) *AboutParams

NewAboutParamsWithContext creates a new AboutParams object with the ability to set a context for a request.

func NewAboutParamsWithHTTPClient

func NewAboutParamsWithHTTPClient(client *http.Client) *AboutParams

NewAboutParamsWithHTTPClient creates a new AboutParams object with the ability to set a custom HTTPClient for a request.

func NewAboutParamsWithTimeout

func NewAboutParamsWithTimeout(timeout time.Duration) *AboutParams

NewAboutParamsWithTimeout creates a new AboutParams object with the ability to set a timeout on a request.

func (*AboutParams) SetContext

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

SetContext adds the context to the about params

func (*AboutParams) SetDefaults

func (o *AboutParams) SetDefaults()

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

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

func (*AboutParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the about params

func (*AboutParams) SetTimeout

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

SetTimeout adds the timeout to the about params

func (*AboutParams) WithContext

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

WithContext adds the context to the about params

func (*AboutParams) WithDefaults

func (o *AboutParams) WithDefaults() *AboutParams

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

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

func (*AboutParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the about params

func (*AboutParams) WithTimeout

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

WithTimeout adds the timeout to the about params

func (*AboutParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type AboutReader

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

AboutReader is a Reader for the About structure.

func (*AboutReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type AboutUnauthorized

type AboutUnauthorized struct {
}

AboutUnauthorized describes a response with status code 401, with default header values.

Unauthorized

func NewAboutUnauthorized

func NewAboutUnauthorized() *AboutUnauthorized

NewAboutUnauthorized creates a AboutUnauthorized with default headers values

func (*AboutUnauthorized) Error

func (o *AboutUnauthorized) Error() string

func (*AboutUnauthorized) IsClientError

func (o *AboutUnauthorized) IsClientError() bool

IsClientError returns true when this about unauthorized response has a 4xx status code

func (*AboutUnauthorized) IsCode

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

IsCode returns true when this about unauthorized response a status code equal to that given

func (*AboutUnauthorized) IsRedirect

func (o *AboutUnauthorized) IsRedirect() bool

IsRedirect returns true when this about unauthorized response has a 3xx status code

func (*AboutUnauthorized) IsServerError

func (o *AboutUnauthorized) IsServerError() bool

IsServerError returns true when this about unauthorized response has a 5xx status code

func (*AboutUnauthorized) IsSuccess

func (o *AboutUnauthorized) IsSuccess() bool

IsSuccess returns true when this about unauthorized response has a 2xx status code

func (*AboutUnauthorized) String

func (o *AboutUnauthorized) String() string

type Client

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

Client for about the service API

func (*Client) About

func (a *Client) About(params *AboutParams, opts ...ClientOption) (*AboutOK, error)

About provides basic information about relocation service

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 {
	About(params *AboutParams, opts ...ClientOption) (*AboutOK, 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 about the service API client.