instances

package
v1.29.10 Latest Latest
Warning

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

 Go to latest Published: Mar 3, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

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

Code generated by github.com/do87/stackit-client-generator version v0.0.2 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewDeprovisionRequest 

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

NewDeprovisionRequest generates requests for Deprovision

func NewGetBackupsRequest added in v1.23.0 

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

NewGetBackupsRequest generates requests for GetBackups

func NewGetByGatewayRequest added in v1.23.0 

func NewGetByGatewayRequest(ctx context.Context, server string, gatewayName string) (*http.Request, error)

NewGetByGatewayRequest generates requests for GetByGateway

func NewGetMetricsRequest added in v1.23.0 

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

NewGetMetricsRequest generates requests for GetMetrics

func NewGetRequest 

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

NewGetRequest generates requests for Get

func NewListRequest 

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

NewListRequest generates requests for List

func NewProvisionRequest 

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

NewProvisionRequest calls the generic Provision builder with application/json body

func NewProvisionRequestWithBody 

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

NewProvisionRequestWithBody generates requests for Provision with any type of body

func NewUpdateRequest 

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

NewUpdateRequest calls the generic Update builder with application/json body

func NewUpdateRequestWithBody 

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

NewUpdateRequestWithBody generates requests for Update with any type of body

Types

type BadRequest 

type BadRequest = Error

BadRequest defines model for BadRequest.

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 contracts.BaseClientInterface
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient 

func NewRawClient(server string, httpClient contracts.BaseClientInterface) *Client

NewRawClient Creates a new Client, with reasonable defaults

func (*Client) DeprovisionRaw 

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

func (*Client) GetBackupsRaw added in v1.23.0 

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

func (*Client) GetByGatewayRaw added in v1.23.0 

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

func (*Client) GetMetricsRaw added in v1.23.0 

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

func (*Client) GetRaw 

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

func (*Client) ListRaw 

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

func (*Client) ProvisionRaw 

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

func (*Client) ProvisionRawWithBody 

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

func (*Client) UpdateRaw 

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

func (*Client) UpdateRawWithBody 

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

type ClientWithResponses 

type ClientWithResponses struct {
	// contains filtered or unexported fields
}

ClientWithResponses builds on rawClientInterface to offer response payloads

func NewClient 

func NewClient(server string, httpClient contracts.BaseClientInterface) *ClientWithResponses

NewClient creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) Deprovision 

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

Deprovision request returning *DeprovisionResponse

func (*ClientWithResponses) Get 

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

Get request returning *GetResponse

func (*ClientWithResponses) GetBackups added in v1.23.0 

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

GetBackups request returning *GetBackupsResponse

func (*ClientWithResponses) GetByGateway added in v1.23.0 

func (c *ClientWithResponses) GetByGateway(ctx context.Context, gatewayName string, reqEditors ...RequestEditorFn) (*GetByGatewayResponse, error)

GetByGateway request returning *GetByGatewayResponse

func (*ClientWithResponses) GetMetrics added in v1.23.0 

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

GetMetrics request returning *GetMetricsResponse

func (*ClientWithResponses) List 

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

List request returning *ListResponse

func (*ClientWithResponses) ParseDeprovisionResponse 

func (c *ClientWithResponses) ParseDeprovisionResponse(rsp *http.Response) (*DeprovisionResponse, error)

ParseDeprovisionResponse parses an HTTP response from a Deprovision call

func (*ClientWithResponses) ParseGetBackupsResponse added in v1.23.0 

func (c *ClientWithResponses) ParseGetBackupsResponse(rsp *http.Response) (*GetBackupsResponse, error)

ParseGetBackupsResponse parses an HTTP response from a GetBackups call

func (*ClientWithResponses) ParseGetByGatewayResponse added in v1.23.0 

func (c *ClientWithResponses) ParseGetByGatewayResponse(rsp *http.Response) (*GetByGatewayResponse, error)

ParseGetByGatewayResponse parses an HTTP response from a GetByGateway call

func (*ClientWithResponses) ParseGetMetricsResponse added in v1.23.0 

func (c *ClientWithResponses) ParseGetMetricsResponse(rsp *http.Response) (*GetMetricsResponse, error)

ParseGetMetricsResponse parses an HTTP response from a GetMetrics call

func (*ClientWithResponses) ParseGetResponse 

func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)

ParseGetResponse parses an HTTP response from a Get call

func (*ClientWithResponses) ParseListResponse 

func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)

ParseListResponse parses an HTTP response from a List call

func (*ClientWithResponses) ParseProvisionResponse 

func (c *ClientWithResponses) ParseProvisionResponse(rsp *http.Response) (*ProvisionResponse, error)

ParseProvisionResponse parses an HTTP response from a Provision call

func (*ClientWithResponses) ParseUpdateResponse 

func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)

ParseUpdateResponse parses an HTTP response from a Update call

func (*ClientWithResponses) Provision 

func (c *ClientWithResponses) Provision(ctx context.Context, projectID string, body ProvisionJSONRequestBody, reqEditors ...RequestEditorFn) (*ProvisionResponse, error)

func (*ClientWithResponses) ProvisionWithBody 

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

ProvisionWithBody request with arbitrary body returning *ProvisionResponse

func (*ClientWithResponses) Update 

func (c *ClientWithResponses) Update(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)

func (*ClientWithResponses) UpdateWithBody 

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

UpdateWithBody request with arbitrary body returning *UpdateResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetByGateway request
	GetByGateway(ctx context.Context, gatewayName string, reqEditors ...RequestEditorFn) (*GetByGatewayResponse, error)

	// List request
	List(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*ListResponse, error)

	// Provision request with any body
	ProvisionWithBody(ctx context.Context, projectID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ProvisionResponse, error)

	Provision(ctx context.Context, projectID string, body ProvisionJSONRequestBody, reqEditors ...RequestEditorFn) (*ProvisionResponse, error)

	// Deprovision request
	Deprovision(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*DeprovisionResponse, error)

	// Get request
	Get(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetResponse, error)

	// Update request with any body
	UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error)

	Update(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)

	// GetBackups request
	GetBackups(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetBackupsResponse, error)

	// GetMetrics request
	GetMetrics(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetMetricsResponse, error)
}

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

type DeprovisionResponse 

type DeprovisionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON404      *Error
	Error        error // Aggregated error
}

func (DeprovisionResponse) Status 

func (r DeprovisionResponse) Status() string

Status returns HTTPResponse.Status

func (DeprovisionResponse) StatusCode 

func (r DeprovisionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

func (DeprovisionResponse) WaitHandler 

func (DeprovisionResponse) WaitHandler(ctx context.Context, c *ClientWithResponses, projectID, instanceID string) *wait.Handler

type Error 

type Error struct {
	Description string `json:"description"`
	Error       string `json:"error"`
}

Error defines model for Error.

type GetBackupsResponse added in v1.23.0 

type GetBackupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceBackupsList
	JSON404      *Error
	Error        error // Aggregated error
}

func (GetBackupsResponse) Status added in v1.23.0 

func (r GetBackupsResponse) Status() string

Status returns HTTPResponse.Status

func (GetBackupsResponse) StatusCode added in v1.23.0 

func (r GetBackupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetByGatewayResponse added in v1.23.0 

type GetByGatewayResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Instance
	JSON404      *Error
	JSON410      *Error
	Error        error // Aggregated error
}

func (GetByGatewayResponse) Status added in v1.23.0 

func (r GetByGatewayResponse) Status() string

Status returns HTTPResponse.Status

func (GetByGatewayResponse) StatusCode added in v1.23.0 

func (r GetByGatewayResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMetricsResponse added in v1.23.0 

type GetMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceMetrics
	JSON404      *Error
	Error        error // Aggregated error
}

func (GetMetricsResponse) Status added in v1.23.0 

func (r GetMetricsResponse) Status() string

Status returns HTTPResponse.Status

func (GetMetricsResponse) StatusCode added in v1.23.0 

func (r GetMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetResponse 

type GetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Instance
	JSON404      *Error
	JSON410      *Error
	Error        error // Aggregated error
}

func (GetResponse) Status 

func (r GetResponse) Status() string

Status returns HTTPResponse.Status

func (GetResponse) StatusCode 

func (r GetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Instance 

type Instance struct {
	CFGUID           string        `json:"cfGuid"`
	CFSpaceGUID      string        `json:"cfSpaceGuid"`
	DashboardUrl     string        `json:"dashboardUrl"`
	ImageUrl         string        `json:"imageUrl"`
	InstanceID       *string       `json:"instanceId,omitempty"`
	LastOperation    LastOperation `json:"lastOperation"`
	Name             string        `json:"name"`
	OrganizationGUID *string       `json:"organizationGuid,omitempty"`
	Parameters       Object        `json:"parameters"`
	PlanID           string        `json:"planId"`
}

Instance defines model for Instance.

type InstanceBackup added in v1.23.0 

type InstanceBackup struct {
	Downloadable *bool   `json:"downloadable,omitempty"`
	FinishedAt   string  `json:"finished_at"`
	ID           int     `json:"id"`
	Size         *int    `json:"size,omitempty"`
	Status       string  `json:"status"`
	TriggeredAt  *string `json:"triggered_at,omitempty"`
}

InstanceBackup defines model for InstanceBackup.

type InstanceBackupsList added in v1.23.0 

type InstanceBackupsList struct {
	InstanceBackups []InstanceBackup `json:"instanceBackups"`
}

InstanceBackupsList defines model for InstanceBackupsList.

type InstanceID 

type InstanceID struct {
	InstanceID string `json:"instanceId"`
}

InstanceID defines model for InstanceID.

type InstanceList 

type InstanceList struct {
	Instances []Instance `json:"instances"`
}

InstanceList defines model for InstanceList.

type InstanceMetrics added in v1.23.0 

type InstanceMetrics struct {
	CpuIDleTime                          *int `json:"cpuIdleTime,omitempty"`
	CpuLoadPercent                       int  `json:"cpuLoadPercent"`
	CpuSystemTime                        *int `json:"cpuSystemTime,omitempty"`
	CpuUserTime                          *int `json:"cpuUserTime,omitempty"`
	DiskPersistentTotal                  int  `json:"diskPersistentTotal"`
	DiskPersistentUsed                   int  `json:"diskPersistentUsed"`
	MemoryTotal                          int  `json:"memoryTotal"`
	MemoryUsed                           int  `json:"memoryUsed"`
	ParachuteDiskPersistentActivated     int  `json:"parachuteDiskPersistentActivated"`
	ParachuteDiskPersistentTotal         int  `json:"parachuteDiskPersistentTotal"`
	ParachuteDiskPersistentUsed          int  `json:"parachuteDiskPersistentUsed"`
	ParachuteDiskPersistentUsedPercent   int  `json:"parachuteDiskPersistentUsedPercent"`
	ParachuteDiskPersistentUsedThreshold int  `json:"parachuteDiskPersistentUsedThreshold"`
}

InstanceMetrics defines model for InstanceMetrics.

type InstanceParameters added in v1.23.0 

type InstanceParameters struct {
	EnableMonitoring     *bool     `json:"enable_monitoring,omitempty"`
	Graphite             *string   `json:"graphite,omitempty"`
	MetricsFrequency     *int      `json:"metrics_frequency,omitempty"`
	MetricsPrefix        *string   `json:"metrics_prefix,omitempty"`
	MonitoringInstanceID *string   `json:"monitoring_instance_id,omitempty"`
	Plugins              *[]string `json:"plugins,omitempty"`
	SgwAcl               *string   `json:"sgw_acl,omitempty"`
	Syslog               *[]string `json:"syslog,omitempty"`
}

InstanceParameters defines model for InstanceParameters.

type InstanceProvisionRequest 

type InstanceProvisionRequest struct {
	InstanceName string              `json:"instanceName"`
	Parameters   *InstanceParameters `json:"parameters,omitempty"`
	PlanID       string              `json:"planId"`
}

InstanceProvisionRequest defines model for InstanceProvisionRequest.

type InstanceUpdateRequest 

type InstanceUpdateRequest struct {
	Parameters *InstanceParameters `json:"parameters,omitempty"`
	PlanID     string              `json:"planId"`
}

InstanceUpdateRequest defines model for InstanceUpdateRequest.

type LastOperation 

type LastOperation struct {
	Description string             `json:"description"`
	State       LastOperationState `json:"state"`
	Type        LastOperationType  `json:"type"`
}

LastOperation defines model for lastOperation.

type LastOperationState 

type LastOperationState string

LastOperationState defines model for LastOperation.State. 

const (
	FAILED      LastOperationState = "failed"
	IN_PROGRESS LastOperationState = "in progress"
	SUCCEEDED   LastOperationState = "succeeded"
)

Defines values for LastOperationState.

type LastOperationType 

type LastOperationType string

LastOperationType defines model for LastOperation.Type. 

const (
	CREATE LastOperationType = "create"
	DELETE LastOperationType = "delete"
	UPDATE LastOperationType = "update"
)

Defines values for LastOperationType.

type ListResponse 

type ListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceList
	JSON404      *Error
	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 NotFound 

type NotFound = Error

NotFound defines model for NotFound.

type Object 

type Object = map[string]interface{}

Object defines model for Object.

type ProvisionJSONRequestBody 

type ProvisionJSONRequestBody = InstanceProvisionRequest

ProvisionJSONRequestBody defines body for Provision for application/json ContentType.

type ProvisionResponse 

type ProvisionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *InstanceID
	JSON400      *Error
	JSON409      *Error
	Error        error // Aggregated error
}

func (ProvisionResponse) Status 

func (r ProvisionResponse) Status() string

Status returns HTTPResponse.Status

func (ProvisionResponse) StatusCode 

func (r ProvisionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

func (ProvisionResponse) WaitHandler 

func (ProvisionResponse) WaitHandler(ctx context.Context, c *ClientWithResponses, projectID, instanceID string) *wait.Handler

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type UpdateJSONRequestBody 

type UpdateJSONRequestBody = InstanceUpdateRequest

UpdateJSONRequestBody defines body for Update for application/json ContentType.

type UpdateResponse 

type UpdateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON404      *Error
	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

func (UpdateResponse) WaitHandler 

func (UpdateResponse) WaitHandler(ctx context.Context, c *ClientWithResponses, projectID, instanceID string) *wait.Handler

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.