instance

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 20, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package instance provides primitives to interact with the openapi HTTP API.

Code generated by github.com/do87/oapi-codegen version v0.4.0 DO NOT EDIT.

Index

Constants

View Source 
const (
	BearerAuthScopes = "BearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewDeleteInstanceRequest 

func NewDeleteInstanceRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)

NewDeleteInstanceRequest generates requests for DeleteInstance

func NewGetInstanceRequest 

func NewGetInstanceRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)

NewGetInstanceRequest generates requests for GetInstance

func NewGetInstancesRequest 

func NewGetInstancesRequest(ctx context.Context, server string, projectID string) (*http.Request, error)

NewGetInstancesRequest generates requests for GetInstances

func NewPatchInstanceRequest 

func NewPatchInstanceRequest(ctx context.Context, server string, projectID string, instanceID string, body PatchInstanceJSONRequestBody) (*http.Request, error)

NewPatchInstanceRequest calls the generic PatchInstance builder with application/json body

func NewPatchInstanceRequestWithBody 

func NewPatchInstanceRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)

NewPatchInstanceRequestWithBody generates requests for PatchInstance with any type of body

func NewPostInstancesRequest 

func NewPostInstancesRequest(ctx context.Context, server string, projectID string, body PostInstancesJSONRequestBody) (*http.Request, error)

NewPostInstancesRequest calls the generic PostInstances builder with application/json body

func NewPostInstancesRequestWithBody 

func NewPostInstancesRequestWithBody(ctx context.Context, server string, projectID string, contentType string, body io.Reader) (*http.Request, error)

NewPostInstancesRequestWithBody generates requests for PostInstances with any type of body

func NewPutInstanceRequest 

func NewPutInstanceRequest(ctx context.Context, server string, projectID string, instanceID string, body PutInstanceJSONRequestBody) (*http.Request, error)

NewPutInstanceRequest calls the generic PutInstance builder with application/json body

func NewPutInstanceRequestWithBody 

func NewPutInstanceRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)

NewPutInstanceRequestWithBody generates requests for PutInstance with any type of body

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 NewClient 

func NewClient(server string, httpClient common.Client) *Client

Creates a new Client, with reasonable defaults

func (*Client) DeleteInstance 

func (c *Client) DeleteInstance(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstance 

func (c *Client) GetInstance(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInstances 

func (c *Client) GetInstances(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PatchInstance 

func (c *Client) PatchInstance(ctx context.Context, projectID string, instanceID string, body PatchInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PatchInstanceWithBody 

func (c *Client) PatchInstanceWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostInstances 

func (c *Client) PostInstances(ctx context.Context, projectID string, body PostInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostInstancesWithBody 

func (c *Client) PostInstancesWithBody(ctx context.Context, projectID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PutInstance 

func (c *Client) PutInstance(ctx context.Context, projectID string, instanceID string, body PutInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PutInstanceWithBody 

func (c *Client) PutInstanceWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetInstances request
	GetInstances(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostInstances request with any body
	PostInstancesWithBody(ctx context.Context, projectID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostInstances(ctx context.Context, projectID string, body PostInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteInstance request
	DeleteInstance(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstance request
	GetInstance(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchInstance request with any body
	PatchInstanceWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PatchInstance(ctx context.Context, projectID string, instanceID string, body PatchInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutInstance request with any body
	PutInstanceWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutInstance(ctx context.Context, projectID string, instanceID string, body PutInstanceJSONRequestBody, 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) DeleteInstanceWithResponse 

func (c *ClientWithResponses) DeleteInstanceWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*DeleteInstanceResponse, error)

DeleteInstanceWithResponse request returning *DeleteInstanceResponse

func (*ClientWithResponses) GetInstanceWithResponse 

func (c *ClientWithResponses) GetInstanceWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetInstanceResponse, error)

GetInstanceWithResponse request returning *GetInstanceResponse

func (*ClientWithResponses) GetInstancesWithResponse 

func (c *ClientWithResponses) GetInstancesWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetInstancesResponse, error)

GetInstancesWithResponse request returning *GetInstancesResponse

func (*ClientWithResponses) ParseDeleteInstanceResponse 

func (c *ClientWithResponses) ParseDeleteInstanceResponse(rsp *http.Response) (*DeleteInstanceResponse, error)

ParseDeleteInstanceResponse parses an HTTP response from a DeleteInstanceWithResponse call

func (*ClientWithResponses) ParseGetInstanceResponse 

func (c *ClientWithResponses) ParseGetInstanceResponse(rsp *http.Response) (*GetInstanceResponse, error)

ParseGetInstanceResponse parses an HTTP response from a GetInstanceWithResponse call

func (*ClientWithResponses) ParseGetInstancesResponse 

func (c *ClientWithResponses) ParseGetInstancesResponse(rsp *http.Response) (*GetInstancesResponse, error)

ParseGetInstancesResponse parses an HTTP response from a GetInstancesWithResponse call

func (*ClientWithResponses) ParsePatchInstanceResponse 

func (c *ClientWithResponses) ParsePatchInstanceResponse(rsp *http.Response) (*PatchInstanceResponse, error)

ParsePatchInstanceResponse parses an HTTP response from a PatchInstanceWithResponse call

func (*ClientWithResponses) ParsePostInstancesResponse 

func (c *ClientWithResponses) ParsePostInstancesResponse(rsp *http.Response) (*PostInstancesResponse, error)

ParsePostInstancesResponse parses an HTTP response from a PostInstancesWithResponse call

func (*ClientWithResponses) ParsePutInstanceResponse 

func (c *ClientWithResponses) ParsePutInstanceResponse(rsp *http.Response) (*PutInstanceResponse, error)

ParsePutInstanceResponse parses an HTTP response from a PutInstanceWithResponse call

func (*ClientWithResponses) PatchInstanceWithBodyWithResponse 

func (c *ClientWithResponses) PatchInstanceWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchInstanceResponse, error)

PatchInstanceWithBodyWithResponse request with arbitrary body returning *PatchInstanceResponse

func (*ClientWithResponses) PatchInstanceWithResponse 

func (c *ClientWithResponses) PatchInstanceWithResponse(ctx context.Context, projectID string, instanceID string, body PatchInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchInstanceResponse, error)

func (*ClientWithResponses) PostInstancesWithBodyWithResponse 

func (c *ClientWithResponses) PostInstancesWithBodyWithResponse(ctx context.Context, projectID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostInstancesResponse, error)

PostInstancesWithBodyWithResponse request with arbitrary body returning *PostInstancesResponse

func (*ClientWithResponses) PostInstancesWithResponse 

func (c *ClientWithResponses) PostInstancesWithResponse(ctx context.Context, projectID string, body PostInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstancesResponse, error)

func (*ClientWithResponses) PutInstanceWithBodyWithResponse 

func (c *ClientWithResponses) PutInstanceWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutInstanceResponse, error)

PutInstanceWithBodyWithResponse request with arbitrary body returning *PutInstanceResponse

func (*ClientWithResponses) PutInstanceWithResponse 

func (c *ClientWithResponses) PutInstanceWithResponse(ctx context.Context, projectID string, instanceID string, body PutInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PutInstanceResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetInstances request
	GetInstancesWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetInstancesResponse, error)

	// PostInstances request with any body
	PostInstancesWithBodyWithResponse(ctx context.Context, projectID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostInstancesResponse, error)

	PostInstancesWithResponse(ctx context.Context, projectID string, body PostInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstancesResponse, error)

	// DeleteInstance request
	DeleteInstanceWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*DeleteInstanceResponse, error)

	// GetInstance request
	GetInstanceWithResponse(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetInstanceResponse, error)

	// PatchInstance request with any body
	PatchInstanceWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchInstanceResponse, error)

	PatchInstanceWithResponse(ctx context.Context, projectID string, instanceID string, body PatchInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchInstanceResponse, error)

	// PutInstance request with any body
	PutInstanceWithBodyWithResponse(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutInstanceResponse, error)

	PutInstanceWithResponse(ctx context.Context, projectID string, instanceID string, body PutInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PutInstanceResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type DeleteInstanceResponse 

type DeleteInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *InstanceError
	HasError     error // Aggregated error
}

func (DeleteInstanceResponse) Status 

func (r DeleteInstanceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteInstanceResponse) StatusCode 

func (r DeleteInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstanceResponse 

type GetInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceGetInstanceResponse
	JSON400      *InstanceError
	HasError     error // Aggregated error
}

func (GetInstanceResponse) Status 

func (r GetInstanceResponse) Status() string

Status returns HTTPResponse.Status

func (GetInstanceResponse) StatusCode 

func (r GetInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstancesResponse 

type GetInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceListInstanceResponse
	JSON400      *InstanceError
	HasError     error // Aggregated error
}

func (GetInstancesResponse) Status 

func (r GetInstancesResponse) Status() string

Status returns HTTPResponse.Status

func (GetInstancesResponse) StatusCode 

func (r GetInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InstanceAcl 

type InstanceAcl struct {
	// Items TODO validating in api (middleware)
	Items *[]string `json:"items,omitempty"`
}

InstanceAcl defines model for instance.Acl.

type InstanceCreateInstanceRequest 

type InstanceCreateInstanceRequest struct {
	Acl            *InstanceAcl `json:"acl,omitempty"`
	BackupSchedule *string      `json:"backupSchedule,omitempty"`
	FlavorID       *string      `json:"flavorId,omitempty"`

	// Labels Following fields are not certain/clear
	Labels   *map[string]string `json:"labels,omitempty"`
	Name     *string            `json:"name,omitempty"`
	Options  *map[string]string `json:"options,omitempty"`
	Replicas *int               `json:"replicas,omitempty"`
	Storage  *InstanceStorage   `json:"storage,omitempty"`
	Version  *string            `json:"version,omitempty"`
}

InstanceCreateInstanceRequest defines model for instance.CreateInstanceRequest.

type InstanceCreateInstanceResponse 

type InstanceCreateInstanceResponse struct {
	ID *string `json:"id,omitempty"`
}

InstanceCreateInstanceResponse defines model for instance.CreateInstanceResponse.

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 InstanceFlavor 

type InstanceFlavor struct {
	Cpu         *int    `json:"cpu,omitempty"`
	Description *string `json:"description,omitempty"`
	ID          *string `json:"id,omitempty"`
	Memory      *int    `json:"memory,omitempty"`
}

InstanceFlavor defines model for instance.Flavor.

type InstanceGetInstanceResponse 

type InstanceGetInstanceResponse struct {
	Item *InstanceSingleInstance `json:"item,omitempty"`
}

InstanceGetInstanceResponse defines model for instance.GetInstanceResponse.

type InstanceListInstance 

type InstanceListInstance struct {
	ID     *string `json:"id,omitempty"`
	Name   *string `json:"name,omitempty"`
	Status *string `json:"status,omitempty"`
}

InstanceListInstance defines model for instance.ListInstance.

type InstanceListInstanceResponse 

type InstanceListInstanceResponse struct {
	// Count TODO pagination ?
	Count *int                    `json:"count,omitempty"`
	Items *[]InstanceListInstance `json:"items,omitempty"`
}

InstanceListInstanceResponse defines model for instance.ListInstanceResponse.

type InstanceSingleInstance 

type InstanceSingleInstance struct {
	Acl            *InstanceAcl       `json:"acl,omitempty"`
	BackupSchedule *string            `json:"backupSchedule,omitempty"`
	Flavor         *InstanceFlavor    `json:"flavor,omitempty"`
	ID             *string            `json:"id,omitempty"`
	Name           *string            `json:"name,omitempty"`
	Options        *map[string]string `json:"options,omitempty"`
	Replicas       *int               `json:"replicas,omitempty"`
	Status         *string            `json:"status,omitempty"`
	Storage        *InstanceStorage   `json:"storage,omitempty"`
	Version        *string            `json:"version,omitempty"`
}

InstanceSingleInstance defines model for instance.SingleInstance.

type InstanceStorage 

type InstanceStorage struct {
	Class *string `json:"class,omitempty"`
	Size  *int    `json:"size,omitempty"`
}

InstanceStorage defines model for instance.Storage.

type InstanceUpdateInstanceRequest 

type InstanceUpdateInstanceRequest struct {
	Acl            *InstanceAcl `json:"acl,omitempty"`
	BackupSchedule *string      `json:"backupSchedule,omitempty"`
	FlavorID       *string      `json:"flavorId,omitempty"`

	// Labels Following fields are not certain/clear
	Labels   *map[string]string `json:"labels,omitempty"`
	Name     *string            `json:"name,omitempty"`
	Options  *map[string]string `json:"options,omitempty"`
	Replicas *int               `json:"replicas,omitempty"`
	Storage  *InstanceStorage   `json:"storage,omitempty"`
	Version  *string            `json:"version,omitempty"`
}

InstanceUpdateInstanceRequest defines model for instance.UpdateInstanceRequest.

type InstanceUpdateInstanceResponse 

type InstanceUpdateInstanceResponse struct {
	Item *InstanceSingleInstance `json:"item,omitempty"`
}

InstanceUpdateInstanceResponse defines model for instance.UpdateInstanceResponse.

type PatchInstanceJSONRequestBody 

type PatchInstanceJSONRequestBody = InstanceUpdateInstanceRequest

PatchInstanceJSONRequestBody defines body for PatchInstance for application/json ContentType.

type PatchInstanceResponse 

type PatchInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceUpdateInstanceResponse
	JSON400      *InstanceError
	HasError     error // Aggregated error
}

func (PatchInstanceResponse) Status 

func (r PatchInstanceResponse) Status() string

Status returns HTTPResponse.Status

func (PatchInstanceResponse) StatusCode 

func (r PatchInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostInstancesJSONRequestBody 

type PostInstancesJSONRequestBody = InstanceCreateInstanceRequest

PostInstancesJSONRequestBody defines body for PostInstances for application/json ContentType.

type PostInstancesResponse 

type PostInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceCreateInstanceResponse
	JSON400      *InstanceError
	HasError     error // Aggregated error
}

func (PostInstancesResponse) Status 

func (r PostInstancesResponse) Status() string

Status returns HTTPResponse.Status

func (PostInstancesResponse) StatusCode 

func (r PostInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutInstanceJSONRequestBody 

type PutInstanceJSONRequestBody = InstanceUpdateInstanceRequest

PutInstanceJSONRequestBody defines body for PutInstance for application/json ContentType.

type PutInstanceResponse 

type PutInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceUpdateInstanceResponse
	JSON400      *InstanceError
	HasError     error // Aggregated error
}

func (PutInstanceResponse) Status 

func (r PutInstanceResponse) Status() string

Status returns HTTPResponse.Status

func (PutInstanceResponse) StatusCode 

func (r PutInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.