Documentation
¶
Overview ¶
Package backup 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 NewCreateCloneRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewCreateCloneRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewCreateRestoreRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewCreateRestoreRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- 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) CreateClone(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) CreateCloneWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- func (c *Client) CreateRestore(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) CreateRestoreWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- 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) CreateCloneWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*CreateCloneResponse, error)
- func (c *ClientWithResponses) CreateCloneWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*CreateCloneResponse, error)
- func (c *ClientWithResponses) CreateRestoreWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*CreateRestoreResponse, error)
- func (c *ClientWithResponses) CreateRestoreWithResponse(ctx context.Context, projectID string, instanceID string, ...) (*CreateRestoreResponse, error)
- 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) ParseCreateCloneResponse(rsp *http.Response) (*CreateCloneResponse, error)
- func (c *ClientWithResponses) ParseCreateRestoreResponse(rsp *http.Response) (*CreateRestoreResponse, 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 CreateCloneJSONRequestBody
- type CreateCloneResponse
- type CreateRestoreJSONRequestBody
- type CreateRestoreResponse
- type GetResponse
- type InstanceBackup
- type InstanceCreateCloneInstanceRequest
- type InstanceCreateCloneInstanceResponse
- type InstanceCreateRestoreInstanceRequest
- type InstanceCreateRestoreInstanceResponse
- type InstanceError
- type InstanceGetBackupResponse
- type InstanceListBackupResponse
- type ListResponse
- type OpsmanagerUpdateScheduleRequest
- type RequestEditorFn
- type UpdateJSONRequestBody
- type UpdateResponse
Constants ¶
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewCreateCloneRequest ¶
func NewCreateCloneRequest(ctx context.Context, server string, projectID string, instanceID string, body CreateCloneJSONRequestBody) (*http.Request, error)
NewCreateCloneRequest calls the generic CreateClone builder with application/json body
func NewCreateCloneRequestWithBody ¶
func NewCreateCloneRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)
NewCreateCloneRequestWithBody generates requests for CreateClone with any type of body
func NewCreateRestoreRequest ¶
func NewCreateRestoreRequest(ctx context.Context, server string, projectID string, instanceID string, body CreateRestoreJSONRequestBody) (*http.Request, error)
NewCreateRestoreRequest calls the generic CreateRestore builder with application/json body
func NewCreateRestoreRequestWithBody ¶
func NewCreateRestoreRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)
NewCreateRestoreRequestWithBody generates requests for CreateRestore with any type of body
func NewGetRequest ¶
func NewGetRequest(ctx context.Context, server string, projectID string, instanceID string, backupID string) (*http.Request, error)
NewGetRequest generates requests for Get
func NewListRequest ¶
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.
func (*Client) CreateClone ¶
func (c *Client) CreateClone(ctx context.Context, projectID string, instanceID string, body CreateCloneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateCloneWithBody ¶
func (*Client) CreateRestore ¶
func (c *Client) CreateRestore(ctx context.Context, projectID string, instanceID string, body CreateRestoreJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateRestoreWithBody ¶
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)
// CreateClone request with any body
CreateCloneWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateClone(ctx context.Context, projectID string, instanceID string, body CreateCloneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateRestore request with any body
CreateRestoreWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateRestore(ctx context.Context, projectID string, instanceID string, body CreateRestoreJSONRequestBody, 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) CreateCloneWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateCloneWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCloneResponse, error)
CreateCloneWithBodyWithResponse request with arbitrary body returning *CreateCloneResponse
func (*ClientWithResponses) CreateCloneWithResponse ¶
func (c *ClientWithResponses) CreateCloneWithResponse(ctx context.Context, projectID string, instanceID string, body CreateCloneJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCloneResponse, error)
func (*ClientWithResponses) CreateRestoreWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateRestoreWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRestoreResponse, error)
CreateRestoreWithBodyWithResponse request with arbitrary body returning *CreateRestoreResponse
func (*ClientWithResponses) CreateRestoreWithResponse ¶
func (c *ClientWithResponses) CreateRestoreWithResponse(ctx context.Context, projectID string, instanceID string, body CreateRestoreJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRestoreResponse, error)
func (*ClientWithResponses) GetWithResponse ¶
func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, instanceID string, backupID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
GetWithResponse request returning *GetResponse
func (*ClientWithResponses) ListWithResponse ¶
func (c *ClientWithResponses) ListWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)
ListWithResponse request returning *ListResponse
func (*ClientWithResponses) ParseCreateCloneResponse ¶
func (c *ClientWithResponses) ParseCreateCloneResponse(rsp *http.Response) (*CreateCloneResponse, error)
ParseCreateCloneResponse parses an HTTP response from a CreateCloneWithResponse call
func (*ClientWithResponses) ParseCreateRestoreResponse ¶
func (c *ClientWithResponses) ParseCreateRestoreResponse(rsp *http.Response) (*CreateRestoreResponse, error)
ParseCreateRestoreResponse parses an HTTP response from a CreateRestoreWithResponse call
func (*ClientWithResponses) ParseGetResponse ¶
func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
ParseGetResponse parses an HTTP response from a GetWithResponse call
func (*ClientWithResponses) ParseListResponse ¶
func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
ParseListResponse parses an HTTP response from a ListWithResponse call
func (*ClientWithResponses) ParseUpdateResponse ¶
func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
ParseUpdateResponse parses an HTTP response from a UpdateWithResponse call
func (*ClientWithResponses) UpdateWithBodyWithResponse ¶
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 ¶
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)
// CreateClone request with any body
CreateCloneWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCloneResponse, error)
CreateCloneWithResponse(ctx context.Context, projectID string, instanceID string, body CreateCloneJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCloneResponse, error)
// CreateRestore request with any body
CreateRestoreWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRestoreResponse, error)
CreateRestoreWithResponse(ctx context.Context, projectID string, instanceID string, body CreateRestoreJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRestoreResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CreateCloneJSONRequestBody ¶
type CreateCloneJSONRequestBody = InstanceCreateCloneInstanceRequest
CreateCloneJSONRequestBody defines body for CreateClone for application/json ContentType.
type CreateCloneResponse ¶
type CreateCloneResponse struct {
Body []byte
HTTPResponse *http.Response
JSON202 *InstanceCreateCloneInstanceResponse
JSON400 *InstanceError
JSON404 *InstanceError
Error error // Aggregated error
}
func (CreateCloneResponse) Status ¶
func (r CreateCloneResponse) Status() string
Status returns HTTPResponse.Status
func (CreateCloneResponse) StatusCode ¶
func (r CreateCloneResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateRestoreJSONRequestBody ¶
type CreateRestoreJSONRequestBody = InstanceCreateRestoreInstanceRequest
CreateRestoreJSONRequestBody defines body for CreateRestore for application/json ContentType.
type CreateRestoreResponse ¶
type CreateRestoreResponse struct {
Body []byte
HTTPResponse *http.Response
JSON202 *InstanceCreateRestoreInstanceResponse
JSON400 *InstanceError
JSON404 *InstanceError
Error error // Aggregated error
}
func (CreateRestoreResponse) Status ¶
func (r CreateRestoreResponse) Status() string
Status returns HTTPResponse.Status
func (CreateRestoreResponse) StatusCode ¶
func (r CreateRestoreResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetResponse ¶
type GetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *InstanceGetBackupResponse
JSON400 *InstanceError
JSON404 *InstanceError
Error error // Aggregated error
}
func (GetResponse) StatusCode ¶
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"`
StartTime *string `json:"startTime,omitempty"`
}
InstanceBackup defines model for instance.Backup.
type InstanceCreateCloneInstanceRequest ¶
type InstanceCreateCloneInstanceRequest struct {
InstanceID *string `json:"instanceId,omitempty"`
}
InstanceCreateCloneInstanceRequest defines model for instance.CreateCloneInstanceRequest.
type InstanceCreateCloneInstanceResponse ¶
type InstanceCreateCloneInstanceResponse struct {
InstanceID *string `json:"instanceId,omitempty"`
}
InstanceCreateCloneInstanceResponse defines model for instance.CreateCloneInstanceResponse.
type InstanceCreateRestoreInstanceRequest ¶
type InstanceCreateRestoreInstanceRequest struct {
BackupID *string `json:"backupId,omitempty"`
InstanceID *string `json:"instanceId,omitempty"`
}
InstanceCreateRestoreInstanceRequest defines model for instance.CreateRestoreInstanceRequest.
type InstanceCreateRestoreInstanceResponse ¶
type InstanceCreateRestoreInstanceResponse struct {
InstanceID *string `json:"instanceId,omitempty"`
}
InstanceCreateRestoreInstanceResponse defines model for instance.CreateRestoreInstanceResponse.
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 ¶ added in v1.14.0
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 ListResponse ¶
type ListResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *InstanceListBackupResponse
JSON400 *InstanceError
JSON404 *InstanceError
Error error // Aggregated error
}
func (ListResponse) Status ¶
func (r ListResponse) Status() string
Status returns HTTPResponse.Status
func (ListResponse) StatusCode ¶
func (r ListResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type OpsmanagerUpdateScheduleRequest ¶
type OpsmanagerUpdateScheduleRequest struct {
BackupSchedule *string `json:"backupSchedule,omitempty"`
DailySnapshotRetentionDays *int `json:"dailySnapshotRetentionDays,omitempty"`
MonthlySnapshotRetentionMonths *int `json:"monthlySnapshotRetentionMonths,omitempty"`
PointInTimeWindowHours *int `json:"pointInTimeWindowHours,omitempty"`
SnapshotRetentionDays *int `json:"snapshotRetentionDays,omitempty"`
WeeklySnapshotRetentionWeeks *int `json:"weeklySnapshotRetentionWeeks,omitempty"`
}
OpsmanagerUpdateScheduleRequest defines model for opsmanager.UpdateScheduleRequest.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type UpdateJSONRequestBody ¶
type UpdateJSONRequestBody = OpsmanagerUpdateScheduleRequest
UpdateJSONRequestBody defines body for Update for application/json ContentType.
type UpdateResponse ¶
type UpdateResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *OpsmanagerUpdateScheduleRequest
JSON400 *InstanceError
JSON404 *InstanceError
Error error // Aggregated error
}
func (UpdateResponse) Status ¶
func (r UpdateResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateResponse) StatusCode ¶
func (r UpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode