status

Documentation

Index

• type Client
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
  • func (a *Client) StatusList(params *StatusListParams, authInfo runtime.ClientAuthInfoWriter, ...) (*StatusListOK, error)
• type ClientOption
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
  • func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService
  • func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService
• type StatusListDefault
  • func NewStatusListDefault(code int) *StatusListDefault
  • func (o *StatusListDefault) Code() int
  • func (o *StatusListDefault) Error() string
  • func (o *StatusListDefault) GetPayload() interface{}
  • func (o *StatusListDefault) IsClientError() bool
  • func (o *StatusListDefault) IsCode(code int) bool
  • func (o *StatusListDefault) IsRedirect() bool
  • func (o *StatusListDefault) IsServerError() bool
  • func (o *StatusListDefault) IsSuccess() bool
  • func (o *StatusListDefault) String() string
• type StatusListOK
  • func NewStatusListOK() *StatusListOK
  • func (o *StatusListOK) Code() int
  • func (o *StatusListOK) Error() string
  • func (o *StatusListOK) GetPayload() interface{}
  • func (o *StatusListOK) IsClientError() bool
  • func (o *StatusListOK) IsCode(code int) bool
  • func (o *StatusListOK) IsRedirect() bool
  • func (o *StatusListOK) IsServerError() bool
  • func (o *StatusListOK) IsSuccess() bool
  • func (o *StatusListOK) String() string
• type StatusListParams
  • func NewStatusListParams() *StatusListParams
  • func NewStatusListParamsWithContext(ctx context.Context) *StatusListParams
  • func NewStatusListParamsWithHTTPClient(client *http.Client) *StatusListParams
  • func NewStatusListParamsWithTimeout(timeout time.Duration) *StatusListParams
  • func (o *StatusListParams) SetContext(ctx context.Context)
  • func (o *StatusListParams) SetDefaults()
  • func (o *StatusListParams) SetHTTPClient(client *http.Client)
  • func (o *StatusListParams) SetTimeout(timeout time.Duration)
  • func (o *StatusListParams) WithContext(ctx context.Context) *StatusListParams
  • func (o *StatusListParams) WithDefaults() *StatusListParams
  • func (o *StatusListParams) WithHTTPClient(client *http.Client) *StatusListParams
  • func (o *StatusListParams) WithTimeout(timeout time.Duration) *StatusListParams
  • func (o *StatusListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type StatusListReader
  • func (o *StatusListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

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

Client for status API

func (*Client) SetTransport

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

SetTransport changes the transport on the client

func (*Client) StatusList

func (a *Client) StatusList(params *StatusListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*StatusListOK, error)

StatusList A lightweight read-only endpoint for conveying NetBox's current operational status.

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService

type ClientService interface {
	StatusList(params *StatusListParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*StatusListOK, 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 status API client.

func NewClientWithBasicAuth

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new status API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new status API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type StatusListDefault

type StatusListDefault struct {
	Payload interface{}
	// contains filtered or unexported fields
}

StatusListDefault describes a response with status code -1, with default header values.

StatusListDefault status list default

func NewStatusListDefault

func NewStatusListDefault(code int) *StatusListDefault

NewStatusListDefault creates a StatusListDefault with default headers values

func (*StatusListDefault) Code

func (o *StatusListDefault) Code() int

Code gets the status code for the status list default response

func (*StatusListDefault) Error

func (o *StatusListDefault) Error() string

func (*StatusListDefault) GetPayload

func (o *StatusListDefault) GetPayload() interface{}

func (*StatusListDefault) IsClientError

func (o *StatusListDefault) IsClientError() bool

IsClientError returns true when this status list default response has a 4xx status code

func (*StatusListDefault) IsCode

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

IsCode returns true when this status list default response a status code equal to that given

func (*StatusListDefault) IsRedirect

func (o *StatusListDefault) IsRedirect() bool

IsRedirect returns true when this status list default response has a 3xx status code

func (*StatusListDefault) IsServerError

func (o *StatusListDefault) IsServerError() bool

IsServerError returns true when this status list default response has a 5xx status code

func (*StatusListDefault) IsSuccess

func (o *StatusListDefault) IsSuccess() bool

IsSuccess returns true when this status list default response has a 2xx status code

func (*StatusListDefault) String

func (o *StatusListDefault) String() string

type StatusListOK

type StatusListOK struct {
	Payload interface{}
}

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

StatusListOK status list o k

func NewStatusListOK

func NewStatusListOK() *StatusListOK

NewStatusListOK creates a StatusListOK with default headers values

func (*StatusListOK) Code

func (o *StatusListOK) Code() int

Code gets the status code for the status list o k response

func (*StatusListOK) Error

func (o *StatusListOK) Error() string

func (*StatusListOK) GetPayload

func (o *StatusListOK) GetPayload() interface{}

func (*StatusListOK) IsClientError

func (o *StatusListOK) IsClientError() bool

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

func (*StatusListOK) IsCode

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

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

func (*StatusListOK) IsRedirect

func (o *StatusListOK) IsRedirect() bool

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

func (*StatusListOK) IsServerError

func (o *StatusListOK) IsServerError() bool

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

func (*StatusListOK) IsSuccess

func (o *StatusListOK) IsSuccess() bool

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

func (*StatusListOK) String

func (o *StatusListOK) String() string

type StatusListParams

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

StatusListParams contains all the parameters to send to the API endpoint

for the status list operation.

Typically these are written to a http.Request.

func NewStatusListParams

func NewStatusListParams() *StatusListParams

NewStatusListParams creates a new StatusListParams 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 NewStatusListParamsWithContext

func NewStatusListParamsWithContext(ctx context.Context) *StatusListParams

NewStatusListParamsWithContext creates a new StatusListParams object with the ability to set a context for a request.

func NewStatusListParamsWithHTTPClient

func NewStatusListParamsWithHTTPClient(client *http.Client) *StatusListParams

NewStatusListParamsWithHTTPClient creates a new StatusListParams object with the ability to set a custom HTTPClient for a request.

func NewStatusListParamsWithTimeout

func NewStatusListParamsWithTimeout(timeout time.Duration) *StatusListParams

NewStatusListParamsWithTimeout creates a new StatusListParams object with the ability to set a timeout on a request.

func (*StatusListParams) SetContext

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

SetContext adds the context to the status list params

func (*StatusListParams) SetDefaults

func (o *StatusListParams) SetDefaults()

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

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

func (*StatusListParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the status list params

func (*StatusListParams) SetTimeout

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

SetTimeout adds the timeout to the status list params

func (*StatusListParams) WithContext

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

WithContext adds the context to the status list params

func (*StatusListParams) WithDefaults

func (o *StatusListParams) WithDefaults() *StatusListParams

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

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

func (*StatusListParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the status list params

func (*StatusListParams) WithTimeout

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

WithTimeout adds the timeout to the status list params

func (*StatusListParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type StatusListReader

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

StatusListReader is a Reader for the StatusList structure.

func (*StatusListReader) ReadResponse

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

ReadResponse reads a server response into the received o.