Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type ListJobsBadRequest
- func (o *ListJobsBadRequest) Code() int
- func (o *ListJobsBadRequest) Error() string
- func (o *ListJobsBadRequest) GetPayload() apiserver_params.APIErrorResponse
- func (o *ListJobsBadRequest) IsClientError() bool
- func (o *ListJobsBadRequest) IsCode(code int) bool
- func (o *ListJobsBadRequest) IsRedirect() bool
- func (o *ListJobsBadRequest) IsServerError() bool
- func (o *ListJobsBadRequest) IsSuccess() bool
- func (o *ListJobsBadRequest) String() string
- type ListJobsOK
- func (o *ListJobsOK) Code() int
- func (o *ListJobsOK) Error() string
- func (o *ListJobsOK) GetPayload() garm_params.Jobs
- func (o *ListJobsOK) IsClientError() bool
- func (o *ListJobsOK) IsCode(code int) bool
- func (o *ListJobsOK) IsRedirect() bool
- func (o *ListJobsOK) IsServerError() bool
- func (o *ListJobsOK) IsSuccess() bool
- func (o *ListJobsOK) String() string
- type ListJobsParams
- func (o *ListJobsParams) SetContext(ctx context.Context)
- func (o *ListJobsParams) SetDefaults()
- func (o *ListJobsParams) SetHTTPClient(client *http.Client)
- func (o *ListJobsParams) SetTimeout(timeout time.Duration)
- func (o *ListJobsParams) WithContext(ctx context.Context) *ListJobsParams
- func (o *ListJobsParams) WithDefaults() *ListJobsParams
- func (o *ListJobsParams) WithHTTPClient(client *http.Client) *ListJobsParams
- func (o *ListJobsParams) WithTimeout(timeout time.Duration) *ListJobsParams
- func (o *ListJobsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type ListJobsReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for jobs API
func (*Client) ListJobs ¶
func (a *Client) ListJobs(params *ListJobsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListJobsOK, error)
ListJobs lists all jobs
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 { ListJobs(params *ListJobsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListJobsOK, 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 jobs API client.
func NewClientWithBasicAuth ¶ added in v0.1.5
func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService
New creates a new jobs 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 ¶ added in v0.1.5
func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService
New creates a new jobs 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 ListJobsBadRequest ¶
type ListJobsBadRequest struct {
Payload apiserver_params.APIErrorResponse
}
ListJobsBadRequest describes a response with status code 400, with default header values.
APIErrorResponse
func NewListJobsBadRequest ¶
func NewListJobsBadRequest() *ListJobsBadRequest
NewListJobsBadRequest creates a ListJobsBadRequest with default headers values
func (*ListJobsBadRequest) Code ¶
func (o *ListJobsBadRequest) Code() int
Code gets the status code for the list jobs bad request response
func (*ListJobsBadRequest) Error ¶
func (o *ListJobsBadRequest) Error() string
func (*ListJobsBadRequest) GetPayload ¶
func (o *ListJobsBadRequest) GetPayload() apiserver_params.APIErrorResponse
func (*ListJobsBadRequest) IsClientError ¶
func (o *ListJobsBadRequest) IsClientError() bool
IsClientError returns true when this list jobs bad request response has a 4xx status code
func (*ListJobsBadRequest) IsCode ¶
func (o *ListJobsBadRequest) IsCode(code int) bool
IsCode returns true when this list jobs bad request response a status code equal to that given
func (*ListJobsBadRequest) IsRedirect ¶
func (o *ListJobsBadRequest) IsRedirect() bool
IsRedirect returns true when this list jobs bad request response has a 3xx status code
func (*ListJobsBadRequest) IsServerError ¶
func (o *ListJobsBadRequest) IsServerError() bool
IsServerError returns true when this list jobs bad request response has a 5xx status code
func (*ListJobsBadRequest) IsSuccess ¶
func (o *ListJobsBadRequest) IsSuccess() bool
IsSuccess returns true when this list jobs bad request response has a 2xx status code
func (*ListJobsBadRequest) String ¶
func (o *ListJobsBadRequest) String() string
type ListJobsOK ¶
type ListJobsOK struct {
Payload garm_params.Jobs
}
ListJobsOK describes a response with status code 200, with default header values.
Jobs
func NewListJobsOK ¶
func NewListJobsOK() *ListJobsOK
NewListJobsOK creates a ListJobsOK with default headers values
func (*ListJobsOK) Code ¶
func (o *ListJobsOK) Code() int
Code gets the status code for the list jobs o k response
func (*ListJobsOK) Error ¶
func (o *ListJobsOK) Error() string
func (*ListJobsOK) GetPayload ¶
func (o *ListJobsOK) GetPayload() garm_params.Jobs
func (*ListJobsOK) IsClientError ¶
func (o *ListJobsOK) IsClientError() bool
IsClientError returns true when this list jobs o k response has a 4xx status code
func (*ListJobsOK) IsCode ¶
func (o *ListJobsOK) IsCode(code int) bool
IsCode returns true when this list jobs o k response a status code equal to that given
func (*ListJobsOK) IsRedirect ¶
func (o *ListJobsOK) IsRedirect() bool
IsRedirect returns true when this list jobs o k response has a 3xx status code
func (*ListJobsOK) IsServerError ¶
func (o *ListJobsOK) IsServerError() bool
IsServerError returns true when this list jobs o k response has a 5xx status code
func (*ListJobsOK) IsSuccess ¶
func (o *ListJobsOK) IsSuccess() bool
IsSuccess returns true when this list jobs o k response has a 2xx status code
func (*ListJobsOK) String ¶
func (o *ListJobsOK) String() string
type ListJobsParams ¶
type ListJobsParams struct { Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
ListJobsParams contains all the parameters to send to the API endpoint
for the list jobs operation. Typically these are written to a http.Request.
func NewListJobsParams ¶
func NewListJobsParams() *ListJobsParams
NewListJobsParams creates a new ListJobsParams 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 NewListJobsParamsWithContext ¶
func NewListJobsParamsWithContext(ctx context.Context) *ListJobsParams
NewListJobsParamsWithContext creates a new ListJobsParams object with the ability to set a context for a request.
func NewListJobsParamsWithHTTPClient ¶
func NewListJobsParamsWithHTTPClient(client *http.Client) *ListJobsParams
NewListJobsParamsWithHTTPClient creates a new ListJobsParams object with the ability to set a custom HTTPClient for a request.
func NewListJobsParamsWithTimeout ¶
func NewListJobsParamsWithTimeout(timeout time.Duration) *ListJobsParams
NewListJobsParamsWithTimeout creates a new ListJobsParams object with the ability to set a timeout on a request.
func (*ListJobsParams) SetContext ¶
func (o *ListJobsParams) SetContext(ctx context.Context)
SetContext adds the context to the list jobs params
func (*ListJobsParams) SetDefaults ¶
func (o *ListJobsParams) SetDefaults()
SetDefaults hydrates default values in the list jobs params (not the query body).
All values with no default are reset to their zero value.
func (*ListJobsParams) SetHTTPClient ¶
func (o *ListJobsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the list jobs params
func (*ListJobsParams) SetTimeout ¶
func (o *ListJobsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the list jobs params
func (*ListJobsParams) WithContext ¶
func (o *ListJobsParams) WithContext(ctx context.Context) *ListJobsParams
WithContext adds the context to the list jobs params
func (*ListJobsParams) WithDefaults ¶
func (o *ListJobsParams) WithDefaults() *ListJobsParams
WithDefaults hydrates default values in the list jobs params (not the query body).
All values with no default are reset to their zero value.
func (*ListJobsParams) WithHTTPClient ¶
func (o *ListJobsParams) WithHTTPClient(client *http.Client) *ListJobsParams
WithHTTPClient adds the HTTPClient to the list jobs params
func (*ListJobsParams) WithTimeout ¶
func (o *ListJobsParams) WithTimeout(timeout time.Duration) *ListJobsParams
WithTimeout adds the timeout to the list jobs params
func (*ListJobsParams) WriteToRequest ¶
func (o *ListJobsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type ListJobsReader ¶
type ListJobsReader struct {
// contains filtered or unexported fields
}
ListJobsReader is a Reader for the ListJobs structure.
func (*ListJobsReader) ReadResponse ¶
func (o *ListJobsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.