Documentation ¶
Overview ¶
Package instance provides primitives to interact with the openapi HTTP API.
Code generated by dev.azure.com/schwarzit/schwarzit.odj.core/_git/stackit-client-generator.git version v1.0.23 DO NOT EDIT.
Index ¶
- Constants
- func NewCreateRequest(ctx context.Context, server string, projectID string, ...) (*http.Request, error)
- func NewCreateRequestWithBody(ctx context.Context, server string, projectID string, contentType string, ...) (*http.Request, error)
- func NewDeleteRequest(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, params *ListParams) (*http.Request, error)
- func NewPatchRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewPatchRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewPutRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewPutRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- type Client
- func (c *Client[K]) CreateRaw(ctx context.Context, projectID string, body CreateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client[K]) CreateRawWithBody(ctx context.Context, projectID string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client[K]) DeleteRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client[K]) GetRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client[K]) ListRaw(ctx context.Context, projectID string, params *ListParams, ...) (*http.Response, error)
- func (c *Client[K]) PatchRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client[K]) PatchRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- func (c *Client[K]) PutRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client[K]) PutRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- type ClientWithResponses
- func (c *ClientWithResponses[K]) Create(ctx context.Context, projectID string, body CreateJSONRequestBody, ...) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) CreateWithBody(ctx context.Context, projectID string, contentType string, body io.Reader, ...) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) Delete(ctx context.Context, projectID string, instanceID string, ...) (*DeleteResponse, error)
- func (c *ClientWithResponses[K]) Get(ctx context.Context, projectID string, instanceID string, ...) (*GetResponse, error)
- func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, params *ListParams, ...) (*ListResponse, error)
- func (c *ClientWithResponses[K]) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
- func (c *ClientWithResponses[K]) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
- func (c *ClientWithResponses[K]) ParseListResponse(rsp *http.Response) (*ListResponse, error)
- func (c *ClientWithResponses[K]) ParsePatchResponse(rsp *http.Response) (*PatchResponse, error)
- func (c *ClientWithResponses[K]) ParsePutResponse(rsp *http.Response) (*PutResponse, error)
- func (c *ClientWithResponses[K]) Patch(ctx context.Context, projectID string, instanceID string, ...) (*PatchResponse, error)
- func (c *ClientWithResponses[K]) PatchWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*PatchResponse, error)
- func (c *ClientWithResponses[K]) Put(ctx context.Context, projectID string, instanceID string, ...) (*PutResponse, error)
- func (c *ClientWithResponses[K]) PutWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*PutResponse, error)
- func (c *ClientWithResponses[K]) WaitForCreateOrUpdate(ctx context.Context, projectID, instanceID string) *wait.Handler
- func (c *ClientWithResponses[K]) WaitForDelete(ctx context.Context, projectID, instanceID string) *wait.Handler
- type ClientWithResponsesInterface
- type CreateJSONRequestBody
- type CreateResponse
- type DeleteResponse
- type GetResponse
- type InstanceACL
- type InstanceCreateInstanceRequest
- type InstanceCreateInstanceResponse
- type InstanceError
- type InstanceFlavor
- type InstanceListInstance
- type InstanceListInstanceResponse
- type InstanceSingleInstance
- type InstanceStorage
- type InstanceUpdateInstanceRequest
- type InstanceUpdateInstanceResponse
- type InstancesGetInstanceResponse
- type InstancesSingleInstance
- type ListParams
- type ListResponse
- type PatchJSONRequestBody
- type PatchResponse
- type PutJSONRequestBody
- type PutResponse
- type RequestEditorFn
Constants ¶
const ( // Instance status options STATUS_READY = "READY" STATUS_FAILED = "FAILED" STATUS_PROCESSING = "PROCESSING" STATUS_UNKNOWN = "UNKNOWN" )
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
const ClientTimeoutErr = "Client.Timeout exceeded while awaiting headers"
Variables ¶
This section is empty.
Functions ¶
func NewCreateRequest ¶
func NewCreateRequest(ctx context.Context, server string, projectID string, body CreateJSONRequestBody) (*http.Request, error)
NewCreateRequest calls the generic Create builder with application/json body
func NewCreateRequestWithBody ¶
func NewCreateRequestWithBody(ctx context.Context, server string, projectID string, contentType string, body io.Reader) (*http.Request, error)
NewCreateRequestWithBody generates requests for Create with any type of body
func NewDeleteRequest ¶
func NewDeleteRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
NewDeleteRequest generates requests for Delete
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, params *ListParams) (*http.Request, error)
NewListRequest generates requests for List
func NewPatchRequest ¶
func NewPatchRequest(ctx context.Context, server string, projectID string, instanceID string, body PatchJSONRequestBody) (*http.Request, error)
NewPatchRequest calls the generic Patch builder with application/json body
func NewPatchRequestWithBody ¶
func NewPatchRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)
NewPatchRequestWithBody generates requests for Patch with any type of body
Types ¶
type Client ¶
type Client[K contracts.ClientFlowConfig] 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.ClientInterface[K] }
Client which conforms to the OpenAPI3 specification for this service.
func NewRawClient ¶
func NewRawClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *Client[K]
NewRawClient Creates a new Client, with reasonable defaults
func (*Client[K]) CreateRaw ¶
func (c *Client[K]) CreateRaw(ctx context.Context, projectID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client[K]) CreateRawWithBody ¶
func (*Client[K]) ListRaw ¶
func (c *Client[K]) ListRaw(ctx context.Context, projectID string, params *ListParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client[K]) PatchRaw ¶
func (c *Client[K]) PatchRaw(ctx context.Context, projectID string, instanceID string, body PatchJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client[K]) PatchRawWithBody ¶
type ClientWithResponses ¶
type ClientWithResponses[K contracts.ClientFlowConfig] struct { // contains filtered or unexported fields }
ClientWithResponses builds on rawClientInterface to offer response payloads
func NewClient ¶
func NewClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *ClientWithResponses[K]
NewClient creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses[K]) Create ¶
func (c *ClientWithResponses[K]) Create(ctx context.Context, projectID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error)
func (*ClientWithResponses[K]) CreateWithBody ¶
func (c *ClientWithResponses[K]) CreateWithBody(ctx context.Context, projectID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error)
CreateWithBody request with arbitrary body returning *CreateResponse
func (*ClientWithResponses[K]) Delete ¶
func (c *ClientWithResponses[K]) Delete(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
Delete request returning *DeleteResponse
func (*ClientWithResponses[K]) Get ¶
func (c *ClientWithResponses[K]) Get(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
Get request returning *GetResponse
func (*ClientWithResponses[K]) List ¶
func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, params *ListParams, reqEditors ...RequestEditorFn) (*ListResponse, error)
List request returning *ListResponse
func (*ClientWithResponses[K]) ParseCreateResponse ¶
func (c *ClientWithResponses[K]) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
ParseCreateResponse parses an HTTP response from a Create call
func (*ClientWithResponses[K]) ParseDeleteResponse ¶
func (c *ClientWithResponses[K]) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
ParseDeleteResponse parses an HTTP response from a Delete call
func (*ClientWithResponses[K]) ParseGetResponse ¶
func (c *ClientWithResponses[K]) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
ParseGetResponse parses an HTTP response from a Get call
func (*ClientWithResponses[K]) ParseListResponse ¶
func (c *ClientWithResponses[K]) ParseListResponse(rsp *http.Response) (*ListResponse, error)
ParseListResponse parses an HTTP response from a List call
func (*ClientWithResponses[K]) ParsePatchResponse ¶
func (c *ClientWithResponses[K]) ParsePatchResponse(rsp *http.Response) (*PatchResponse, error)
ParsePatchResponse parses an HTTP response from a Patch call
func (*ClientWithResponses[K]) ParsePutResponse ¶
func (c *ClientWithResponses[K]) ParsePutResponse(rsp *http.Response) (*PutResponse, error)
ParsePutResponse parses an HTTP response from a Put call
func (*ClientWithResponses[K]) Patch ¶
func (c *ClientWithResponses[K]) Patch(ctx context.Context, projectID string, instanceID string, body PatchJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchResponse, error)
func (*ClientWithResponses[K]) PatchWithBody ¶
func (c *ClientWithResponses[K]) PatchWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchResponse, error)
PatchWithBody request with arbitrary body returning *PatchResponse
func (*ClientWithResponses[K]) Put ¶
func (c *ClientWithResponses[K]) Put(ctx context.Context, projectID string, instanceID string, body PutJSONRequestBody, reqEditors ...RequestEditorFn) (*PutResponse, error)
func (*ClientWithResponses[K]) PutWithBody ¶
func (c *ClientWithResponses[K]) PutWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutResponse, error)
PutWithBody request with arbitrary body returning *PutResponse
func (*ClientWithResponses[K]) WaitForCreateOrUpdate ¶
func (c *ClientWithResponses[K]) WaitForCreateOrUpdate(ctx context.Context, projectID, instanceID string) *wait.Handler
WaitForCreateOrUpdate will wait for instance update to complete returned interface is nil
func (*ClientWithResponses[K]) WaitForDelete ¶
func (c *ClientWithResponses[K]) WaitForDelete(ctx context.Context, projectID, instanceID string) *wait.Handler
WaitHandler will wait for instance deletion returned value for deletion wait will always be nil
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface[K contracts.ClientFlowConfig] interface { // List request List(ctx context.Context, projectID string, params *ListParams, reqEditors ...RequestEditorFn) (*ListResponse, error) // Create request with any body CreateWithBody(ctx context.Context, projectID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error) Create(ctx context.Context, projectID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error) // Delete request Delete(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error) // Get request Get(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*GetResponse, error) // Patch request with any body PatchWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchResponse, error) Patch(ctx context.Context, projectID string, instanceID string, body PatchJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchResponse, error) // Put request with any body PutWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutResponse, error) Put(ctx context.Context, projectID string, instanceID string, body PutJSONRequestBody, reqEditors ...RequestEditorFn) (*PutResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CreateJSONRequestBody ¶
type CreateJSONRequestBody = InstanceCreateInstanceRequest
CreateJSONRequestBody defines body for Create for application/json ContentType.
type CreateResponse ¶
type CreateResponse struct { Body []byte HTTPResponse *http.Response JSON202 *InstanceCreateInstanceResponse JSON400 *InstanceError JSON404 *InstanceError JSON500 *InstanceError Error error // Aggregated error }
func (CreateResponse) Status ¶
func (r CreateResponse) Status() string
Status returns HTTPResponse.Status
func (CreateResponse) StatusCode ¶
func (r CreateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteResponse ¶
type DeleteResponse struct { Body []byte HTTPResponse *http.Response JSON400 *InstanceError JSON404 *InstanceError JSON500 *InstanceError Error error // Aggregated error }
func (DeleteResponse) Status ¶
func (r DeleteResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteResponse) StatusCode ¶
func (r DeleteResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetResponse ¶
type GetResponse struct { Body []byte HTTPResponse *http.Response JSON200 *InstancesGetInstanceResponse JSON400 *InstanceError JSON500 *InstanceError Error error // Aggregated error }
func (GetResponse) StatusCode ¶
func (r GetResponse) 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 *struct { // Type it must be one of "Single", "Replica", "Sharded" Type *string `json:"type,omitempty"` } `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 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"` 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 InstancesGetInstanceResponse ¶
type InstancesGetInstanceResponse struct {
Item *InstancesSingleInstance `json:"item,omitempty"`
}
InstancesGetInstanceResponse defines model for instances.GetInstanceResponse.
type InstancesSingleInstance ¶
type InstancesSingleInstance 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"` }
InstancesSingleInstance defines model for instances.SingleInstance.
type ListParams ¶
type ListParams struct { // Tag instance tag Tag string `form:"tag" json:"tag"` }
ListParams defines parameters for List.
type ListResponse ¶
type ListResponse struct { Body []byte HTTPResponse *http.Response JSON200 *InstanceListInstanceResponse JSON400 *InstanceError JSON500 *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 PatchJSONRequestBody ¶
type PatchJSONRequestBody = InstanceUpdateInstanceRequest
PatchJSONRequestBody defines body for Patch for application/json ContentType.
type PatchResponse ¶
type PatchResponse struct { Body []byte HTTPResponse *http.Response JSON202 *InstanceUpdateInstanceResponse JSON400 *InstanceError JSON404 *InstanceError JSON500 *InstanceError Error error // Aggregated error }
func (PatchResponse) Status ¶
func (r PatchResponse) Status() string
Status returns HTTPResponse.Status
func (PatchResponse) StatusCode ¶
func (r PatchResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PutJSONRequestBody ¶
type PutJSONRequestBody = InstanceUpdateInstanceRequest
PutJSONRequestBody defines body for Put for application/json ContentType.
type PutResponse ¶
type PutResponse struct { Body []byte HTTPResponse *http.Response JSON202 *InstanceUpdateInstanceResponse JSON400 *InstanceError JSON404 *InstanceError JSON500 *InstanceError Error error // Aggregated error }
func (PutResponse) StatusCode ¶
func (r PutResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode