Documentation
¶
Index ¶
- type Client
- type ClientService
- type GetEventNotFound
- type GetEventOK
- type GetEventParams
- func (o *GetEventParams) SetContext(ctx context.Context)
- func (o *GetEventParams) SetDefaults()
- func (o *GetEventParams) SetHTTPClient(client *http.Client)
- func (o *GetEventParams) SetID(id string)
- func (o *GetEventParams) SetTimeout(timeout time.Duration)
- func (o *GetEventParams) WithContext(ctx context.Context) *GetEventParams
- func (o *GetEventParams) WithDefaults() *GetEventParams
- func (o *GetEventParams) WithHTTPClient(client *http.Client) *GetEventParams
- func (o *GetEventParams) WithID(id string) *GetEventParams
- func (o *GetEventParams) WithTimeout(timeout time.Duration) *GetEventParams
- func (o *GetEventParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetEventReader
- type GetEventsNotFound
- type GetEventsOK
- type GetEventsParams
- func (o *GetEventsParams) SetContext(ctx context.Context)
- func (o *GetEventsParams) SetDefaults()
- func (o *GetEventsParams) SetEndingBefore(endingBefore *string)
- func (o *GetEventsParams) SetHTTPClient(client *http.Client)
- func (o *GetEventsParams) SetLimit(limit *int64)
- func (o *GetEventsParams) SetRecordType(recordType []string)
- func (o *GetEventsParams) SetSchool(school *string)
- func (o *GetEventsParams) SetStartingAfter(startingAfter *string)
- func (o *GetEventsParams) SetTimeout(timeout time.Duration)
- func (o *GetEventsParams) WithContext(ctx context.Context) *GetEventsParams
- func (o *GetEventsParams) WithDefaults() *GetEventsParams
- func (o *GetEventsParams) WithEndingBefore(endingBefore *string) *GetEventsParams
- func (o *GetEventsParams) WithHTTPClient(client *http.Client) *GetEventsParams
- func (o *GetEventsParams) WithLimit(limit *int64) *GetEventsParams
- func (o *GetEventsParams) WithRecordType(recordType []string) *GetEventsParams
- func (o *GetEventsParams) WithSchool(school *string) *GetEventsParams
- func (o *GetEventsParams) WithStartingAfter(startingAfter *string) *GetEventsParams
- func (o *GetEventsParams) WithTimeout(timeout time.Duration) *GetEventsParams
- func (o *GetEventsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type GetEventsReader
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 events API
func (*Client) GetEvent ¶
func (a *Client) GetEvent(params *GetEventParams, authInfo runtime.ClientAuthInfoWriter) (*GetEventOK, error)
GetEvent Returns the specific event
func (*Client) GetEvents ¶
func (a *Client) GetEvents(params *GetEventsParams, authInfo runtime.ClientAuthInfoWriter) (*GetEventsOK, error)
GetEvents Returns a list of events
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
type ClientService ¶
type ClientService interface {
GetEvent(params *GetEventParams, authInfo runtime.ClientAuthInfoWriter) (*GetEventOK, error)
GetEvents(params *GetEventsParams, authInfo runtime.ClientAuthInfoWriter) (*GetEventsOK, 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 events API client.
type GetEventNotFound ¶
GetEventNotFound describes a response with status code 404, with default header values.
Entity Not Found
func NewGetEventNotFound ¶
func NewGetEventNotFound() *GetEventNotFound
NewGetEventNotFound creates a GetEventNotFound with default headers values
func (*GetEventNotFound) Error ¶
func (o *GetEventNotFound) Error() string
func (*GetEventNotFound) GetPayload ¶
func (o *GetEventNotFound) GetPayload() *models.NotFound
type GetEventOK ¶
type GetEventOK struct {
Payload *models.EventResponse
}
GetEventOK describes a response with status code 200, with default header values.
OK Response
func NewGetEventOK ¶
func NewGetEventOK() *GetEventOK
NewGetEventOK creates a GetEventOK with default headers values
func (*GetEventOK) Error ¶
func (o *GetEventOK) Error() string
func (*GetEventOK) GetPayload ¶
func (o *GetEventOK) GetPayload() *models.EventResponse
type GetEventParams ¶
type GetEventParams struct {
// ID.
ID string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetEventParams contains all the parameters to send to the API endpoint
for the get event operation. Typically these are written to a http.Request.
func NewGetEventParams ¶
func NewGetEventParams() *GetEventParams
NewGetEventParams creates a new GetEventParams 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 NewGetEventParamsWithContext ¶
func NewGetEventParamsWithContext(ctx context.Context) *GetEventParams
NewGetEventParamsWithContext creates a new GetEventParams object with the ability to set a context for a request.
func NewGetEventParamsWithHTTPClient ¶
func NewGetEventParamsWithHTTPClient(client *http.Client) *GetEventParams
NewGetEventParamsWithHTTPClient creates a new GetEventParams object with the ability to set a custom HTTPClient for a request.
func NewGetEventParamsWithTimeout ¶
func NewGetEventParamsWithTimeout(timeout time.Duration) *GetEventParams
NewGetEventParamsWithTimeout creates a new GetEventParams object with the ability to set a timeout on a request.
func (*GetEventParams) SetContext ¶
func (o *GetEventParams) SetContext(ctx context.Context)
SetContext adds the context to the get event params
func (*GetEventParams) SetDefaults ¶
func (o *GetEventParams) SetDefaults()
SetDefaults hydrates default values in the get event params (not the query body).
All values with no default are reset to their zero value.
func (*GetEventParams) SetHTTPClient ¶
func (o *GetEventParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get event params
func (*GetEventParams) SetID ¶
func (o *GetEventParams) SetID(id string)
SetID adds the id to the get event params
func (*GetEventParams) SetTimeout ¶
func (o *GetEventParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get event params
func (*GetEventParams) WithContext ¶
func (o *GetEventParams) WithContext(ctx context.Context) *GetEventParams
WithContext adds the context to the get event params
func (*GetEventParams) WithDefaults ¶
func (o *GetEventParams) WithDefaults() *GetEventParams
WithDefaults hydrates default values in the get event params (not the query body).
All values with no default are reset to their zero value.
func (*GetEventParams) WithHTTPClient ¶
func (o *GetEventParams) WithHTTPClient(client *http.Client) *GetEventParams
WithHTTPClient adds the HTTPClient to the get event params
func (*GetEventParams) WithID ¶
func (o *GetEventParams) WithID(id string) *GetEventParams
WithID adds the id to the get event params
func (*GetEventParams) WithTimeout ¶
func (o *GetEventParams) WithTimeout(timeout time.Duration) *GetEventParams
WithTimeout adds the timeout to the get event params
func (*GetEventParams) WriteToRequest ¶
func (o *GetEventParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetEventReader ¶
type GetEventReader struct {
// contains filtered or unexported fields
}
GetEventReader is a Reader for the GetEvent structure.
func (*GetEventReader) ReadResponse ¶
func (o *GetEventReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type GetEventsNotFound ¶
GetEventsNotFound describes a response with status code 404, with default header values.
Entity Not Found
func NewGetEventsNotFound ¶
func NewGetEventsNotFound() *GetEventsNotFound
NewGetEventsNotFound creates a GetEventsNotFound with default headers values
func (*GetEventsNotFound) Error ¶
func (o *GetEventsNotFound) Error() string
func (*GetEventsNotFound) GetPayload ¶
func (o *GetEventsNotFound) GetPayload() *models.NotFound
type GetEventsOK ¶
type GetEventsOK struct {
Payload *models.EventsResponse
}
GetEventsOK describes a response with status code 200, with default header values.
OK Response
func NewGetEventsOK ¶
func NewGetEventsOK() *GetEventsOK
NewGetEventsOK creates a GetEventsOK with default headers values
func (*GetEventsOK) Error ¶
func (o *GetEventsOK) Error() string
func (*GetEventsOK) GetPayload ¶
func (o *GetEventsOK) GetPayload() *models.EventsResponse
type GetEventsParams ¶
type GetEventsParams struct {
// EndingBefore.
EndingBefore *string
// Limit.
Limit *int64
// RecordType.
RecordType []string
// School.
School *string
// StartingAfter.
StartingAfter *string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
GetEventsParams contains all the parameters to send to the API endpoint
for the get events operation. Typically these are written to a http.Request.
func NewGetEventsParams ¶
func NewGetEventsParams() *GetEventsParams
NewGetEventsParams creates a new GetEventsParams 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 NewGetEventsParamsWithContext ¶
func NewGetEventsParamsWithContext(ctx context.Context) *GetEventsParams
NewGetEventsParamsWithContext creates a new GetEventsParams object with the ability to set a context for a request.
func NewGetEventsParamsWithHTTPClient ¶
func NewGetEventsParamsWithHTTPClient(client *http.Client) *GetEventsParams
NewGetEventsParamsWithHTTPClient creates a new GetEventsParams object with the ability to set a custom HTTPClient for a request.
func NewGetEventsParamsWithTimeout ¶
func NewGetEventsParamsWithTimeout(timeout time.Duration) *GetEventsParams
NewGetEventsParamsWithTimeout creates a new GetEventsParams object with the ability to set a timeout on a request.
func (*GetEventsParams) SetContext ¶
func (o *GetEventsParams) SetContext(ctx context.Context)
SetContext adds the context to the get events params
func (*GetEventsParams) SetDefaults ¶
func (o *GetEventsParams) SetDefaults()
SetDefaults hydrates default values in the get events params (not the query body).
All values with no default are reset to their zero value.
func (*GetEventsParams) SetEndingBefore ¶
func (o *GetEventsParams) SetEndingBefore(endingBefore *string)
SetEndingBefore adds the endingBefore to the get events params
func (*GetEventsParams) SetHTTPClient ¶
func (o *GetEventsParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the get events params
func (*GetEventsParams) SetLimit ¶
func (o *GetEventsParams) SetLimit(limit *int64)
SetLimit adds the limit to the get events params
func (*GetEventsParams) SetRecordType ¶
func (o *GetEventsParams) SetRecordType(recordType []string)
SetRecordType adds the recordType to the get events params
func (*GetEventsParams) SetSchool ¶
func (o *GetEventsParams) SetSchool(school *string)
SetSchool adds the school to the get events params
func (*GetEventsParams) SetStartingAfter ¶
func (o *GetEventsParams) SetStartingAfter(startingAfter *string)
SetStartingAfter adds the startingAfter to the get events params
func (*GetEventsParams) SetTimeout ¶
func (o *GetEventsParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the get events params
func (*GetEventsParams) WithContext ¶
func (o *GetEventsParams) WithContext(ctx context.Context) *GetEventsParams
WithContext adds the context to the get events params
func (*GetEventsParams) WithDefaults ¶
func (o *GetEventsParams) WithDefaults() *GetEventsParams
WithDefaults hydrates default values in the get events params (not the query body).
All values with no default are reset to their zero value.
func (*GetEventsParams) WithEndingBefore ¶
func (o *GetEventsParams) WithEndingBefore(endingBefore *string) *GetEventsParams
WithEndingBefore adds the endingBefore to the get events params
func (*GetEventsParams) WithHTTPClient ¶
func (o *GetEventsParams) WithHTTPClient(client *http.Client) *GetEventsParams
WithHTTPClient adds the HTTPClient to the get events params
func (*GetEventsParams) WithLimit ¶
func (o *GetEventsParams) WithLimit(limit *int64) *GetEventsParams
WithLimit adds the limit to the get events params
func (*GetEventsParams) WithRecordType ¶
func (o *GetEventsParams) WithRecordType(recordType []string) *GetEventsParams
WithRecordType adds the recordType to the get events params
func (*GetEventsParams) WithSchool ¶
func (o *GetEventsParams) WithSchool(school *string) *GetEventsParams
WithSchool adds the school to the get events params
func (*GetEventsParams) WithStartingAfter ¶
func (o *GetEventsParams) WithStartingAfter(startingAfter *string) *GetEventsParams
WithStartingAfter adds the startingAfter to the get events params
func (*GetEventsParams) WithTimeout ¶
func (o *GetEventsParams) WithTimeout(timeout time.Duration) *GetEventsParams
WithTimeout adds the timeout to the get events params
func (*GetEventsParams) WriteToRequest ¶
func (o *GetEventsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type GetEventsReader ¶
type GetEventsReader struct {
// contains filtered or unexported fields
}
GetEventsReader is a Reader for the GetEvents structure.
func (*GetEventsReader) ReadResponse ¶
func (o *GetEventsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.