Documentation
¶
Index ¶
- type AnnouncementGetBadRequest
- type AnnouncementGetNotFound
- type AnnouncementGetOK
- type AnnouncementGetParams
- func NewAnnouncementGetParams() *AnnouncementGetParams
- func NewAnnouncementGetParamsWithContext(ctx context.Context) *AnnouncementGetParams
- func NewAnnouncementGetParamsWithHTTPClient(client *http.Client) *AnnouncementGetParams
- func NewAnnouncementGetParamsWithTimeout(timeout time.Duration) *AnnouncementGetParams
- func (o *AnnouncementGetParams) SetColumns(columns *string)
- func (o *AnnouncementGetParams) SetContext(ctx context.Context)
- func (o *AnnouncementGetParams) SetHTTPClient(client *http.Client)
- func (o *AnnouncementGetParams) SetTimeout(timeout time.Duration)
- func (o *AnnouncementGetParams) WithColumns(columns *string) *AnnouncementGetParams
- func (o *AnnouncementGetParams) WithContext(ctx context.Context) *AnnouncementGetParams
- func (o *AnnouncementGetParams) WithHTTPClient(client *http.Client) *AnnouncementGetParams
- func (o *AnnouncementGetParams) WithTimeout(timeout time.Duration) *AnnouncementGetParams
- func (o *AnnouncementGetParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AnnouncementGetReader
- type AnnouncementGetUnauthorized
- type AnnouncementGetUrgentBadRequest
- type AnnouncementGetUrgentNotFound
- type AnnouncementGetUrgentOK
- type AnnouncementGetUrgentParams
- func NewAnnouncementGetUrgentParams() *AnnouncementGetUrgentParams
- func NewAnnouncementGetUrgentParamsWithContext(ctx context.Context) *AnnouncementGetUrgentParams
- func NewAnnouncementGetUrgentParamsWithHTTPClient(client *http.Client) *AnnouncementGetUrgentParams
- func NewAnnouncementGetUrgentParamsWithTimeout(timeout time.Duration) *AnnouncementGetUrgentParams
- func (o *AnnouncementGetUrgentParams) SetContext(ctx context.Context)
- func (o *AnnouncementGetUrgentParams) SetHTTPClient(client *http.Client)
- func (o *AnnouncementGetUrgentParams) SetTimeout(timeout time.Duration)
- func (o *AnnouncementGetUrgentParams) WithContext(ctx context.Context) *AnnouncementGetUrgentParams
- func (o *AnnouncementGetUrgentParams) WithHTTPClient(client *http.Client) *AnnouncementGetUrgentParams
- func (o *AnnouncementGetUrgentParams) WithTimeout(timeout time.Duration) *AnnouncementGetUrgentParams
- func (o *AnnouncementGetUrgentParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AnnouncementGetUrgentReader
- type AnnouncementGetUrgentUnauthorized
- type Client
- func (a *Client) AnnouncementGet(params *AnnouncementGetParams) (*AnnouncementGetOK, error)
- func (a *Client) AnnouncementGetUrgent(params *AnnouncementGetUrgentParams, authInfo runtime.ClientAuthInfoWriter) (*AnnouncementGetUrgentOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnnouncementGetBadRequest ¶
AnnouncementGetBadRequest handles this case with default header values.
Parameter Error
func NewAnnouncementGetBadRequest ¶
func NewAnnouncementGetBadRequest() *AnnouncementGetBadRequest
NewAnnouncementGetBadRequest creates a AnnouncementGetBadRequest with default headers values
func (*AnnouncementGetBadRequest) Error ¶
func (o *AnnouncementGetBadRequest) Error() string
type AnnouncementGetNotFound ¶
AnnouncementGetNotFound handles this case with default header values.
Not Found
func NewAnnouncementGetNotFound ¶
func NewAnnouncementGetNotFound() *AnnouncementGetNotFound
NewAnnouncementGetNotFound creates a AnnouncementGetNotFound with default headers values
func (*AnnouncementGetNotFound) Error ¶
func (o *AnnouncementGetNotFound) Error() string
type AnnouncementGetOK ¶
type AnnouncementGetOK struct {
Payload []*models.Announcement
}
AnnouncementGetOK handles this case with default header values.
Request was successful
func NewAnnouncementGetOK ¶
func NewAnnouncementGetOK() *AnnouncementGetOK
NewAnnouncementGetOK creates a AnnouncementGetOK with default headers values
func (*AnnouncementGetOK) Error ¶
func (o *AnnouncementGetOK) Error() string
type AnnouncementGetParams ¶
type AnnouncementGetParams struct {
/*Columns
Array of column names to fetch. If omitted, will return all columns.
*/
Columns *string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
AnnouncementGetParams contains all the parameters to send to the API endpoint for the announcement get operation typically these are written to a http.Request
func NewAnnouncementGetParams ¶
func NewAnnouncementGetParams() *AnnouncementGetParams
NewAnnouncementGetParams creates a new AnnouncementGetParams object with the default values initialized.
func NewAnnouncementGetParamsWithContext ¶
func NewAnnouncementGetParamsWithContext(ctx context.Context) *AnnouncementGetParams
NewAnnouncementGetParamsWithContext creates a new AnnouncementGetParams object with the default values initialized, and the ability to set a context for a request
func NewAnnouncementGetParamsWithHTTPClient ¶
func NewAnnouncementGetParamsWithHTTPClient(client *http.Client) *AnnouncementGetParams
NewAnnouncementGetParamsWithHTTPClient creates a new AnnouncementGetParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewAnnouncementGetParamsWithTimeout ¶
func NewAnnouncementGetParamsWithTimeout(timeout time.Duration) *AnnouncementGetParams
NewAnnouncementGetParamsWithTimeout creates a new AnnouncementGetParams object with the default values initialized, and the ability to set a timeout on a request
func (*AnnouncementGetParams) SetColumns ¶
func (o *AnnouncementGetParams) SetColumns(columns *string)
SetColumns adds the columns to the announcement get params
func (*AnnouncementGetParams) SetContext ¶
func (o *AnnouncementGetParams) SetContext(ctx context.Context)
SetContext adds the context to the announcement get params
func (*AnnouncementGetParams) SetHTTPClient ¶
func (o *AnnouncementGetParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the announcement get params
func (*AnnouncementGetParams) SetTimeout ¶
func (o *AnnouncementGetParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the announcement get params
func (*AnnouncementGetParams) WithColumns ¶
func (o *AnnouncementGetParams) WithColumns(columns *string) *AnnouncementGetParams
WithColumns adds the columns to the announcement get params
func (*AnnouncementGetParams) WithContext ¶
func (o *AnnouncementGetParams) WithContext(ctx context.Context) *AnnouncementGetParams
WithContext adds the context to the announcement get params
func (*AnnouncementGetParams) WithHTTPClient ¶
func (o *AnnouncementGetParams) WithHTTPClient(client *http.Client) *AnnouncementGetParams
WithHTTPClient adds the HTTPClient to the announcement get params
func (*AnnouncementGetParams) WithTimeout ¶
func (o *AnnouncementGetParams) WithTimeout(timeout time.Duration) *AnnouncementGetParams
WithTimeout adds the timeout to the announcement get params
func (*AnnouncementGetParams) WriteToRequest ¶
func (o *AnnouncementGetParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type AnnouncementGetReader ¶
type AnnouncementGetReader struct {
// contains filtered or unexported fields
}
AnnouncementGetReader is a Reader for the AnnouncementGet structure.
func (*AnnouncementGetReader) ReadResponse ¶
func (o *AnnouncementGetReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type AnnouncementGetUnauthorized ¶
type AnnouncementGetUnauthorized struct {
}
AnnouncementGetUnauthorized handles this case with default header values.
Unauthorized
func NewAnnouncementGetUnauthorized ¶
func NewAnnouncementGetUnauthorized() *AnnouncementGetUnauthorized
NewAnnouncementGetUnauthorized creates a AnnouncementGetUnauthorized with default headers values
func (*AnnouncementGetUnauthorized) Error ¶
func (o *AnnouncementGetUnauthorized) Error() string
type AnnouncementGetUrgentBadRequest ¶
AnnouncementGetUrgentBadRequest handles this case with default header values.
Parameter Error
func NewAnnouncementGetUrgentBadRequest ¶
func NewAnnouncementGetUrgentBadRequest() *AnnouncementGetUrgentBadRequest
NewAnnouncementGetUrgentBadRequest creates a AnnouncementGetUrgentBadRequest with default headers values
func (*AnnouncementGetUrgentBadRequest) Error ¶
func (o *AnnouncementGetUrgentBadRequest) Error() string
type AnnouncementGetUrgentNotFound ¶
AnnouncementGetUrgentNotFound handles this case with default header values.
Not Found
func NewAnnouncementGetUrgentNotFound ¶
func NewAnnouncementGetUrgentNotFound() *AnnouncementGetUrgentNotFound
NewAnnouncementGetUrgentNotFound creates a AnnouncementGetUrgentNotFound with default headers values
func (*AnnouncementGetUrgentNotFound) Error ¶
func (o *AnnouncementGetUrgentNotFound) Error() string
type AnnouncementGetUrgentOK ¶
type AnnouncementGetUrgentOK struct {
Payload []*models.Announcement
}
AnnouncementGetUrgentOK handles this case with default header values.
Request was successful
func NewAnnouncementGetUrgentOK ¶
func NewAnnouncementGetUrgentOK() *AnnouncementGetUrgentOK
NewAnnouncementGetUrgentOK creates a AnnouncementGetUrgentOK with default headers values
func (*AnnouncementGetUrgentOK) Error ¶
func (o *AnnouncementGetUrgentOK) Error() string
type AnnouncementGetUrgentParams ¶
type AnnouncementGetUrgentParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
AnnouncementGetUrgentParams contains all the parameters to send to the API endpoint for the announcement get urgent operation typically these are written to a http.Request
func NewAnnouncementGetUrgentParams ¶
func NewAnnouncementGetUrgentParams() *AnnouncementGetUrgentParams
NewAnnouncementGetUrgentParams creates a new AnnouncementGetUrgentParams object with the default values initialized.
func NewAnnouncementGetUrgentParamsWithContext ¶
func NewAnnouncementGetUrgentParamsWithContext(ctx context.Context) *AnnouncementGetUrgentParams
NewAnnouncementGetUrgentParamsWithContext creates a new AnnouncementGetUrgentParams object with the default values initialized, and the ability to set a context for a request
func NewAnnouncementGetUrgentParamsWithHTTPClient ¶
func NewAnnouncementGetUrgentParamsWithHTTPClient(client *http.Client) *AnnouncementGetUrgentParams
NewAnnouncementGetUrgentParamsWithHTTPClient creates a new AnnouncementGetUrgentParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewAnnouncementGetUrgentParamsWithTimeout ¶
func NewAnnouncementGetUrgentParamsWithTimeout(timeout time.Duration) *AnnouncementGetUrgentParams
NewAnnouncementGetUrgentParamsWithTimeout creates a new AnnouncementGetUrgentParams object with the default values initialized, and the ability to set a timeout on a request
func (*AnnouncementGetUrgentParams) SetContext ¶
func (o *AnnouncementGetUrgentParams) SetContext(ctx context.Context)
SetContext adds the context to the announcement get urgent params
func (*AnnouncementGetUrgentParams) SetHTTPClient ¶
func (o *AnnouncementGetUrgentParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the announcement get urgent params
func (*AnnouncementGetUrgentParams) SetTimeout ¶
func (o *AnnouncementGetUrgentParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the announcement get urgent params
func (*AnnouncementGetUrgentParams) WithContext ¶
func (o *AnnouncementGetUrgentParams) WithContext(ctx context.Context) *AnnouncementGetUrgentParams
WithContext adds the context to the announcement get urgent params
func (*AnnouncementGetUrgentParams) WithHTTPClient ¶
func (o *AnnouncementGetUrgentParams) WithHTTPClient(client *http.Client) *AnnouncementGetUrgentParams
WithHTTPClient adds the HTTPClient to the announcement get urgent params
func (*AnnouncementGetUrgentParams) WithTimeout ¶
func (o *AnnouncementGetUrgentParams) WithTimeout(timeout time.Duration) *AnnouncementGetUrgentParams
WithTimeout adds the timeout to the announcement get urgent params
func (*AnnouncementGetUrgentParams) WriteToRequest ¶
func (o *AnnouncementGetUrgentParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type AnnouncementGetUrgentReader ¶
type AnnouncementGetUrgentReader struct {
// contains filtered or unexported fields
}
AnnouncementGetUrgentReader is a Reader for the AnnouncementGetUrgent structure.
func (*AnnouncementGetUrgentReader) ReadResponse ¶
func (o *AnnouncementGetUrgentReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type AnnouncementGetUrgentUnauthorized ¶
type AnnouncementGetUrgentUnauthorized struct {
}
AnnouncementGetUrgentUnauthorized handles this case with default header values.
Unauthorized
func NewAnnouncementGetUrgentUnauthorized ¶
func NewAnnouncementGetUrgentUnauthorized() *AnnouncementGetUrgentUnauthorized
NewAnnouncementGetUrgentUnauthorized creates a AnnouncementGetUrgentUnauthorized with default headers values
func (*AnnouncementGetUrgentUnauthorized) Error ¶
func (o *AnnouncementGetUrgentUnauthorized) Error() string
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for announcement API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new announcement API client.
func (*Client) AnnouncementGet ¶
func (a *Client) AnnouncementGet(params *AnnouncementGetParams) (*AnnouncementGetOK, error)
AnnouncementGet gets site announcements
func (*Client) AnnouncementGetUrgent ¶
func (a *Client) AnnouncementGetUrgent(params *AnnouncementGetUrgentParams, authInfo runtime.ClientAuthInfoWriter) (*AnnouncementGetUrgentOK, error)
AnnouncementGetUrgent gets urgent banner announcements
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
Source Files