Documentation
¶
Index ¶
- func WithAcceptApplicationJSON(r *runtime.ClientOperation)
- func WithAcceptApplicationXML(r *runtime.ClientOperation)
- func WithAcceptTextJSON(r *runtime.ClientOperation)
- func WithAcceptTextXML(r *runtime.ClientOperation)
- type Client
- type ClientOption
- type ClientService
- type FileGetOrdersOK
- func (o *FileGetOrdersOK) Code() int
- func (o *FileGetOrdersOK) Error() string
- func (o *FileGetOrdersOK) GetPayload() *model.File
- func (o *FileGetOrdersOK) IsClientError() bool
- func (o *FileGetOrdersOK) IsCode(code int) bool
- func (o *FileGetOrdersOK) IsRedirect() bool
- func (o *FileGetOrdersOK) IsServerError() bool
- func (o *FileGetOrdersOK) IsSuccess() bool
- func (o *FileGetOrdersOK) String() string
- type FileGetOrdersParams
- func (o *FileGetOrdersParams) SetContext(ctx context.Context)
- func (o *FileGetOrdersParams) SetDefaults()
- func (o *FileGetOrdersParams) SetFileID(fileID strfmt.UUID)
- func (o *FileGetOrdersParams) SetHTTPClient(client *http.Client)
- func (o *FileGetOrdersParams) SetTimeout(timeout time.Duration)
- func (o *FileGetOrdersParams) WithContext(ctx context.Context) *FileGetOrdersParams
- func (o *FileGetOrdersParams) WithDefaults() *FileGetOrdersParams
- func (o *FileGetOrdersParams) WithFileID(fileID strfmt.UUID) *FileGetOrdersParams
- func (o *FileGetOrdersParams) WithHTTPClient(client *http.Client) *FileGetOrdersParams
- func (o *FileGetOrdersParams) WithTimeout(timeout time.Duration) *FileGetOrdersParams
- func (o *FileGetOrdersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type FileGetOrdersReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithAcceptApplicationJSON ¶
func WithAcceptApplicationJSON(r *runtime.ClientOperation)
WithAcceptApplicationJSON sets the Accept header to "application/json".
func WithAcceptApplicationXML ¶
func WithAcceptApplicationXML(r *runtime.ClientOperation)
WithAcceptApplicationXML sets the Accept header to "application/xml".
func WithAcceptTextJSON ¶
func WithAcceptTextJSON(r *runtime.ClientOperation)
WithAcceptTextJSON sets the Accept header to "text/json".
func WithAcceptTextXML ¶
func WithAcceptTextXML(r *runtime.ClientOperation)
WithAcceptTextXML sets the Accept header to "text/xml".
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for file API
func (*Client) FileGetOrders ¶
func (a *Client) FileGetOrders(params *FileGetOrdersParams, opts ...ClientOption) (*FileGetOrdersOK, error)
FileGetOrders file get orders API
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.
func WithAccept ¶
func WithAccept(mime string) ClientOption
WithAccept allows the client to force the Accept header to negotiate a specific Producer from the server.
You may use this option to set arbitrary extensions to your MIME media type.
type ClientService ¶
type ClientService interface {
FileGetOrders(params *FileGetOrdersParams, opts ...ClientOption) (*FileGetOrdersOK, 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 file API client.
func NewClientWithBasicAuth ¶
func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService
New creates a new file 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 file 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 FileGetOrdersOK ¶
FileGetOrdersOK describes a response with status code 200, with default header values.
Get a file
func NewFileGetOrdersOK ¶
func NewFileGetOrdersOK() *FileGetOrdersOK
NewFileGetOrdersOK creates a FileGetOrdersOK with default headers values
func (*FileGetOrdersOK) Code ¶
func (o *FileGetOrdersOK) Code() int
Code gets the status code for the file get orders o k response
func (*FileGetOrdersOK) Error ¶
func (o *FileGetOrdersOK) Error() string
func (*FileGetOrdersOK) GetPayload ¶
func (o *FileGetOrdersOK) GetPayload() *model.File
func (*FileGetOrdersOK) IsClientError ¶
func (o *FileGetOrdersOK) IsClientError() bool
IsClientError returns true when this file get orders o k response has a 4xx status code
func (*FileGetOrdersOK) IsCode ¶
func (o *FileGetOrdersOK) IsCode(code int) bool
IsCode returns true when this file get orders o k response a status code equal to that given
func (*FileGetOrdersOK) IsRedirect ¶
func (o *FileGetOrdersOK) IsRedirect() bool
IsRedirect returns true when this file get orders o k response has a 3xx status code
func (*FileGetOrdersOK) IsServerError ¶
func (o *FileGetOrdersOK) IsServerError() bool
IsServerError returns true when this file get orders o k response has a 5xx status code
func (*FileGetOrdersOK) IsSuccess ¶
func (o *FileGetOrdersOK) IsSuccess() bool
IsSuccess returns true when this file get orders o k response has a 2xx status code
func (*FileGetOrdersOK) String ¶
func (o *FileGetOrdersOK) String() string
type FileGetOrdersParams ¶
type FileGetOrdersParams struct {
// FileID.
//
// Format: uuid
FileID strfmt.UUID
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
FileGetOrdersParams contains all the parameters to send to the API endpoint
for the file get orders operation. Typically these are written to a http.Request.
func NewFileGetOrdersParams ¶
func NewFileGetOrdersParams() *FileGetOrdersParams
NewFileGetOrdersParams creates a new FileGetOrdersParams 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 NewFileGetOrdersParamsWithContext ¶
func NewFileGetOrdersParamsWithContext(ctx context.Context) *FileGetOrdersParams
NewFileGetOrdersParamsWithContext creates a new FileGetOrdersParams object with the ability to set a context for a request.
func NewFileGetOrdersParamsWithHTTPClient ¶
func NewFileGetOrdersParamsWithHTTPClient(client *http.Client) *FileGetOrdersParams
NewFileGetOrdersParamsWithHTTPClient creates a new FileGetOrdersParams object with the ability to set a custom HTTPClient for a request.
func NewFileGetOrdersParamsWithTimeout ¶
func NewFileGetOrdersParamsWithTimeout(timeout time.Duration) *FileGetOrdersParams
NewFileGetOrdersParamsWithTimeout creates a new FileGetOrdersParams object with the ability to set a timeout on a request.
func (*FileGetOrdersParams) SetContext ¶
func (o *FileGetOrdersParams) SetContext(ctx context.Context)
SetContext adds the context to the file get orders params
func (*FileGetOrdersParams) SetDefaults ¶
func (o *FileGetOrdersParams) SetDefaults()
SetDefaults hydrates default values in the file get orders params (not the query body).
All values with no default are reset to their zero value.
func (*FileGetOrdersParams) SetFileID ¶
func (o *FileGetOrdersParams) SetFileID(fileID strfmt.UUID)
SetFileID adds the fileId to the file get orders params
func (*FileGetOrdersParams) SetHTTPClient ¶
func (o *FileGetOrdersParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the file get orders params
func (*FileGetOrdersParams) SetTimeout ¶
func (o *FileGetOrdersParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the file get orders params
func (*FileGetOrdersParams) WithContext ¶
func (o *FileGetOrdersParams) WithContext(ctx context.Context) *FileGetOrdersParams
WithContext adds the context to the file get orders params
func (*FileGetOrdersParams) WithDefaults ¶
func (o *FileGetOrdersParams) WithDefaults() *FileGetOrdersParams
WithDefaults hydrates default values in the file get orders params (not the query body).
All values with no default are reset to their zero value.
func (*FileGetOrdersParams) WithFileID ¶
func (o *FileGetOrdersParams) WithFileID(fileID strfmt.UUID) *FileGetOrdersParams
WithFileID adds the fileID to the file get orders params
func (*FileGetOrdersParams) WithHTTPClient ¶
func (o *FileGetOrdersParams) WithHTTPClient(client *http.Client) *FileGetOrdersParams
WithHTTPClient adds the HTTPClient to the file get orders params
func (*FileGetOrdersParams) WithTimeout ¶
func (o *FileGetOrdersParams) WithTimeout(timeout time.Duration) *FileGetOrdersParams
WithTimeout adds the timeout to the file get orders params
func (*FileGetOrdersParams) WriteToRequest ¶
func (o *FileGetOrdersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type FileGetOrdersReader ¶
type FileGetOrdersReader struct {
// contains filtered or unexported fields
}
FileGetOrdersReader is a Reader for the FileGetOrders structure.
func (*FileGetOrdersReader) ReadResponse ¶
func (o *FileGetOrdersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.