Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type GetV1SchedulesOK
- func (o *GetV1SchedulesOK) Error() string
- func (o *GetV1SchedulesOK) GetPayload() *models.ScheduleEntityPaginated
- func (o *GetV1SchedulesOK) IsClientError() bool
- func (o *GetV1SchedulesOK) IsCode(code int) bool
- func (o *GetV1SchedulesOK) IsRedirect() bool
- func (o *GetV1SchedulesOK) IsServerError() bool
- func (o *GetV1SchedulesOK) IsSuccess() bool
- func (o *GetV1SchedulesOK) String() string
- type GetV1SchedulesParams
- func NewGetV1SchedulesParams() *GetV1SchedulesParams
- func NewGetV1SchedulesParamsWithContext(ctx context.Context) *GetV1SchedulesParams
- func NewGetV1SchedulesParamsWithHTTPClient(client *http.Client) *GetV1SchedulesParams
- func NewGetV1SchedulesParamsWithTimeout(timeout time.Duration) *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) SetContext(ctx context.Context)
- func (o *GetV1SchedulesParams) SetDefaults()
- func (o *GetV1SchedulesParams) SetHTTPClient(client *http.Client)
- func (o *GetV1SchedulesParams) SetPage(page *int32)
- func (o *GetV1SchedulesParams) SetPerPage(perPage *int32)
- func (o *GetV1SchedulesParams) SetQuery(query *string)
- func (o *GetV1SchedulesParams) SetTimeout(timeout time.Duration)
- func (o *GetV1SchedulesParams) WithContext(ctx context.Context) *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) WithDefaults() *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) WithHTTPClient(client *http.Client) *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) WithPage(page *int32) *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) WithPerPage(perPage *int32) *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) WithQuery(query *string) *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) WithTimeout(timeout time.Duration) *GetV1SchedulesParams
- func (o *GetV1SchedulesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetV1SchedulesReader
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 schedules API
func (*Client) GetV1Schedules ¶
func (a *Client) GetV1Schedules(params *GetV1SchedulesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1SchedulesOK, error)
GetV1Schedules lists all schedules
List all known schedules in FireHydrant as pulled from external sources
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 {
GetV1Schedules(params *GetV1SchedulesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetV1SchedulesOK, 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 schedules API client.
type GetV1SchedulesOK ¶
type GetV1SchedulesOK struct {
Payload *models.ScheduleEntityPaginated
}
GetV1SchedulesOK describes a response with status code 200, with default header values.
List all known schedules in FireHydrant as pulled from external sources
func NewGetV1SchedulesOK ¶
func NewGetV1SchedulesOK() *GetV1SchedulesOK
NewGetV1SchedulesOK creates a GetV1SchedulesOK with default headers values
func (*GetV1SchedulesOK) Error ¶
func (o *GetV1SchedulesOK) Error() string
func (*GetV1SchedulesOK) GetPayload ¶
func (o *GetV1SchedulesOK) GetPayload() *models.ScheduleEntityPaginated
func (*GetV1SchedulesOK) IsClientError ¶
func (o *GetV1SchedulesOK) IsClientError() bool
IsClientError returns true when this get v1 schedules o k response has a 4xx status code
func (*GetV1SchedulesOK) IsCode ¶
func (o *GetV1SchedulesOK) IsCode(code int) bool
IsCode returns true when this get v1 schedules o k response a status code equal to that given
func (*GetV1SchedulesOK) IsRedirect ¶
func (o *GetV1SchedulesOK) IsRedirect() bool
IsRedirect returns true when this get v1 schedules o k response has a 3xx status code
func (*GetV1SchedulesOK) IsServerError ¶
func (o *GetV1SchedulesOK) IsServerError() bool
IsServerError returns true when this get v1 schedules o k response has a 5xx status code
func (*GetV1SchedulesOK) IsSuccess ¶
func (o *GetV1SchedulesOK) IsSuccess() bool
IsSuccess returns true when this get v1 schedules o k response has a 2xx status code
func (*GetV1SchedulesOK) String ¶
func (o *GetV1SchedulesOK) String() string
type GetV1SchedulesParams ¶
type GetV1SchedulesParams struct {
// Page.
//
// Format: int32
Page *int32
// PerPage.
//
// Format: int32
PerPage *int32
/* Query.
Filter schedules with a query on their name
*/
Query *string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetV1SchedulesParams contains all the parameters to send to the API endpoint
for the get v1 schedules operation. Typically these are written to a http.Request.
func NewGetV1SchedulesParams ¶
func NewGetV1SchedulesParams() *GetV1SchedulesParams
NewGetV1SchedulesParams creates a new GetV1SchedulesParams 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 NewGetV1SchedulesParamsWithContext ¶
func NewGetV1SchedulesParamsWithContext(ctx context.Context) *GetV1SchedulesParams
NewGetV1SchedulesParamsWithContext creates a new GetV1SchedulesParams object with the ability to set a context for a request.
func NewGetV1SchedulesParamsWithHTTPClient ¶
func NewGetV1SchedulesParamsWithHTTPClient(client *http.Client) *GetV1SchedulesParams
NewGetV1SchedulesParamsWithHTTPClient creates a new GetV1SchedulesParams object with the ability to set a custom HTTPClient for a request.
func NewGetV1SchedulesParamsWithTimeout ¶
func NewGetV1SchedulesParamsWithTimeout(timeout time.Duration) *GetV1SchedulesParams
NewGetV1SchedulesParamsWithTimeout creates a new GetV1SchedulesParams object with the ability to set a timeout on a request.
func (*GetV1SchedulesParams) SetContext ¶
func (o *GetV1SchedulesParams) SetContext(ctx context.Context)
SetContext adds the context to the get v1 schedules params
func (*GetV1SchedulesParams) SetDefaults ¶
func (o *GetV1SchedulesParams) SetDefaults()
SetDefaults hydrates default values in the get v1 schedules params (not the query body).
All values with no default are reset to their zero value.
func (*GetV1SchedulesParams) SetHTTPClient ¶
func (o *GetV1SchedulesParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get v1 schedules params
func (*GetV1SchedulesParams) SetPage ¶
func (o *GetV1SchedulesParams) SetPage(page *int32)
SetPage adds the page to the get v1 schedules params
func (*GetV1SchedulesParams) SetPerPage ¶
func (o *GetV1SchedulesParams) SetPerPage(perPage *int32)
SetPerPage adds the perPage to the get v1 schedules params
func (*GetV1SchedulesParams) SetQuery ¶
func (o *GetV1SchedulesParams) SetQuery(query *string)
SetQuery adds the query to the get v1 schedules params
func (*GetV1SchedulesParams) SetTimeout ¶
func (o *GetV1SchedulesParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get v1 schedules params
func (*GetV1SchedulesParams) WithContext ¶
func (o *GetV1SchedulesParams) WithContext(ctx context.Context) *GetV1SchedulesParams
WithContext adds the context to the get v1 schedules params
func (*GetV1SchedulesParams) WithDefaults ¶
func (o *GetV1SchedulesParams) WithDefaults() *GetV1SchedulesParams
WithDefaults hydrates default values in the get v1 schedules params (not the query body).
All values with no default are reset to their zero value.
func (*GetV1SchedulesParams) WithHTTPClient ¶
func (o *GetV1SchedulesParams) WithHTTPClient(client *http.Client) *GetV1SchedulesParams
WithHTTPClient adds the HTTPClient to the get v1 schedules params
func (*GetV1SchedulesParams) WithPage ¶
func (o *GetV1SchedulesParams) WithPage(page *int32) *GetV1SchedulesParams
WithPage adds the page to the get v1 schedules params
func (*GetV1SchedulesParams) WithPerPage ¶
func (o *GetV1SchedulesParams) WithPerPage(perPage *int32) *GetV1SchedulesParams
WithPerPage adds the perPage to the get v1 schedules params
func (*GetV1SchedulesParams) WithQuery ¶
func (o *GetV1SchedulesParams) WithQuery(query *string) *GetV1SchedulesParams
WithQuery adds the query to the get v1 schedules params
func (*GetV1SchedulesParams) WithTimeout ¶
func (o *GetV1SchedulesParams) WithTimeout(timeout time.Duration) *GetV1SchedulesParams
WithTimeout adds the timeout to the get v1 schedules params
func (*GetV1SchedulesParams) WriteToRequest ¶
func (o *GetV1SchedulesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetV1SchedulesReader ¶
type GetV1SchedulesReader struct {
// contains filtered or unexported fields
}
GetV1SchedulesReader is a Reader for the GetV1Schedules structure.
func (*GetV1SchedulesReader) ReadResponse ¶
func (o *GetV1SchedulesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.