pingcheck

package
v1.29.11 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: 12 Imported by: 0

Documentation

Overview

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

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

Index

Constants

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

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, domain string) (*http.Request, error)

NewDeleteRequest generates requests for Delete

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 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 

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

func (*Client) DeleteRaw 

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

func (*Client) ListRaw 

func (c *Client) ListRaw(ctx context.Context, projectID string, instanceID string, 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) 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, domain string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)

Delete request returning *DeleteResponse

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) ParseListResponse 

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

ParseListResponse parses an HTTP response from a List call

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, domain string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
}

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

type CreateJSONBody 

type CreateJSONBody struct {
	// Url domain to check
	URL string `json:"url"`
}

CreateJSONBody defines parameters for Create.

type CreateJSONRequestBody 

type CreateJSONRequestBody CreateJSONBody

CreateJSONRequestBody defines body for Create for application/json ContentType.

type CreateResponse 

type CreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PingCheckResponse
	JSON403      *PermissionDenied
	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
	JSON200      *PingCheckResponse
	JSON403      *PermissionDenied
	JSON404      *Message
	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 ListResponse 

type ListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PingCheckResponse
	JSON403      *PermissionDenied
	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 Message 

type Message struct {
	Message string `json:"message"`
}

Message defines model for Message.

type PermissionDenied 

type PermissionDenied struct {
	Detail string `json:"detail"`
}

PermissionDenied defines model for PermissionDenied.

type PingCheckChildResponse 

type PingCheckChildResponse struct {
	URL string `json:"url"`
}

PingCheckChildResponse defines model for PingCheckChildResponse.

type PingCheckResponse 

type PingCheckResponse struct {
	Message    string                   `json:"message"`
	PingChecks []PingCheckChildResponse `json:"pingChecks"`
}

PingCheckResponse defines model for PingCheckResponse.

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.