specification

Documentation

Index

• type Client
  • func (a *Client) GetSpecification(params *GetSpecificationParams, authInfo runtime.ClientAuthInfoWriter, ...) (*GetSpecificationOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• type ClientOption
• type ClientService
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
• type GetSpecificationDefault
  • func NewGetSpecificationDefault(code int) *GetSpecificationDefault
  • func (o *GetSpecificationDefault) Code() int
  • func (o *GetSpecificationDefault) Error() string
  • func (o *GetSpecificationDefault) GetPayload() *models.Error
• type GetSpecificationOK
  • func NewGetSpecificationOK() *GetSpecificationOK
  • func (o *GetSpecificationOK) Error() string
  • func (o *GetSpecificationOK) GetPayload() interface{}
• type GetSpecificationParams
  • func NewGetSpecificationParams() *GetSpecificationParams
  • func NewGetSpecificationParamsWithContext(ctx context.Context) *GetSpecificationParams
  • func NewGetSpecificationParamsWithHTTPClient(client *http.Client) *GetSpecificationParams
  • func NewGetSpecificationParamsWithTimeout(timeout time.Duration) *GetSpecificationParams
  • func (o *GetSpecificationParams) SetContext(ctx context.Context)
  • func (o *GetSpecificationParams) SetDefaults()
  • func (o *GetSpecificationParams) SetHTTPClient(client *http.Client)
  • func (o *GetSpecificationParams) SetTimeout(timeout time.Duration)
  • func (o *GetSpecificationParams) WithContext(ctx context.Context) *GetSpecificationParams
  • func (o *GetSpecificationParams) WithDefaults() *GetSpecificationParams
  • func (o *GetSpecificationParams) WithHTTPClient(client *http.Client) *GetSpecificationParams
  • func (o *GetSpecificationParams) WithTimeout(timeout time.Duration) *GetSpecificationParams
  • func (o *GetSpecificationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type GetSpecificationReader
  • func (o *GetSpecificationReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

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

Client for specification API

func (*Client) GetSpecification

func (a *Client) GetSpecification(params *GetSpecificationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSpecificationOK, error)

GetSpecification data plane API specification

Return Data Plane API OpenAPI specification

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 {
	GetSpecification(params *GetSpecificationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetSpecificationOK, 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 specification API client.

type GetSpecificationDefault

type GetSpecificationDefault struct {

	/* Configuration file version
	 */
	ConfigurationVersion string

	Payload *models.Error
	// contains filtered or unexported fields
}

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

General Error

func NewGetSpecificationDefault

func NewGetSpecificationDefault(code int) *GetSpecificationDefault

NewGetSpecificationDefault creates a GetSpecificationDefault with default headers values

func (*GetSpecificationDefault) Code

func (o *GetSpecificationDefault) Code() int

Code gets the status code for the get specification default response

func (*GetSpecificationDefault) Error

func (o *GetSpecificationDefault) Error() string

func (*GetSpecificationDefault) GetPayload

func (o *GetSpecificationDefault) GetPayload() *models.Error

type GetSpecificationOK

type GetSpecificationOK struct {
	Payload interface{}
}

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

Success

func NewGetSpecificationOK

func NewGetSpecificationOK() *GetSpecificationOK

NewGetSpecificationOK creates a GetSpecificationOK with default headers values

func (*GetSpecificationOK) Error

func (o *GetSpecificationOK) Error() string

func (*GetSpecificationOK) GetPayload

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

type GetSpecificationParams

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

GetSpecificationParams contains all the parameters to send to the API endpoint

for the get specification operation.

Typically these are written to a http.Request.

func NewGetSpecificationParams

func NewGetSpecificationParams() *GetSpecificationParams

NewGetSpecificationParams creates a new GetSpecificationParams 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 NewGetSpecificationParamsWithContext

func NewGetSpecificationParamsWithContext(ctx context.Context) *GetSpecificationParams

NewGetSpecificationParamsWithContext creates a new GetSpecificationParams object with the ability to set a context for a request.

func NewGetSpecificationParamsWithHTTPClient

func NewGetSpecificationParamsWithHTTPClient(client *http.Client) *GetSpecificationParams

NewGetSpecificationParamsWithHTTPClient creates a new GetSpecificationParams object with the ability to set a custom HTTPClient for a request.

func NewGetSpecificationParamsWithTimeout

func NewGetSpecificationParamsWithTimeout(timeout time.Duration) *GetSpecificationParams

NewGetSpecificationParamsWithTimeout creates a new GetSpecificationParams object with the ability to set a timeout on a request.

func (*GetSpecificationParams) SetContext

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

SetContext adds the context to the get specification params

func (*GetSpecificationParams) SetDefaults

func (o *GetSpecificationParams) SetDefaults()

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

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

func (*GetSpecificationParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get specification params

func (*GetSpecificationParams) SetTimeout

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

SetTimeout adds the timeout to the get specification params

func (*GetSpecificationParams) WithContext

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

WithContext adds the context to the get specification params

func (*GetSpecificationParams) WithDefaults

func (o *GetSpecificationParams) WithDefaults() *GetSpecificationParams

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

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

func (*GetSpecificationParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get specification params

func (*GetSpecificationParams) WithTimeout

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

WithTimeout adds the timeout to the get specification params

func (*GetSpecificationParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetSpecificationReader

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

GetSpecificationReader is a Reader for the GetSpecification structure.

func (*GetSpecificationReader) ReadResponse

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

ReadResponse reads a server response into the received o.