first_run

Documentation

Index

• type Client
  • func (a *Client) FirstRun(params *FirstRunParams, authInfo runtime.ClientAuthInfoWriter, ...) (*FirstRunOK, error)
  • func (a *Client) SetTransport(transport runtime.ClientTransport)
• 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 FirstRunBadRequest
  • func NewFirstRunBadRequest() *FirstRunBadRequest
  • func (o *FirstRunBadRequest) Code() int
  • func (o *FirstRunBadRequest) Error() string
  • func (o *FirstRunBadRequest) GetPayload() apiserver_params.APIErrorResponse
  • func (o *FirstRunBadRequest) IsClientError() bool
  • func (o *FirstRunBadRequest) IsCode(code int) bool
  • func (o *FirstRunBadRequest) IsRedirect() bool
  • func (o *FirstRunBadRequest) IsServerError() bool
  • func (o *FirstRunBadRequest) IsSuccess() bool
  • func (o *FirstRunBadRequest) String() string
• type FirstRunOK
  • func NewFirstRunOK() *FirstRunOK
  • func (o *FirstRunOK) Code() int
  • func (o *FirstRunOK) Error() string
  • func (o *FirstRunOK) GetPayload() garm_params.User
  • func (o *FirstRunOK) IsClientError() bool
  • func (o *FirstRunOK) IsCode(code int) bool
  • func (o *FirstRunOK) IsRedirect() bool
  • func (o *FirstRunOK) IsServerError() bool
  • func (o *FirstRunOK) IsSuccess() bool
  • func (o *FirstRunOK) String() string
• type FirstRunParams
  • func NewFirstRunParams() *FirstRunParams
  • func NewFirstRunParamsWithContext(ctx context.Context) *FirstRunParams
  • func NewFirstRunParamsWithHTTPClient(client *http.Client) *FirstRunParams
  • func NewFirstRunParamsWithTimeout(timeout time.Duration) *FirstRunParams
  • func (o *FirstRunParams) SetBody(body garm_params.NewUserParams)
  • func (o *FirstRunParams) SetContext(ctx context.Context)
  • func (o *FirstRunParams) SetDefaults()
  • func (o *FirstRunParams) SetHTTPClient(client *http.Client)
  • func (o *FirstRunParams) SetTimeout(timeout time.Duration)
  • func (o *FirstRunParams) WithBody(body garm_params.NewUserParams) *FirstRunParams
  • func (o *FirstRunParams) WithContext(ctx context.Context) *FirstRunParams
  • func (o *FirstRunParams) WithDefaults() *FirstRunParams
  • func (o *FirstRunParams) WithHTTPClient(client *http.Client) *FirstRunParams
  • func (o *FirstRunParams) WithTimeout(timeout time.Duration) *FirstRunParams
  • func (o *FirstRunParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
• type FirstRunReader
  • func (o *FirstRunReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

Types

type Client

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

Client for first run API

func (*Client) FirstRun

func (a *Client) FirstRun(params *FirstRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*FirstRunOK, error)

FirstRun initializes the first run of the controller

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 may be used to customize the behavior of Client methods.

type ClientService

type ClientService interface {
	FirstRun(params *FirstRunParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*FirstRunOK, 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 first run API client.

func NewClientWithBasicAuth

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

New creates a new first run 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 first run 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 FirstRunBadRequest

type FirstRunBadRequest struct {
	Payload apiserver_params.APIErrorResponse
}

FirstRunBadRequest describes a response with status code 400, with default header values.

APIErrorResponse

func NewFirstRunBadRequest

func NewFirstRunBadRequest() *FirstRunBadRequest

NewFirstRunBadRequest creates a FirstRunBadRequest with default headers values

func (*FirstRunBadRequest) Code

func (o *FirstRunBadRequest) Code() int

Code gets the status code for the first run bad request response

func (*FirstRunBadRequest) Error

func (o *FirstRunBadRequest) Error() string

func (*FirstRunBadRequest) GetPayload

func (o *FirstRunBadRequest) GetPayload() apiserver_params.APIErrorResponse

func (*FirstRunBadRequest) IsClientError

func (o *FirstRunBadRequest) IsClientError() bool

IsClientError returns true when this first run bad request response has a 4xx status code

func (*FirstRunBadRequest) IsCode

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

IsCode returns true when this first run bad request response a status code equal to that given

func (*FirstRunBadRequest) IsRedirect

func (o *FirstRunBadRequest) IsRedirect() bool

IsRedirect returns true when this first run bad request response has a 3xx status code

func (*FirstRunBadRequest) IsServerError

func (o *FirstRunBadRequest) IsServerError() bool

IsServerError returns true when this first run bad request response has a 5xx status code

func (*FirstRunBadRequest) IsSuccess

func (o *FirstRunBadRequest) IsSuccess() bool

IsSuccess returns true when this first run bad request response has a 2xx status code

func (*FirstRunBadRequest) String

func (o *FirstRunBadRequest) String() string

type FirstRunOK

type FirstRunOK struct {
	Payload garm_params.User
}

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

User

func NewFirstRunOK

func NewFirstRunOK() *FirstRunOK

NewFirstRunOK creates a FirstRunOK with default headers values

func (*FirstRunOK) Code

func (o *FirstRunOK) Code() int

Code gets the status code for the first run o k response

func (*FirstRunOK) Error

func (o *FirstRunOK) Error() string

func (*FirstRunOK) GetPayload

func (o *FirstRunOK) GetPayload() garm_params.User

func (*FirstRunOK) IsClientError

func (o *FirstRunOK) IsClientError() bool

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

func (*FirstRunOK) IsCode

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

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

func (*FirstRunOK) IsRedirect

func (o *FirstRunOK) IsRedirect() bool

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

func (*FirstRunOK) IsServerError

func (o *FirstRunOK) IsServerError() bool

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

func (*FirstRunOK) IsSuccess

func (o *FirstRunOK) IsSuccess() bool

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

func (*FirstRunOK) String

func (o *FirstRunOK) String() string

type FirstRunParams

type FirstRunParams struct {

	/* Body.

	   Create a new user.
	*/
	Body garm_params.NewUserParams

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

FirstRunParams contains all the parameters to send to the API endpoint

for the first run operation.

Typically these are written to a http.Request.

func NewFirstRunParams

func NewFirstRunParams() *FirstRunParams

NewFirstRunParams creates a new FirstRunParams 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 NewFirstRunParamsWithContext

func NewFirstRunParamsWithContext(ctx context.Context) *FirstRunParams

NewFirstRunParamsWithContext creates a new FirstRunParams object with the ability to set a context for a request.

func NewFirstRunParamsWithHTTPClient

func NewFirstRunParamsWithHTTPClient(client *http.Client) *FirstRunParams

NewFirstRunParamsWithHTTPClient creates a new FirstRunParams object with the ability to set a custom HTTPClient for a request.

func NewFirstRunParamsWithTimeout

func NewFirstRunParamsWithTimeout(timeout time.Duration) *FirstRunParams

NewFirstRunParamsWithTimeout creates a new FirstRunParams object with the ability to set a timeout on a request.

func (*FirstRunParams) SetBody

func (o *FirstRunParams) SetBody(body garm_params.NewUserParams)

SetBody adds the body to the first run params

func (*FirstRunParams) SetContext

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

SetContext adds the context to the first run params

func (*FirstRunParams) SetDefaults

func (o *FirstRunParams) SetDefaults()

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

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

func (*FirstRunParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the first run params

func (*FirstRunParams) SetTimeout

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

SetTimeout adds the timeout to the first run params

func (*FirstRunParams) WithBody

func (o *FirstRunParams) WithBody(body garm_params.NewUserParams) *FirstRunParams

WithBody adds the body to the first run params

func (*FirstRunParams) WithContext

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

WithContext adds the context to the first run params

func (*FirstRunParams) WithDefaults

func (o *FirstRunParams) WithDefaults() *FirstRunParams

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

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

func (*FirstRunParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the first run params

func (*FirstRunParams) WithTimeout

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

WithTimeout adds the timeout to the first run params

func (*FirstRunParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type FirstRunReader

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

FirstRunReader is a Reader for the FirstRun structure.

func (*FirstRunReader) ReadResponse

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

ReadResponse reads a server response into the received o.