inspect

Documentation

Index

• type Client
  • func (a *Client) Inspect(params *InspectParams, opts ...ClientOption) (*InspectOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type ClientOption
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
• type InspectOK
  • func NewInspectOK() *InspectOK
  • func (o *InspectOK) Code() int
  • func (o *InspectOK) Error() string
  • func (o *InspectOK) GetPayload() *rest_model.InspectResponse
  • func (o *InspectOK) IsClientError() bool
  • func (o *InspectOK) IsCode(code int) bool
  • func (o *InspectOK) IsRedirect() bool
  • func (o *InspectOK) IsServerError() bool
  • func (o *InspectOK) IsSuccess() bool
  • func (o *InspectOK) String() string
• type InspectParams
  • func NewInspectParams() *InspectParams
  • func NewInspectParamsWithContext(ctx context.Context) *InspectParams
  • func NewInspectParamsWithHTTPClient(client *http.Client) *InspectParams
  • func NewInspectParamsWithTimeout(timeout time.Duration) *InspectParams
  • func (o *InspectParams) SetContext(ctx context.Context)
  • func (o *InspectParams) SetDefaults()
  • func (o *InspectParams) SetHTTPClient(client *http.Client)
  • func (o *InspectParams) SetRequest(request *rest_model.InspectRequest)
  • func (o *InspectParams) SetTimeout(timeout time.Duration)
  • func (o *InspectParams) WithContext(ctx context.Context) *InspectParams
  • func (o *InspectParams) WithDefaults() *InspectParams
  • func (o *InspectParams) WithHTTPClient(client *http.Client) *InspectParams
  • func (o *InspectParams) WithRequest(request *rest_model.InspectRequest) *InspectParams
  • func (o *InspectParams) WithTimeout(timeout time.Duration) *InspectParams
  • func (o *InspectParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type InspectReader
  • func (o *InspectReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
• type InspectUnauthorized
  • func NewInspectUnauthorized() *InspectUnauthorized
  • func (o *InspectUnauthorized) Code() int
  • func (o *InspectUnauthorized) Error() string
  • func (o *InspectUnauthorized) GetPayload() *rest_model.APIErrorEnvelope
  • func (o *InspectUnauthorized) IsClientError() bool
  • func (o *InspectUnauthorized) IsCode(code int) bool
  • func (o *InspectUnauthorized) IsRedirect() bool
  • func (o *InspectUnauthorized) IsServerError() bool
  • func (o *InspectUnauthorized) IsSuccess() bool
  • func (o *InspectUnauthorized) String() string

Types

type Client

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

Client for inspect API

func (*Client) Inspect

func (a *Client) Inspect(params *InspectParams, opts ...ClientOption) (*InspectOK, error)

Inspect inspects system values

Requests system information, such as stack dumps or information about capabilities. Requires admin access.

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 {
	Inspect(params *InspectParams, opts ...ClientOption) (*InspectOK, 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 inspect API client.

type InspectOK

type InspectOK struct {
	Payload *rest_model.InspectResponse
}

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

A response to an inspect request

func NewInspectOK

func NewInspectOK() *InspectOK

NewInspectOK creates a InspectOK with default headers values

func (*InspectOK) Code

func (o *InspectOK) Code() int

Code gets the status code for the inspect o k response

func (*InspectOK) Error

func (o *InspectOK) Error() string

func (*InspectOK) GetPayload

func (o *InspectOK) GetPayload() *rest_model.InspectResponse

func (*InspectOK) IsClientError

func (o *InspectOK) IsClientError() bool

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

func (*InspectOK) IsCode

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

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

func (*InspectOK) IsRedirect

func (o *InspectOK) IsRedirect() bool

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

func (*InspectOK) IsServerError

func (o *InspectOK) IsServerError() bool

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

func (*InspectOK) IsSuccess

func (o *InspectOK) IsSuccess() bool

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

func (*InspectOK) String

func (o *InspectOK) String() string

type InspectParams

type InspectParams struct {

	/* Request.

	   An inspect request
	*/
	Request *rest_model.InspectRequest

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

InspectParams contains all the parameters to send to the API endpoint

for the inspect operation.

Typically these are written to a http.Request.

func NewInspectParams

func NewInspectParams() *InspectParams

NewInspectParams creates a new InspectParams 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 NewInspectParamsWithContext

func NewInspectParamsWithContext(ctx context.Context) *InspectParams

NewInspectParamsWithContext creates a new InspectParams object with the ability to set a context for a request.

func NewInspectParamsWithHTTPClient

func NewInspectParamsWithHTTPClient(client *http.Client) *InspectParams

NewInspectParamsWithHTTPClient creates a new InspectParams object with the ability to set a custom HTTPClient for a request.

func NewInspectParamsWithTimeout

func NewInspectParamsWithTimeout(timeout time.Duration) *InspectParams

NewInspectParamsWithTimeout creates a new InspectParams object with the ability to set a timeout on a request.

func (*InspectParams) SetContext

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

SetContext adds the context to the inspect params

func (*InspectParams) SetDefaults

func (o *InspectParams) SetDefaults()

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

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

func (*InspectParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the inspect params

func (*InspectParams) SetRequest

func (o *InspectParams) SetRequest(request *rest_model.InspectRequest)

SetRequest adds the request to the inspect params

func (*InspectParams) SetTimeout

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

SetTimeout adds the timeout to the inspect params

func (*InspectParams) WithContext

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

WithContext adds the context to the inspect params

func (*InspectParams) WithDefaults

func (o *InspectParams) WithDefaults() *InspectParams

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

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

func (*InspectParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the inspect params

func (*InspectParams) WithRequest

func (o *InspectParams) WithRequest(request *rest_model.InspectRequest) *InspectParams

WithRequest adds the request to the inspect params

func (*InspectParams) WithTimeout

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

WithTimeout adds the timeout to the inspect params

func (*InspectParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type InspectReader

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

InspectReader is a Reader for the Inspect structure.

func (*InspectReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type InspectUnauthorized

type InspectUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}

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

The currently supplied session does not have the correct access rights to request this resource

func NewInspectUnauthorized

func NewInspectUnauthorized() *InspectUnauthorized

NewInspectUnauthorized creates a InspectUnauthorized with default headers values

func (*InspectUnauthorized) Code

func (o *InspectUnauthorized) Code() int

Code gets the status code for the inspect unauthorized response

func (*InspectUnauthorized) Error

func (o *InspectUnauthorized) Error() string

func (*InspectUnauthorized) GetPayload

func (o *InspectUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

func (*InspectUnauthorized) IsClientError

func (o *InspectUnauthorized) IsClientError() bool

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

func (*InspectUnauthorized) IsCode

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

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

func (*InspectUnauthorized) IsRedirect

func (o *InspectUnauthorized) IsRedirect() bool

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

func (*InspectUnauthorized) IsServerError

func (o *InspectUnauthorized) IsServerError() bool

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

func (*InspectUnauthorized) IsSuccess

func (o *InspectUnauthorized) IsSuccess() bool

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

func (*InspectUnauthorized) String

func (o *InspectUnauthorized) String() string