runtimegroups

package
v2.12.5 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (
	AccessTokenScopes         = "accessToken.Scopes"
	PersonalAccessTokenScopes = "personalAccessToken.Scopes"
)

Variables

This section is empty.

Functions

func NewCreateRuntimeGroupRequest 

func NewCreateRuntimeGroupRequest(server string, body CreateRuntimeGroupJSONRequestBody) (*http.Request, error)

NewCreateRuntimeGroupRequest calls the generic CreateRuntimeGroup builder with application/json body

func NewCreateRuntimeGroupRequestWithBody 

func NewCreateRuntimeGroupRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateRuntimeGroupRequestWithBody generates requests for CreateRuntimeGroup with any type of body

func NewDeleteRuntimeGroupRequest 

func NewDeleteRuntimeGroupRequest(server string, id openapi_types.UUID) (*http.Request, error)

NewDeleteRuntimeGroupRequest generates requests for DeleteRuntimeGroup

func NewGetRuntimeGroupRequest 

func NewGetRuntimeGroupRequest(server string, id openapi_types.UUID) (*http.Request, error)

NewGetRuntimeGroupRequest generates requests for GetRuntimeGroup

func NewListRuntimeGroupsRequest 

func NewListRuntimeGroupsRequest(server string, params *ListRuntimeGroupsParams) (*http.Request, error)

NewListRuntimeGroupsRequest generates requests for ListRuntimeGroups

func NewUpdateRuntimeGroupRequest 

func NewUpdateRuntimeGroupRequest(server string, id openapi_types.UUID, body UpdateRuntimeGroupJSONRequestBody) (*http.Request, error)

NewUpdateRuntimeGroupRequest calls the generic UpdateRuntimeGroup builder with application/json body

func NewUpdateRuntimeGroupRequestWithBody 

func NewUpdateRuntimeGroupRequestWithBody(server string, id openapi_types.UUID, contentType string, body io.Reader) (*http.Request, error)

NewUpdateRuntimeGroupRequestWithBody generates requests for UpdateRuntimeGroup with any type of 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) CreateRuntimeGroup 

func (c *Client) CreateRuntimeGroup(ctx context.Context, body CreateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateRuntimeGroupWithBody 

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

func (*Client) DeleteRuntimeGroup 

func (c *Client) DeleteRuntimeGroup(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRuntimeGroup 

func (c *Client) GetRuntimeGroup(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListRuntimeGroups 

func (c *Client) ListRuntimeGroups(ctx context.Context, params *ListRuntimeGroupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRuntimeGroup 

func (c *Client) UpdateRuntimeGroup(ctx context.Context, id openapi_types.UUID, body UpdateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateRuntimeGroupWithBody 

func (c *Client) UpdateRuntimeGroupWithBody(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// ListRuntimeGroups request
	ListRuntimeGroups(ctx context.Context, params *ListRuntimeGroupsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRuntimeGroup request with any body
	CreateRuntimeGroupWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateRuntimeGroup(ctx context.Context, body CreateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRuntimeGroup request
	DeleteRuntimeGroup(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRuntimeGroup request
	GetRuntimeGroup(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRuntimeGroup request with any body
	UpdateRuntimeGroupWithBody(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateRuntimeGroup(ctx context.Context, id openapi_types.UUID, body UpdateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

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

func (c *ClientWithResponses) CreateRuntimeGroupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRuntimeGroupHTTPResponse, error)

CreateRuntimeGroupWithBodyWithResponse request with arbitrary body returning *CreateRuntimeGroupHTTPResponse

func (*ClientWithResponses) CreateRuntimeGroupWithResponse 

func (c *ClientWithResponses) CreateRuntimeGroupWithResponse(ctx context.Context, body CreateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRuntimeGroupHTTPResponse, error)

func (*ClientWithResponses) DeleteRuntimeGroupWithResponse 

func (c *ClientWithResponses) DeleteRuntimeGroupWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteRuntimeGroupHTTPResponse, error)

DeleteRuntimeGroupWithResponse request returning *DeleteRuntimeGroupHTTPResponse

func (*ClientWithResponses) GetRuntimeGroupWithResponse 

func (c *ClientWithResponses) GetRuntimeGroupWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetRuntimeGroupHTTPResponse, error)

GetRuntimeGroupWithResponse request returning *GetRuntimeGroupHTTPResponse

func (*ClientWithResponses) ListRuntimeGroupsWithResponse 

func (c *ClientWithResponses) ListRuntimeGroupsWithResponse(ctx context.Context, params *ListRuntimeGroupsParams, reqEditors ...RequestEditorFn) (*ListRuntimeGroupsHTTPResponse, error)

ListRuntimeGroupsWithResponse request returning *ListRuntimeGroupsHTTPResponse

func (*ClientWithResponses) UpdateRuntimeGroupWithBodyWithResponse 

func (c *ClientWithResponses) UpdateRuntimeGroupWithBodyWithResponse(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRuntimeGroupHTTPResponse, error)

UpdateRuntimeGroupWithBodyWithResponse request with arbitrary body returning *UpdateRuntimeGroupHTTPResponse

func (*ClientWithResponses) UpdateRuntimeGroupWithResponse 

func (c *ClientWithResponses) UpdateRuntimeGroupWithResponse(ctx context.Context, id openapi_types.UUID, body UpdateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRuntimeGroupHTTPResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// ListRuntimeGroups request
	ListRuntimeGroupsWithResponse(ctx context.Context, params *ListRuntimeGroupsParams, reqEditors ...RequestEditorFn) (*ListRuntimeGroupsHTTPResponse, error)

	// CreateRuntimeGroup request with any body
	CreateRuntimeGroupWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRuntimeGroupHTTPResponse, error)

	CreateRuntimeGroupWithResponse(ctx context.Context, body CreateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRuntimeGroupHTTPResponse, error)

	// DeleteRuntimeGroup request
	DeleteRuntimeGroupWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteRuntimeGroupHTTPResponse, error)

	// GetRuntimeGroup request
	GetRuntimeGroupWithResponse(ctx context.Context, id openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetRuntimeGroupHTTPResponse, error)

	// UpdateRuntimeGroup request with any body
	UpdateRuntimeGroupWithBodyWithResponse(ctx context.Context, id openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRuntimeGroupHTTPResponse, error)

	UpdateRuntimeGroupWithResponse(ctx context.Context, id openapi_types.UUID, body UpdateRuntimeGroupJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRuntimeGroupHTTPResponse, 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 CreateRuntimeGroupHTTPResponse 

type CreateRuntimeGroupHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *RuntimeGroup
	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 ParseCreateRuntimeGroupHTTPResponse 

func ParseCreateRuntimeGroupHTTPResponse(rsp *http.Response) (*CreateRuntimeGroupHTTPResponse, error)

ParseCreateRuntimeGroupHTTPResponse parses an HTTP response from a CreateRuntimeGroupWithResponse call

func (CreateRuntimeGroupHTTPResponse) Status 

func (r CreateRuntimeGroupHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (CreateRuntimeGroupHTTPResponse) StatusCode 

func (r CreateRuntimeGroupHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRuntimeGroupJSONRequestBody 

type CreateRuntimeGroupJSONRequestBody = CreateRuntimeGroupRequest

CreateRuntimeGroupJSONRequestBody defines body for CreateRuntimeGroup for application/json ContentType.

type CreateRuntimeGroupRequest 

type CreateRuntimeGroupRequest struct {
	// Description The description of the runtime group in Konnect.
	Description *string `json:"description,omitempty"`

	// Labels Labels to facilitate tagged search on runtime groups. 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 runtime group.
	Name string `json:"name"`

	// ClusterType is the type of cluster this runtime group is associated with.
	ClusterType ClusterType `json:"cluster_type,omitempty"`
}

CreateRuntimeGroupRequest The request schema for the create runtime group request.

type CreateRuntimeGroupResponse 

type CreateRuntimeGroupResponse = RuntimeGroup

CreateRuntimeGroupResponse The runtime group object contains information about a Kong control plane.

type DeleteRuntimeGroupHTTPResponse 

type DeleteRuntimeGroupHTTPResponse 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 ParseDeleteRuntimeGroupHTTPResponse 

func ParseDeleteRuntimeGroupHTTPResponse(rsp *http.Response) (*DeleteRuntimeGroupHTTPResponse, error)

ParseDeleteRuntimeGroupHTTPResponse parses an HTTP response from a DeleteRuntimeGroupWithResponse call

func (DeleteRuntimeGroupHTTPResponse) Status 

func (r DeleteRuntimeGroupHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteRuntimeGroupHTTPResponse) StatusCode 

func (r DeleteRuntimeGroupHTTPResponse) 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 GetRuntimeGroupHTTPResponse 

type GetRuntimeGroupHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *RuntimeGroup
	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 ParseGetRuntimeGroupHTTPResponse 

func ParseGetRuntimeGroupHTTPResponse(rsp *http.Response) (*GetRuntimeGroupHTTPResponse, error)

ParseGetRuntimeGroupHTTPResponse parses an HTTP response from a GetRuntimeGroupWithResponse call

func (GetRuntimeGroupHTTPResponse) Status 

func (r GetRuntimeGroupHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (GetRuntimeGroupHTTPResponse) StatusCode 

func (r GetRuntimeGroupHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Labels 

type Labels map[string]string

Labels Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.

type ListRuntimeGroupsHTTPResponse 

type ListRuntimeGroupsHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *[]RuntimeGroup `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 ParseListRuntimeGroupsHTTPResponse 

func ParseListRuntimeGroupsHTTPResponse(rsp *http.Response) (*ListRuntimeGroupsHTTPResponse, error)

ParseListRuntimeGroupsHTTPResponse parses an HTTP response from a ListRuntimeGroupsWithResponse call

func (ListRuntimeGroupsHTTPResponse) Status 

func (r ListRuntimeGroupsHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (ListRuntimeGroupsHTTPResponse) StatusCode 

func (r ListRuntimeGroupsHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListRuntimeGroupsParams 

type ListRuntimeGroupsParams 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"`
}

ListRuntimeGroupsParams defines parameters for ListRuntimeGroups.

type ListRuntimeGroupsResponse 

type ListRuntimeGroupsResponse struct {
	Data *[]RuntimeGroup `json:"data,omitempty"`

	// Meta Returns pagination information
	Meta *PaginatedMeta `json:"meta,omitempty"`
}

ListRuntimeGroupsResponse defines model for ListRuntimeGroupsResponse.

type PageNumber 

type PageNumber = int

PageNumber defines model for PageNumber.

type PageSize 

type PageSize = int

PageSize defines model for PageSize.

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 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RetrieveRuntimeGroupResponse 

type RetrieveRuntimeGroupResponse = RuntimeGroup

RetrieveRuntimeGroupResponse The runtime group object contains information about a Kong control plane.

type RuntimeGroup 

type RuntimeGroup 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 runtime group creation date.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Description The description of the runtime group in Konnect.
	Description *string `json:"description,omitempty"`

	// Id The runtime group ID.
	Id *openapi_types.UUID `json:"id,omitempty"`

	// Labels Labels to facilitate tagged search on runtime groups. 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 runtime group.
	Name *string `json:"name,omitempty"`

	// UpdatedAt An ISO-8604 timestamp representation of runtime group update date.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}

RuntimeGroup The runtime group 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 UpdateRuntimeGroupHTTPResponse 

type UpdateRuntimeGroupHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *RuntimeGroup
	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 ParseUpdateRuntimeGroupHTTPResponse 

func ParseUpdateRuntimeGroupHTTPResponse(rsp *http.Response) (*UpdateRuntimeGroupHTTPResponse, error)

ParseUpdateRuntimeGroupHTTPResponse parses an HTTP response from a UpdateRuntimeGroupWithResponse call

func (UpdateRuntimeGroupHTTPResponse) Status 

func (r UpdateRuntimeGroupHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateRuntimeGroupHTTPResponse) StatusCode 

func (r UpdateRuntimeGroupHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateRuntimeGroupJSONRequestBody 

type UpdateRuntimeGroupJSONRequestBody = UpdateRuntimeGroupRequest

UpdateRuntimeGroupJSONRequestBody defines body for UpdateRuntimeGroup for application/json ContentType.

type UpdateRuntimeGroupRequest 

type UpdateRuntimeGroupRequest struct {
	// Description The description of the runtime group in Konnect.
	Description *string `json:"description,omitempty"`

	// Labels Labels to facilitate tagged search on runtime groups. 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 runtime group.
	Name *string `json:"name,omitempty"`
}

UpdateRuntimeGroupRequest The request schema for the update runtime group request.

type UpdateRuntimeGroupResponse 

type UpdateRuntimeGroupResponse = RuntimeGroup

UpdateRuntimeGroupResponse The runtime group object contains information about a Kong control plane.

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.