Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
 - func NewCreateControlPlaneRequest(server string, body CreateControlPlaneJSONRequestBody) (*http.Request, error)
 - func NewCreateControlPlaneRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
 - func NewDeleteControlPlaneRequest(server string, id openapi_types.UUID) (*http.Request, error)
 - func NewGetControlPlaneRequest(server string, id openapi_types.UUID) (*http.Request, error)
 - func NewListControlPlanesRequest(server string, params *ListControlPlanesParams) (*http.Request, error)
 - func NewUpdateControlPlaneRequest(server string, id openapi_types.UUID, body UpdateControlPlaneJSONRequestBody) (*http.Request, error)
 - func NewUpdateControlPlaneRequestWithBody(server string, id openapi_types.UUID, contentType string, body io.Reader) (*http.Request, error)
 - type AdditionalErrorInformation
 - type AdditionalErrorInformation_Item
 - func (a AdditionalErrorInformation_Item) Get(fieldName string) (value interface{}, found bool)
 - func (a AdditionalErrorInformation_Item) MarshalJSON() ([]byte, error)
 - func (a *AdditionalErrorInformation_Item) Set(fieldName string, value interface{})
 - func (a *AdditionalErrorInformation_Item) UnmarshalJSON(b []byte) error
 
- type Client
 - func (c *Client) CreateControlPlane(ctx context.Context, body CreateControlPlaneJSONRequestBody, ...) (*http.Response, error)
 - func (c *Client) CreateControlPlaneWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
 - func (c *Client) DeleteControlPlane(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
 - func (c *Client) GetControlPlane(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
 - func (c *Client) ListControlPlanes(ctx context.Context, params *ListControlPlanesParams, ...) (*http.Response, error)
 - func (c *Client) UpdateControlPlane(ctx context.Context, id openapi_types.UUID, ...) (*http.Response, error)
 - func (c *Client) UpdateControlPlaneWithBody(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, ...) (*http.Response, error)
 
- type ClientInterface
 - type ClientOption
 - type ClientWithResponses
 - func (c *ClientWithResponses) CreateControlPlaneWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateControlPlaneHTTPResponse, error)
 - func (c *ClientWithResponses) CreateControlPlaneWithResponse(ctx context.Context, body CreateControlPlaneJSONRequestBody, ...) (*CreateControlPlaneHTTPResponse, error)
 - func (c *ClientWithResponses) DeleteControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteControlPlaneHTTPResponse, error)
 - func (c *ClientWithResponses) GetControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetControlPlaneHTTPResponse, error)
 - func (c *ClientWithResponses) ListControlPlanesWithResponse(ctx context.Context, params *ListControlPlanesParams, ...) (*ListControlPlanesHTTPResponse, error)
 - func (c *ClientWithResponses) UpdateControlPlaneWithBodyWithResponse(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, ...) (*UpdateControlPlaneHTTPResponse, error)
 - func (c *ClientWithResponses) UpdateControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, ...) (*UpdateControlPlaneHTTPResponse, error)
 
- type ClientWithResponsesInterface
 - type ClusterType
 - type ControlPlane
 - type CreateControlPlaneHTTPResponse
 - type CreateControlPlaneJSONRequestBody
 - type CreateControlPlaneRequest
 - type CreateControlPlaneResponse
 - type DeleteControlPlaneHTTPResponse
 - type FilterByNameContains
 - type FilterByNameEquality
 - type FilterByNameEqualityShort
 - type GetControlPlaneHTTPResponse
 - type HttpRequestDoer
 - type Labels
 - type ListControlPlanesHTTPResponse
 - type ListControlPlanesParams
 - type ListControlPlanesResponse
 - type PageNumber
 - type PageSize
 - type PaginatedMeta
 - type RequestEditorFn
 - type RetrieveControlPlaneResponse
 - type Status400
 - type Status401
 - type Status403
 - type Status404
 - type Status409
 - type Status500
 - type Status503
 - type UpdateControlPlaneHTTPResponse
 - type UpdateControlPlaneJSONRequestBody
 - type UpdateControlPlaneRequest
 - type UpdateControlPlaneResponse
 
Constants ¶
const ( AccessTokenScopes = "accessToken.Scopes" PersonalAccessTokenScopes = "personalAccessToken.Scopes" )
Variables ¶
This section is empty.
Functions ¶
func NewCreateControlPlaneRequest ¶
func NewCreateControlPlaneRequest(server string, body CreateControlPlaneJSONRequestBody) (*http.Request, error)
NewCreateControlPlaneRequest calls the generic CreateControlPlane builder with application/json body
func NewCreateControlPlaneRequestWithBody ¶
func NewCreateControlPlaneRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateControlPlaneRequestWithBody generates requests for CreateControlPlane with any type of body
func NewDeleteControlPlaneRequest ¶
NewDeleteControlPlaneRequest generates requests for DeleteControlPlane
func NewGetControlPlaneRequest ¶
NewGetControlPlaneRequest generates requests for GetControlPlane
func NewListControlPlanesRequest ¶
func NewListControlPlanesRequest(server string, params *ListControlPlanesParams) (*http.Request, error)
NewListControlPlanesRequest generates requests for ListControlPlanes
func NewUpdateControlPlaneRequest ¶
func NewUpdateControlPlaneRequest(server string, id openapi_types.UUID, body UpdateControlPlaneJSONRequestBody) (*http.Request, error)
NewUpdateControlPlaneRequest calls the generic UpdateControlPlane builder with application/json body
Types ¶
type AdditionalErrorInformation ¶
type AdditionalErrorInformation = []AdditionalErrorInformation_Item
AdditionalErrorInformation An array of objects that contains information related to the error response.
type AdditionalErrorInformation_Item ¶
type AdditionalErrorInformation_Item struct {
	Field                *string                `json:"field,omitempty"`
	Reason               *string                `json:"reason,omitempty"`
	Rule                 *string                `json:"rule,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}
    AdditionalErrorInformation_Item defines model for AdditionalErrorInformation.Item.
func (AdditionalErrorInformation_Item) Get ¶
func (a AdditionalErrorInformation_Item) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for AdditionalErrorInformation_Item. Returns the specified element and whether it was found
func (AdditionalErrorInformation_Item) MarshalJSON ¶
func (a AdditionalErrorInformation_Item) MarshalJSON() ([]byte, error)
Override default JSON handling for AdditionalErrorInformation_Item to handle AdditionalProperties
func (*AdditionalErrorInformation_Item) Set ¶
func (a *AdditionalErrorInformation_Item) Set(fieldName string, value interface{})
Setter for additional properties for AdditionalErrorInformation_Item
func (*AdditionalErrorInformation_Item) UnmarshalJSON ¶
func (a *AdditionalErrorInformation_Item) UnmarshalJSON(b []byte) error
Override default JSON handling for AdditionalErrorInformation_Item to handle AdditionalProperties
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 HttpRequestDoer
	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}
    Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) CreateControlPlane ¶
func (c *Client) CreateControlPlane(ctx context.Context, body CreateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateControlPlaneWithBody ¶
func (*Client) DeleteControlPlane ¶
func (c *Client) DeleteControlPlane(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetControlPlane ¶
func (c *Client) GetControlPlane(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ListControlPlanes ¶
func (c *Client) ListControlPlanes(ctx context.Context, params *ListControlPlanesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateControlPlane ¶
func (c *Client) UpdateControlPlane(ctx context.Context, id openapi_types.UUID, body UpdateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateControlPlaneWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
	// ListControlPlanes request
	ListControlPlanes(ctx context.Context, params *ListControlPlanesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
	// CreateControlPlane request with any body
	CreateControlPlaneWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
	CreateControlPlane(ctx context.Context, body CreateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
	// DeleteControlPlane request
	DeleteControlPlane(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
	// GetControlPlane request
	GetControlPlane(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
	// UpdateControlPlane request with any body
	UpdateControlPlaneWithBody(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
	UpdateControlPlane(ctx context.Context, id openapi_types.UUID, body UpdateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
    The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
	ClientInterface
}
    ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) CreateControlPlaneWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateControlPlaneWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateControlPlaneHTTPResponse, error)
CreateControlPlaneWithBodyWithResponse request with arbitrary body returning *CreateControlPlaneHTTPResponse
func (*ClientWithResponses) CreateControlPlaneWithResponse ¶
func (c *ClientWithResponses) CreateControlPlaneWithResponse(ctx context.Context, body CreateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateControlPlaneHTTPResponse, error)
func (*ClientWithResponses) DeleteControlPlaneWithResponse ¶
func (c *ClientWithResponses) DeleteControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteControlPlaneHTTPResponse, error)
DeleteControlPlaneWithResponse request returning *DeleteControlPlaneHTTPResponse
func (*ClientWithResponses) GetControlPlaneWithResponse ¶
func (c *ClientWithResponses) GetControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetControlPlaneHTTPResponse, error)
GetControlPlaneWithResponse request returning *GetControlPlaneHTTPResponse
func (*ClientWithResponses) ListControlPlanesWithResponse ¶
func (c *ClientWithResponses) ListControlPlanesWithResponse(ctx context.Context, params *ListControlPlanesParams, reqEditors ...RequestEditorFn) (*ListControlPlanesHTTPResponse, error)
ListControlPlanesWithResponse request returning *ListControlPlanesHTTPResponse
func (*ClientWithResponses) UpdateControlPlaneWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateControlPlaneWithBodyWithResponse(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateControlPlaneHTTPResponse, error)
UpdateControlPlaneWithBodyWithResponse request with arbitrary body returning *UpdateControlPlaneHTTPResponse
func (*ClientWithResponses) UpdateControlPlaneWithResponse ¶
func (c *ClientWithResponses) UpdateControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, body UpdateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateControlPlaneHTTPResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
	// ListControlPlanes request
	ListControlPlanesWithResponse(ctx context.Context, params *ListControlPlanesParams, reqEditors ...RequestEditorFn) (*ListControlPlanesHTTPResponse, error)
	// CreateControlPlane request with any body
	CreateControlPlaneWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateControlPlaneHTTPResponse, error)
	CreateControlPlaneWithResponse(ctx context.Context, body CreateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateControlPlaneHTTPResponse, error)
	// DeleteControlPlane request
	DeleteControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteControlPlaneHTTPResponse, error)
	// GetControlPlane request
	GetControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetControlPlaneHTTPResponse, error)
	// UpdateControlPlane request with any body
	UpdateControlPlaneWithBodyWithResponse(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateControlPlaneHTTPResponse, error)
	UpdateControlPlaneWithResponse(ctx context.Context, id openapi_types.UUID, body UpdateControlPlaneJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateControlPlaneHTTPResponse, error)
}
    ClientWithResponsesInterface is the interface specification for the client with responses above.
type ClusterType ¶
type ClusterType string
const (
	ClusterTypeKubernetesIngressController ClusterType = "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER"
)
    type ControlPlane ¶
type ControlPlane struct {
	// Config CP configuration object for related access endpoints.
	Config *struct {
		// ControlPlaneEndpoint Control Plane Endpoint.
		ControlPlaneEndpoint *string `json:"control_plane_endpoint,omitempty"`
		// TelemetryEndpoint Telemetry Endpoint.
		TelemetryEndpoint *string `json:"telemetry_endpoint,omitempty"`
	} `json:"config,omitempty"`
	// CreatedAt An ISO-8604 timestamp representation of control plane creation date.
	CreatedAt *time.Time `json:"created_at,omitempty"`
	// Description The description of the control plane in Konnect.
	Description *string `json:"description,omitempty"`
	// Id The control plane ID.
	Id *openapi_types.UUID `json:"id,omitempty"`
	// Labels Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.
	Labels *Labels `json:"labels,omitempty"`
	// Name The name of the control plane.
	Name *string `json:"name,omitempty"`
	// UpdatedAt An ISO-8604 timestamp representation of control plane update date.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
    ControlPlane The control plane object contains information about a Kong control plane.
type CreateControlPlaneHTTPResponse ¶
type CreateControlPlaneHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *ControlPlane
	JSON400      *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback ID.
		Instance *string `json:"instance,omitempty"`
		// InvalidParameters An array of objects that contains information related to the error response.
		InvalidParameters *AdditionalErrorInformation `json:"invalid_parameters,omitempty"`
		// Status The HTTP response code
		Status Status400 `json:"status"`
		// Title The Error response
		Title string `json:"title"`
	}
	JSON401 *struct {
		// Detail Details about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status401 `json:"status"`
		// Title The Error Response.
		Title string `json:"title"`
	}
	JSON403 *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance Konnect traceback error code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status403 `json:"status"`
		// Title HTTP status code
		Title string `json:"title"`
	}
	JSON409 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status409 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
	JSON500 *struct {
		// Details Details about the error.
		Details *string `json:"details,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status500 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
	JSON503 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status503 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
}
    func ParseCreateControlPlaneHTTPResponse ¶
func ParseCreateControlPlaneHTTPResponse(rsp *http.Response) (*CreateControlPlaneHTTPResponse, error)
ParseCreateControlPlaneHTTPResponse parses an HTTP response from a CreateControlPlaneWithResponse call
func (CreateControlPlaneHTTPResponse) Status ¶
func (r CreateControlPlaneHTTPResponse) Status() string
Status returns HTTPResponse.Status
func (CreateControlPlaneHTTPResponse) StatusCode ¶
func (r CreateControlPlaneHTTPResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateControlPlaneJSONRequestBody ¶
type CreateControlPlaneJSONRequestBody = CreateControlPlaneRequest
CreateControlPlaneJSONRequestBody defines body for CreateControlPlane for application/json ContentType.
type CreateControlPlaneRequest ¶
type CreateControlPlaneRequest struct {
	// Description The description of the control plane in Konnect.
	Description *string `json:"description,omitempty"`
	// Labels Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.
	Labels *Labels `json:"labels,omitempty"`
	// Name The name of the control plane.
	Name string `json:"name"`
	// ClusterType is the type of cluster this control plane is associated with.
	ClusterType ClusterType `json:"cluster_type,omitempty"`
}
    CreateControlPlaneRequest The request schema for the create control plane request.
type CreateControlPlaneResponse ¶
type CreateControlPlaneResponse = ControlPlane
CreateControlPlaneResponse The control plane object contains information about a Kong control plane.
type DeleteControlPlaneHTTPResponse ¶
type DeleteControlPlaneHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback ID.
		Instance *string `json:"instance,omitempty"`
		// InvalidParameters An array of objects that contains information related to the error response.
		InvalidParameters *AdditionalErrorInformation `json:"invalid_parameters,omitempty"`
		// Status The HTTP response code
		Status Status400 `json:"status"`
		// Title The Error response
		Title string `json:"title"`
	}
	JSON401 *struct {
		// Detail Details about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status401 `json:"status"`
		// Title The Error Response.
		Title string `json:"title"`
	}
	JSON403 *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance Konnect traceback error code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status403 `json:"status"`
		// Title HTTP status code
		Title string `json:"title"`
	}
	JSON404 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status404 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
	JSON500 *struct {
		// Details Details about the error.
		Details *string `json:"details,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status500 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
	JSON503 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status503 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
}
    func ParseDeleteControlPlaneHTTPResponse ¶
func ParseDeleteControlPlaneHTTPResponse(rsp *http.Response) (*DeleteControlPlaneHTTPResponse, error)
ParseDeleteControlPlaneHTTPResponse parses an HTTP response from a DeleteControlPlaneWithResponse call
func (DeleteControlPlaneHTTPResponse) Status ¶
func (r DeleteControlPlaneHTTPResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteControlPlaneHTTPResponse) StatusCode ¶
func (r DeleteControlPlaneHTTPResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FilterByNameContains ¶
type FilterByNameContains = string
FilterByNameContains defines model for FilterByNameContains.
type FilterByNameEquality ¶
type FilterByNameEquality = string
FilterByNameEquality defines model for FilterByNameEquality.
type FilterByNameEqualityShort ¶
type FilterByNameEqualityShort = string
FilterByNameEqualityShort defines model for FilterByNameEqualityShort.
type GetControlPlaneHTTPResponse ¶
type GetControlPlaneHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ControlPlane
	JSON400      *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback ID.
		Instance *string `json:"instance,omitempty"`
		// InvalidParameters An array of objects that contains information related to the error response.
		InvalidParameters *AdditionalErrorInformation `json:"invalid_parameters,omitempty"`
		// Status The HTTP response code
		Status Status400 `json:"status"`
		// Title The Error response
		Title string `json:"title"`
	}
	JSON401 *struct {
		// Detail Details about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status401 `json:"status"`
		// Title The Error Response.
		Title string `json:"title"`
	}
	JSON403 *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance Konnect traceback error code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status403 `json:"status"`
		// Title HTTP status code
		Title string `json:"title"`
	}
	JSON404 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status404 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
	JSON503 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status503 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
}
    func ParseGetControlPlaneHTTPResponse ¶
func ParseGetControlPlaneHTTPResponse(rsp *http.Response) (*GetControlPlaneHTTPResponse, error)
ParseGetControlPlaneHTTPResponse parses an HTTP response from a GetControlPlaneWithResponse call
func (GetControlPlaneHTTPResponse) Status ¶
func (r GetControlPlaneHTTPResponse) Status() string
Status returns HTTPResponse.Status
func (GetControlPlaneHTTPResponse) StatusCode ¶
func (r GetControlPlaneHTTPResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type Labels ¶
Labels Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.
type ListControlPlanesHTTPResponse ¶
type ListControlPlanesHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *[]ControlPlane `json:"data,omitempty"`
		// Meta Returns pagination information
		Meta *PaginatedMeta `json:"meta,omitempty"`
	}
	JSON400 *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback ID.
		Instance *string `json:"instance,omitempty"`
		// InvalidParameters An array of objects that contains information related to the error response.
		InvalidParameters *AdditionalErrorInformation `json:"invalid_parameters,omitempty"`
		// Status The HTTP response code
		Status Status400 `json:"status"`
		// Title The Error response
		Title string `json:"title"`
	}
	JSON401 *struct {
		// Detail Details about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status401 `json:"status"`
		// Title The Error Response.
		Title string `json:"title"`
	}
	JSON403 *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance Konnect traceback error code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status403 `json:"status"`
		// Title HTTP status code
		Title string `json:"title"`
	}
	JSON503 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status503 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
}
    func ParseListControlPlanesHTTPResponse ¶
func ParseListControlPlanesHTTPResponse(rsp *http.Response) (*ListControlPlanesHTTPResponse, error)
ParseListControlPlanesHTTPResponse parses an HTTP response from a ListControlPlanesWithResponse call
func (ListControlPlanesHTTPResponse) Status ¶
func (r ListControlPlanesHTTPResponse) Status() string
Status returns HTTPResponse.Status
func (ListControlPlanesHTTPResponse) StatusCode ¶
func (r ListControlPlanesHTTPResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListControlPlanesParams ¶
type ListControlPlanesParams struct {
	// PageSize How many items to include in a page.
	PageSize *PageSize `form:"page[size],omitempty" json:"page[size],omitempty"`
	// PageNumber The specific page number in the collection results.
	PageNumber *PageNumber `form:"page[number],omitempty" json:"page[number],omitempty"`
	// FilterNameEq Filter by direct equality comparison of the name property with a supplied value.
	FilterNameEq *FilterByNameEquality `form:"filter[name][eq],omitempty" json:"filter[name][eq],omitempty"`
	// FilterName Filter by direct equality comparison (short-hand) of the name property with a supplied value.
	FilterName *FilterByNameEqualityShort `form:"filter[name],omitempty" json:"filter[name],omitempty"`
	// FilterNameContains Filter by contains comparison of the name property with a supplied substring
	FilterNameContains *FilterByNameContains `form:"filter[name][contains],omitempty" json:"filter[name][contains],omitempty"`
}
    ListControlPlanesParams defines parameters for ListControlPlanes.
type ListControlPlanesResponse ¶
type ListControlPlanesResponse struct {
	Data *[]ControlPlane `json:"data,omitempty"`
	// Meta Returns pagination information
	Meta *PaginatedMeta `json:"meta,omitempty"`
}
    ListControlPlanesResponse defines model for ListControlPlanesResponse.
type PaginatedMeta ¶
type PaginatedMeta struct {
	// Page Contains pagination query parameters and the total number of objects returned.
	Page *struct {
		// Number Specifies the number of objects returned per page.
		Number *int `json:"number,omitempty"`
		// Size Specifies the size of the page.
		Size *int `json:"size,omitempty"`
		// Total Integer representation of the amount of items returned.
		Total *int `json:"total,omitempty"`
	} `json:"page,omitempty"`
}
    PaginatedMeta Returns pagination information
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RetrieveControlPlaneResponse ¶
type RetrieveControlPlaneResponse = ControlPlane
RetrieveControlPlaneResponse The control plane object contains information about a Kong control plane.
type Status400 ¶
type Status400 int
Status400 The HTTP response code
const (
	N400 Status400 = 400
)
    Defines values for Status400.
type Status401 ¶
type Status401 int
Status401 The HTTP status code.
const (
	N401 Status401 = 401
)
    Defines values for Status401.
type Status403 ¶
type Status403 int
Status403 The HTTP status code.
const (
	N403 Status403 = 403
)
    Defines values for Status403.
type Status404 ¶
type Status404 int
Status404 The HTTP status code.
const (
	N404 Status404 = 404
)
    Defines values for Status404.
type Status409 ¶
type Status409 int
Status409 The HTTP status code.
const (
	N409 Status409 = 409
)
    Defines values for Status409.
type Status500 ¶
type Status500 int
Status500 The HTTP status code.
const (
	N500 Status500 = 500
)
    Defines values for Status500.
type Status503 ¶
type Status503 int
Status503 The HTTP status code.
const (
	N503 Status503 = 503
)
    Defines values for Status503.
type UpdateControlPlaneHTTPResponse ¶
type UpdateControlPlaneHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ControlPlane
	JSON400      *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback ID.
		Instance *string `json:"instance,omitempty"`
		// InvalidParameters An array of objects that contains information related to the error response.
		InvalidParameters *AdditionalErrorInformation `json:"invalid_parameters,omitempty"`
		// Status The HTTP response code
		Status Status400 `json:"status"`
		// Title The Error response
		Title string `json:"title"`
	}
	JSON401 *struct {
		// Detail Details about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status401 `json:"status"`
		// Title The Error Response.
		Title string `json:"title"`
	}
	JSON403 *struct {
		// Detail Information about the error response.
		Detail *string `json:"detail,omitempty"`
		// Instance Konnect traceback error code.
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status403 `json:"status"`
		// Title HTTP status code
		Title string `json:"title"`
	}
	JSON404 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status404 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
	JSON500 *struct {
		// Details Details about the error.
		Details *string `json:"details,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status500 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
	JSON503 *struct {
		// Detail Details about the error.
		Detail *string `json:"detail,omitempty"`
		// Instance The Konnect traceback code
		Instance *string `json:"instance,omitempty"`
		// Status The HTTP status code.
		Status Status503 `json:"status"`
		// Title The error response code.
		Title string `json:"title"`
	}
}
    func ParseUpdateControlPlaneHTTPResponse ¶
func ParseUpdateControlPlaneHTTPResponse(rsp *http.Response) (*UpdateControlPlaneHTTPResponse, error)
ParseUpdateControlPlaneHTTPResponse parses an HTTP response from a UpdateControlPlaneWithResponse call
func (UpdateControlPlaneHTTPResponse) Status ¶
func (r UpdateControlPlaneHTTPResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateControlPlaneHTTPResponse) StatusCode ¶
func (r UpdateControlPlaneHTTPResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateControlPlaneJSONRequestBody ¶
type UpdateControlPlaneJSONRequestBody = UpdateControlPlaneRequest
UpdateControlPlaneJSONRequestBody defines body for UpdateControlPlane for application/json ContentType.
type UpdateControlPlaneRequest ¶
type UpdateControlPlaneRequest struct {
	// Description The description of the control plane in Konnect.
	Description *string `json:"description,omitempty"`
	// Labels Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.
	Labels *Labels `json:"labels,omitempty"`
	// Name The name of the control plane.
	Name *string `json:"name,omitempty"`
}
    UpdateControlPlaneRequest The request schema for the update control plane request.
type UpdateControlPlaneResponse ¶
type UpdateControlPlaneResponse = ControlPlane
UpdateControlPlaneResponse The control plane object contains information about a Kong control plane.