Documentation
¶
Overview ¶
Package backups provides primitives to interact with the openapi HTTP API.
Code generated by github.com/do87/oapi-codegen version v0.5.1 DO NOT EDIT.
Index ¶
- Constants
- func NewGetRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
- func NewUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- type Client
- func (c *Client) Get(ctx context.Context, projectID string, instanceID string, backupID string, ...) (*http.Response, error)
- func (c *Client) List(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) Update(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- type ClientInterface
- type ClientWithResponses
- func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, instanceID string, backupID string, ...) (*GetResponse, error)
- func (c *ClientWithResponses) ListWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*ListResponse, error)
- func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
- func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
- func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
- func (c *ClientWithResponses) UpdateWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*UpdateResponse, error)
- func (c *ClientWithResponses) UpdateWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*UpdateResponse, error)
- type ClientWithResponsesInterface
- type GetResponse
- type InstanceBackup
- type InstanceError
- type InstanceGetBackupResponse
- type InstanceListBackupResponse
- type InstanceUpdateBackupScheduleRequest
- type ListResponse
- type RequestEditorFn
- type UpdateJSONRequestBody
- type UpdateResponse
Constants ¶
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewGetRequest ¶ added in v1.4.0
func NewGetRequest(ctx context.Context, server string, projectID string, instanceID string, backupID string) (*http.Request, error)
NewGetRequest generates requests for Get
func NewListRequest ¶ added in v1.4.0
func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
NewListRequest generates requests for List
Types ¶
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client common.Client
}
Client which conforms to the OpenAPI3 specification for this service.
type ClientInterface ¶
type ClientInterface interface {
// List request
List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)
// Update request with any body
UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
Update(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Get request
Get(ctx context.Context, projectID string, instanceID string, backupID string, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, httpClient common.Client) *ClientWithResponses
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) GetWithResponse ¶ added in v1.4.0
func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, instanceID string, backupID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
GetWithResponse request returning *GetResponse
func (*ClientWithResponses) ListWithResponse ¶ added in v1.4.0
func (c *ClientWithResponses) ListWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)
ListWithResponse request returning *ListResponse
func (*ClientWithResponses) ParseGetResponse ¶ added in v1.4.0
func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
ParseGetResponse parses an HTTP response from a GetWithResponse call
func (*ClientWithResponses) ParseListResponse ¶ added in v1.4.0
func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
ParseListResponse parses an HTTP response from a ListWithResponse call
func (*ClientWithResponses) ParseUpdateResponse ¶ added in v1.4.0
func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
ParseUpdateResponse parses an HTTP response from a UpdateWithResponse call
func (*ClientWithResponses) UpdateWithBodyWithResponse ¶ added in v1.4.0
func (c *ClientWithResponses) UpdateWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
UpdateWithBodyWithResponse request with arbitrary body returning *UpdateResponse
func (*ClientWithResponses) UpdateWithResponse ¶ added in v1.4.0
func (c *ClientWithResponses) UpdateWithResponse(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// List request
ListWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)
// Update request with any body
UpdateWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
UpdateWithResponse(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
// Get request
GetWithResponse(ctx context.Context, projectID string, instanceID string, backupID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type GetResponse ¶ added in v1.4.0
type GetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *InstanceGetBackupResponse
JSON400 *InstanceError
Error error // Aggregated error
}
func (GetResponse) Status ¶ added in v1.4.0
func (r GetResponse) Status() string
Status returns HTTPResponse.Status
func (GetResponse) StatusCode ¶ added in v1.4.0
func (r GetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type InstanceBackup ¶
type InstanceBackup struct {
EndTime *string `json:"endTime,omitempty"`
Error *string `json:"error,omitempty"`
ID *string `json:"id,omitempty"`
Labels *[]string `json:"labels,omitempty"`
Name *string `json:"name,omitempty"`
Options *map[string]string `json:"options,omitempty"`
Size *int `json:"size,omitempty"`
StartTime *string `json:"startTime,omitempty"`
}
InstanceBackup defines model for instance.Backup.
type InstanceError ¶
type InstanceError struct {
Code *int `json:"code,omitempty"`
Fields *map[string][]string `json:"fields,omitempty"`
Message *string `json:"message,omitempty"`
Type *string `json:"type,omitempty"`
}
InstanceError defines model for instance.Error.
type InstanceGetBackupResponse ¶
type InstanceGetBackupResponse struct {
Item *InstanceBackup `json:"item,omitempty"`
}
InstanceGetBackupResponse defines model for instance.GetBackupResponse.
type InstanceListBackupResponse ¶
type InstanceListBackupResponse struct {
Count *int `json:"count,omitempty"`
Items *[]InstanceBackup `json:"items,omitempty"`
}
InstanceListBackupResponse defines model for instance.ListBackupResponse.
type InstanceUpdateBackupScheduleRequest ¶
type InstanceUpdateBackupScheduleRequest struct {
BackupSchedule *string `json:"backupSchedule,omitempty"`
}
InstanceUpdateBackupScheduleRequest defines model for instance.UpdateBackupScheduleRequest.
type ListResponse ¶ added in v1.4.0
type ListResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *InstanceListBackupResponse
JSON400 *InstanceError
Error error // Aggregated error
}
func (ListResponse) Status ¶ added in v1.4.0
func (r ListResponse) Status() string
Status returns HTTPResponse.Status
func (ListResponse) StatusCode ¶ added in v1.4.0
func (r ListResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type UpdateJSONRequestBody ¶ added in v1.4.0
type UpdateJSONRequestBody = InstanceUpdateBackupScheduleRequest
UpdateJSONRequestBody defines body for Update for application/json ContentType.
type UpdateResponse ¶ added in v1.4.0
type UpdateResponse struct {
Body []byte
HTTPResponse *http.Response
JSON400 *InstanceError
Error error // Aggregated error
}
func (UpdateResponse) Status ¶ added in v1.4.0
func (r UpdateResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateResponse) StatusCode ¶ added in v1.4.0
func (r UpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode