credentials

package
v1.29.7 Latest Latest
Warning

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

 Go to latest Published: Feb 25, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package credentials 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 NewDeleteRequest 

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

NewDeleteRequest generates requests for Delete

func NewGetCredentialByIDRequest added in v1.23.0 

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

NewGetCredentialByIDRequest generates requests for GetCredentialByID

func NewGetRequest 

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

NewGetRequest generates requests for Get

func NewPostRequest 

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

NewPostRequest generates requests for Post

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

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

func (*Client) GetCredentialByIDRaw added in v1.23.0 

func (c *Client) GetCredentialByIDRaw(ctx context.Context, projectID string, instanceID string, credentialID 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) PostRaw 

func (c *Client) PostRaw(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) Delete 

func (c *ClientWithResponses) Delete(ctx context.Context, projectID string, instanceID string, credentialID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)

Delete request returning *DeleteResponse

func (*ClientWithResponses) Get 

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

Get request returning *GetResponse

func (*ClientWithResponses) GetCredentialByID added in v1.23.0 

func (c *ClientWithResponses) GetCredentialByID(ctx context.Context, projectID string, instanceID string, credentialID string, reqEditors ...RequestEditorFn) (*GetCredentialByIDResponse, error)

GetCredentialByID request returning *GetCredentialByIDResponse

func (*ClientWithResponses) ParseDeleteResponse 

func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)

ParseDeleteResponse parses an HTTP response from a Delete call

func (*ClientWithResponses) ParseGetCredentialByIDResponse added in v1.23.0 

func (c *ClientWithResponses) ParseGetCredentialByIDResponse(rsp *http.Response) (*GetCredentialByIDResponse, error)

ParseGetCredentialByIDResponse parses an HTTP response from a GetCredentialByID call

func (*ClientWithResponses) ParseGetResponse 

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

ParseGetResponse parses an HTTP response from a Get call

func (*ClientWithResponses) ParsePostResponse 

func (c *ClientWithResponses) ParsePostResponse(rsp *http.Response) (*PostResponse, error)

ParsePostResponse parses an HTTP response from a Post call

func (*ClientWithResponses) Post 

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

Post request returning *PostResponse

type ClientWithResponsesInterface 

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

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

	// Delete request
	Delete(ctx context.Context, projectID string, instanceID string, credentialID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)

	// GetCredentialByID request
	GetCredentialByID(ctx context.Context, projectID string, instanceID string, credentialID string, reqEditors ...RequestEditorFn) (*GetCredentialByIDResponse, error)
}

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

type Credentials 

type Credentials struct {
	Host      string    `json:"host"`
	Hosts     *[]string `json:"hosts,omitempty"`
	Name      *string   `json:"name,omitempty"`
	Password  string    `json:"password"`
	Port      *int      `json:"port,omitempty"`
	Protocols *Object   `json:"protocols,omitempty"`
	Uri       *string   `json:"uri,omitempty"`
	Username  string    `json:"username"`
}

Credentials defines model for Credentials.

type CredentialsList 

type CredentialsList struct {
	CredentialsList []CredentialsListItem `json:"credentialsList"`
}

CredentialsList defines model for CredentialsList.

type CredentialsListItem 

type CredentialsListItem struct {
	ID string `json:"id"`
}

CredentialsListItem defines model for CredentialsListItem.

type CredentialsResponse 

type CredentialsResponse struct {
	ID  string          `json:"id"`
	Raw *RawCredentials `json:"raw,omitempty"`
	Uri string          `json:"uri"`
}

CredentialsResponse defines model for CredentialsResponse.

type DeleteResponse 

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

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

Error defines model for Error.

type GetCredentialByIDResponse added in v1.23.0 

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

func (GetCredentialByIDResponse) Status added in v1.23.0 

func (r GetCredentialByIDResponse) Status() string

Status returns HTTPResponse.Status

func (GetCredentialByIDResponse) StatusCode added in v1.23.0 

func (r GetCredentialByIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetResponse 

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

type NotFound = Error

NotFound defines model for NotFound.

type Object 

type Object = map[string]interface{}

Object defines model for Object.

type PostResponse 

type PostResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CredentialsResponse
	JSON400      *Error
	Error        error // Aggregated error
}

func (PostResponse) Status 

func (r PostResponse) Status() string

Status returns HTTPResponse.Status

func (PostResponse) StatusCode 

func (r PostResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RawCredentials 

type RawCredentials struct {
	Credentials     Credentials `json:"credentials"`
	RouteServiceUrl string      `json:"routeServiceUrl"`
	SyslogDrainUrl  string      `json:"syslogDrainUrl"`
	VolumeMounts    *[]Object   `json:"volumeMounts,omitempty"`
}

RawCredentials defines model for RawCredentials.

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.