 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package users 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
- func NewCreateRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewCreateRequestWithBody(ctx context.Context, server string, projectID string, instanceID 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, instanceID string) (*http.Request, error)
- func NewResetRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- type Client
- func (c *Client) CreateRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) CreateRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- func (c *Client) DeleteRaw(ctx context.Context, projectID string, instanceID string, userID string, ...) (*http.Response, error)
- func (c *Client) GetRaw(ctx context.Context, projectID string, instanceID string, userID string, ...) (*http.Response, error)
- func (c *Client) ListRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) ResetRaw(ctx context.Context, projectID string, instanceID string, userID string, ...) (*http.Response, error)
 
- type ClientWithResponses
- func (c *ClientWithResponses) Create(ctx context.Context, projectID string, instanceID string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses) CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses) Delete(ctx context.Context, projectID string, instanceID string, userID string, ...) (*DeleteResponse, error)
- func (c *ClientWithResponses) Get(ctx context.Context, projectID string, instanceID string, userID string, ...) (*GetResponse, error)
- func (c *ClientWithResponses) List(ctx context.Context, projectID string, instanceID string, ...) (*ListResponse, error)
- func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
- func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
- func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
- func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
- func (c *ClientWithResponses) ParseResetResponse(rsp *http.Response) (*ResetResponse, error)
- func (c *ClientWithResponses) Reset(ctx context.Context, projectID string, instanceID string, userID string, ...) (*ResetResponse, error)
 
- type ClientWithResponsesInterface
- type CreateJSONRequestBody
- type CreateResponse
- type DeleteResponse
- type GetResponse
- type InstanceCreateUserResponse
- type InstanceError
- type InstanceListUser
- type InstanceListUserResponse
- type InstanceResetUserResponse
- type InstanceUser
- type ListResponse
- type RequestEditorFn
- type ResetResponse
- type UserCreateUserRequest
- type UserGetUserResponse
- type UserResponseUser
Constants ¶
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, instanceID 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, instanceID 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, userID string) (*http.Request, error)
NewDeleteRequest generates requests for Delete
func NewGetRequest ¶
func NewGetRequest(ctx context.Context, server string, projectID string, instanceID string, userID string) (*http.Request, error)
NewGetRequest generates requests for Get
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 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) CreateRaw ¶
func (c *Client) CreateRaw(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateRawWithBody ¶
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) Create ¶
func (c *ClientWithResponses) Create(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error)
func (*ClientWithResponses) CreateWithBody ¶
func (c *ClientWithResponses) CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error)
CreateWithBody request with arbitrary body returning *CreateResponse
func (*ClientWithResponses) Delete ¶
func (c *ClientWithResponses) Delete(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
Delete request returning *DeleteResponse
func (*ClientWithResponses) Get ¶
func (c *ClientWithResponses) Get(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
Get request returning *GetResponse
func (*ClientWithResponses) List ¶
func (c *ClientWithResponses) List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)
List request returning *ListResponse
func (*ClientWithResponses) ParseCreateResponse ¶
func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
ParseCreateResponse parses an HTTP response from a Create call
func (*ClientWithResponses) ParseDeleteResponse ¶
func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
ParseDeleteResponse parses an HTTP response from a Delete 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) ParseResetResponse ¶
func (c *ClientWithResponses) ParseResetResponse(rsp *http.Response) (*ResetResponse, error)
ParseResetResponse parses an HTTP response from a Reset call
func (*ClientWithResponses) Reset ¶
func (c *ClientWithResponses) Reset(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*ResetResponse, error)
Reset request returning *ResetResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
	// List request
	List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)
	// Create request with any body
	CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error)
	Create(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error)
	// Delete request
	Delete(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
	// Get request
	Get(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
	// Reset request
	Reset(ctx context.Context, projectID string, instanceID string, userID string, reqEditors ...RequestEditorFn) (*ResetResponse, error)
}
    ClientWithResponsesInterface is the interface specification for the client with responses above.
type CreateJSONRequestBody ¶
type CreateJSONRequestBody = UserCreateUserRequest
CreateJSONRequestBody defines body for Create for application/json ContentType.
type CreateResponse ¶
type CreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *InstanceCreateUserResponse
	JSON400      *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
	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
func (*DeleteResponse) WaitHandler ¶
func (*DeleteResponse) WaitHandler(ctx context.Context, c *ClientWithResponses, projectID, instanceID, userID string) *wait.Handler
Wait will wait for user deletion returned value for deletion wait will always be nil
type GetResponse ¶
type GetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *UserGetUserResponse
	JSON400      *InstanceError
	Error        error // Aggregated error
}
    func (GetResponse) StatusCode ¶
func (r GetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type InstanceCreateUserResponse ¶
type InstanceCreateUserResponse struct {
	Item *InstanceUser `json:"item,omitempty"`
}
    InstanceCreateUserResponse defines model for instance.CreateUserResponse.
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 InstanceListUser ¶
type InstanceListUser struct {
	ID       *string `json:"id,omitempty"`
	Username *string `json:"username,omitempty"`
}
    InstanceListUser defines model for instance.ListUser.
type InstanceListUserResponse ¶
type InstanceListUserResponse struct {
	Count *int                `json:"count,omitempty"`
	Items *[]InstanceListUser `json:"items,omitempty"`
}
    InstanceListUserResponse defines model for instance.ListUserResponse.
type InstanceResetUserResponse ¶
type InstanceResetUserResponse struct {
	Item *InstanceUser `json:"item,omitempty"`
}
    InstanceResetUserResponse defines model for instance.ResetUserResponse.
type InstanceUser ¶
type InstanceUser struct {
	Database *string   `json:"database,omitempty"`
	Host     *string   `json:"host,omitempty"`
	ID       *string   `json:"id,omitempty"`
	Password *string   `json:"password,omitempty"`
	Port     *int      `json:"port,omitempty"`
	Roles    *[]string `json:"roles,omitempty"`
	URI      *string   `json:"uri,omitempty"`
	Username *string   `json:"username,omitempty"`
}
    InstanceUser defines model for instance.User.
type ListResponse ¶
type ListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceListUserResponse
	JSON400      *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 RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ResetResponse ¶
type ResetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *InstanceResetUserResponse
	JSON400      *InstanceError
	JSON404      *InstanceError
	JSON500      *InstanceError
	Error        error // Aggregated error
}
    func (ResetResponse) Status ¶
func (r ResetResponse) Status() string
Status returns HTTPResponse.Status
func (ResetResponse) StatusCode ¶
func (r ResetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UserCreateUserRequest ¶
type UserCreateUserRequest struct {
	Roles    *[]string `json:"roles,omitempty"`
	Username *string   `json:"username,omitempty"`
}
    UserCreateUserRequest defines model for user.CreateUserRequest.
type UserGetUserResponse ¶
type UserGetUserResponse struct {
	Item *UserResponseUser `json:"item,omitempty"`
}
    UserGetUserResponse defines model for user.GetUserResponse.
type UserResponseUser ¶
type UserResponseUser struct {
	Host     *string   `json:"host,omitempty"`
	ID       *string   `json:"id,omitempty"`
	Port     *int      `json:"port,omitempty"`
	Roles    *[]string `json:"roles,omitempty"`
	Username *string   `json:"username,omitempty"`
}
    UserResponseUser defines model for user.ResponseUser.