Documentation
¶
Overview ¶
Package pingcheck 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, 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 NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
- type Client
- func (c *Client[K]) CreateRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client[K]) CreateRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- func (c *Client[K]) DeleteRaw(ctx context.Context, projectID string, instanceID string, domain string, ...) (*http.Response, error)
- func (c *Client[K]) ListRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- type ClientWithResponses
- func (c *ClientWithResponses[K]) Create(ctx context.Context, projectID string, instanceID string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) Delete(ctx context.Context, projectID string, instanceID string, domain string, ...) (*DeleteResponse, error)
- func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, instanceID string, ...) (*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]) ParseListResponse(rsp *http.Response) (*ListResponse, error)
- type ClientWithResponsesInterface
- type CreateJSONBody
- type CreateJSONRequestBody
- type CreateResponse
- type DeleteResponse
- type ListResponse
- type Message
- type PermissionDenied
- type PingCheckChildResponse
- type PingCheckResponse
- type RequestEditorFn
Constants ¶
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
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, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client[K]) CreateRawWithBody ¶
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, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error)
func (*ClientWithResponses[K]) CreateWithBody ¶
func (c *ClientWithResponses[K]) 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[K]) Delete ¶
func (c *ClientWithResponses[K]) Delete(ctx context.Context, projectID string, instanceID string, domain string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
Delete request returning *DeleteResponse
func (*ClientWithResponses[K]) List ¶
func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, instanceID string, 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]) ParseListResponse ¶
func (c *ClientWithResponses[K]) ParseListResponse(rsp *http.Response) (*ListResponse, error)
ParseListResponse parses an HTTP response from a List call
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface[K contracts.ClientFlowConfig] 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.