types

package
v2.13.1 Latest Latest
Warning

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

Go to latest
Published: Feb 4, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Index

Constants

View Source
const (
	BasicAuthScopes  = "BasicAuth.Scopes"
	BearerAuthScopes = "BearerAuth.Scopes"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BaseStatus

type BaseStatus struct {
	Online int `json:"online"`
	Total  int `json:"total"`
}

BaseStatus defines model for BaseStatus.

type DataplaneNetworkingLayout added in v2.12.4

type DataplaneNetworkingLayout struct {
	Inbounds  []externalRef0.DataplaneInbound  `json:"inbounds"`
	Kri       string                           `json:"kri"`
	Labels    map[string]string                `json:"labels"`
	Outbounds []externalRef0.DataplaneOutbound `json:"outbounds"`
}

DataplaneNetworkingLayout Dataplane networking layout. It contains information most important information about dataplane and lists of available inbounds and outbounds

type DataplaneNetworkingLayoutResponse added in v2.12.4

type DataplaneNetworkingLayoutResponse = DataplaneNetworkingLayout

DataplaneNetworkingLayoutResponse Dataplane networking layout. It contains information most important information about dataplane and lists of available inbounds and outbounds

type DataplaneXDSConfig added in v2.10.9

type DataplaneXDSConfig struct {
	// Diff Contains a diff in a JSONPatch format between the XDS config returned in 'xds' and the current proxy XDS config.
	// By default, the field is empty. To include the diff in the response, use the `include=diff` query parameter.
	Diff *[]externalRef0.JsonPatchItem `json:"diff,omitempty"`

	// Xds The raw XDS config as an inline JSON object
	Xds map[string]interface{} `json:"xds"`
}

DataplaneXDSConfig defines model for DataplaneXDSConfig.

type DataplanesStats

type DataplanesStats struct {
	// GatewayBuiltin Builtin Gateway dataplane proxy statistics
	GatewayBuiltin FullStatus `json:"gatewayBuiltin"`

	// GatewayDelegated Delegated Gateway dataplane proxy statistics
	GatewayDelegated FullStatus `json:"gatewayDelegated"`

	// Standard Standard dataplane proxy statistics
	Standard FullStatus `json:"standard"`
}

DataplanesStats Dataplanes statistics

type FullStatus

type FullStatus struct {
	Offline           int `json:"offline"`
	Online            int `json:"online"`
	PartiallyDegraded int `json:"partiallyDegraded"`
	Total             int `json:"total"`
}

FullStatus defines model for FullStatus.

type GetDataplaneXDSConfigResponse added in v2.10.9

type GetDataplaneXDSConfigResponse = DataplaneXDSConfig

GetDataplaneXDSConfigResponse defines model for GetDataplaneXDSConfigResponse.

type GetDataplanesXdsConfigParams added in v2.10.9

type GetDataplanesXdsConfigParams struct {
	// Shadow When computing XDS config the CP take into account policies with 'kuma.io/effect: shadow' label
	Shadow *bool `form:"shadow,omitempty" json:"shadow,omitempty"`

	// Include An array of extra fields to include in the response. When `include=diff` the server computes a diff in JSONPatch format
	// between the current proxy XDS config and the config returned in the 'xds' field.
	Include *[]GetDataplanesXdsConfigParamsInclude `form:"include,omitempty" json:"include,omitempty"`
}

GetDataplanesXdsConfigParams defines parameters for GetDataplanesXdsConfig.

type GetDataplanesXdsConfigParamsInclude added in v2.10.9

type GetDataplanesXdsConfigParamsInclude string

GetDataplanesXdsConfigParamsInclude defines parameters for GetDataplanesXdsConfig.

const (
	Diff GetDataplanesXdsConfigParamsInclude = "diff"
)

Defines values for GetDataplanesXdsConfigParamsInclude.

type GlobalInsight

type GlobalInsight = SchemasGlobalInsight

GlobalInsight Global Insight contains statistics for all main resources

type GlobalInsightResponse

type GlobalInsightResponse = GlobalInsight

GlobalInsightResponse defines model for GlobalInsightResponse.

type InboundPolicyConfResponse added in v2.12.4

type InboundPolicyConfResponse = externalRef0.InboundPoliciesList

InboundPolicyConfResponse defines model for InboundPolicyConfResponse.

type Index added in v2.10.9

type Index struct {
	// BasedOnKuma In case of an alternative distribution of Kuma the Kuma version this release is based on
	BasedOnKuma *string `json:"basedOnKuma,omitempty"`

	// ClusterId A unique id to identify the cluster being connected to
	ClusterId string `json:"clusterId"`

	// Gui The path to the GUI
	Gui      string `json:"gui"`
	Hostname string `json:"hostname"`

	// InstanceId A unique id to identify the instance requested
	InstanceId string `json:"instanceId"`

	// Product The product line (Kuma for OSS, different for other distributions)
	Product string `json:"product"`

	// Version The semantic version of the server running
	Version string `json:"version"`
}

Index Some metadata about the service

type IndexResponse added in v2.10.9

type IndexResponse = Index

IndexResponse Some metadata about the service

type InspectDataplanesForPolicy

type InspectDataplanesForPolicy struct {
	Items []externalRef0.Meta `json:"items"`
	Next  *string             `json:"next,omitempty"`
	Total int                 `json:"total"`
}

InspectDataplanesForPolicy A list of proxies

type InspectDataplanesForPolicyResponse

type InspectDataplanesForPolicyResponse = InspectDataplanesForPolicy

InspectDataplanesForPolicyResponse A list of proxies

type InspectDataplanesRulesParamsResourceType

type InspectDataplanesRulesParamsResourceType string

InspectDataplanesRulesParamsResourceType defines parameters for InspectDataplanesRules.

const (
	Dataplanes   InspectDataplanesRulesParamsResourceType = "dataplanes"
	Meshgateways InspectDataplanesRulesParamsResourceType = "meshgateways"
)

Defines values for InspectDataplanesRulesParamsResourceType.

type InspectHostname added in v2.10.9

type InspectHostname struct {
	// Hostname Generated hostname
	Hostname string                `json:"hostname"`
	Zones    []InspectHostnameZone `json:"zones"`
}

InspectHostname An supported hostname along with the zones it exists in

type InspectHostnameZone added in v2.10.9

type InspectHostnameZone struct {
	Name string `json:"name"`
}

InspectHostnameZone A name of the zone in which the hostname is available

type InspectHostnames added in v2.10.9

type InspectHostnames struct {
	Items []InspectHostname `json:"items"`
	Total int               `json:"total"`
}

InspectHostnames A list of hostnames

type InspectHostnamesParamsServiceType added in v2.10.9

type InspectHostnamesParamsServiceType string

InspectHostnamesParamsServiceType defines parameters for InspectHostnames.

const (
	Meshexternalservices  InspectHostnamesParamsServiceType = "meshexternalservices"
	Meshmultizoneservices InspectHostnamesParamsServiceType = "meshmultizoneservices"
	Meshservices          InspectHostnamesParamsServiceType = "meshservices"
)

Defines values for InspectHostnamesParamsServiceType.

type InspectHostnamesResponse added in v2.10.9

type InspectHostnamesResponse = InspectHostnames

InspectHostnamesResponse A list of hostnames

type InspectMeshservicesDataplanesParams added in v2.13.0

type InspectMeshservicesDataplanesParams struct {
	// Size The max number of items to return
	Size *int `form:"size,omitempty" json:"size,omitempty"`

	// Offset The offset of result
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Name A sub string to filter resources by name
	Name *string `form:"name,omitempty" json:"name,omitempty"`
}

InspectMeshservicesDataplanesParams defines parameters for InspectMeshservicesDataplanes.

type InspectResourcesParams

type InspectResourcesParams struct {
	// Size The max number of items to return
	Size *int `form:"size,omitempty" json:"size,omitempty"`

	// Offset The offset of result
	Offset *int `form:"offset,omitempty" json:"offset,omitempty"`

	// Name A sub string to filter resources by name
	Name *string `form:"name,omitempty" json:"name,omitempty"`
}

InspectResourcesParams defines parameters for InspectResources.

type InspectRules

type InspectRules struct {
	HttpMatches []externalRef0.HttpMatch   `json:"httpMatches"`
	Resource    externalRef0.Meta          `json:"resource"`
	Rules       []externalRef0.InspectRule `json:"rules"`
}

InspectRules A list of rules for a dataplane

type InspectRulesResponse

type InspectRulesResponse = InspectRules

InspectRulesResponse A list of rules for a dataplane

type MeshesStats

type MeshesStats struct {
	// Total Number of meshes
	Total int `json:"total"`
}

MeshesStats Mesh statistics

type OutboundPolicyConfResponse added in v2.12.4

type OutboundPolicyConfResponse = externalRef0.PoliciesList

OutboundPolicyConfResponse defines model for OutboundPolicyConfResponse.

type PoliciesStats

type PoliciesStats struct {
	// Total Number of policies
	Total int `json:"total"`
}

PoliciesStats Policies statistics

type ProxyPolicyConfResponse added in v2.12.4

type ProxyPolicyConfResponse = externalRef0.PoliciesList

ProxyPolicyConfResponse defines model for ProxyPolicyConfResponse.

type ResourceStats added in v2.10.9

type ResourceStats struct {
	// Total Number of resources
	Total int `json:"total"`
}

ResourceStats Resource statistics

type ResourceTypeDescriptionList

type ResourceTypeDescriptionList struct {
	Resources []externalRef0.ResourceTypeDescription `json:"resources"`
}

ResourceTypeDescriptionList A list of all resources install

type ResourceTypeDescriptionListResponse

type ResourceTypeDescriptionListResponse = ResourceTypeDescriptionList

ResourceTypeDescriptionListResponse A list of all resources install

type RoutePolicyConfResponse added in v2.12.4

type RoutePolicyConfResponse = externalRef0.PoliciesList

RoutePolicyConfResponse defines model for RoutePolicyConfResponse.

type RoutesListResponse added in v2.12.4

type RoutesListResponse = externalRef0.RoutesList

RoutesListResponse defines model for RoutesListResponse.

type SchemasGlobalInsight added in v2.10.9

type SchemasGlobalInsight struct {
	// CreatedAt Time of Global Insight creation
	CreatedAt time.Time `json:"createdAt"`

	// Dataplanes Dataplane proxy statistics
	Dataplanes DataplanesStats `json:"dataplanes"`

	// Meshes Mesh statistics
	Meshes MeshesStats `json:"meshes"`

	// Policies Policies statistics
	Policies PoliciesStats `json:"policies"`

	// Resources A map of resource names to their corresponding statistics
	Resources map[string]ResourceStats `json:"resources"`

	// Services Mesh services statistics
	Services ServicesStats `json:"services"`

	// Zones Zones statistics
	Zones ZonesStats `json:"zones"`
}

SchemasGlobalInsight Global Insight contains statistics for all main resources

type ServicesStats

type ServicesStats struct {
	// External External services statistics
	External struct {
		Total int `json:"total"`
	} `json:"external"`

	// GatewayBuiltin Builtin Gateway services statistics
	GatewayBuiltin FullStatus `json:"gatewayBuiltin"`

	// GatewayDelegated Delegated Gateway services statistics
	GatewayDelegated FullStatus `json:"gatewayDelegated"`

	// Internal Internal services statistics
	Internal FullStatus `json:"internal"`
}

ServicesStats Services statistics

type ZonesStats

type ZonesStats struct {
	// ControlPlanes Control Planes statistics
	ControlPlanes BaseStatus `json:"controlPlanes"`

	// ZoneEgresses Zone Egresses statistics
	ZoneEgresses BaseStatus `json:"zoneEgresses"`

	// ZoneIngresses Zone Ingresses statistics
	ZoneIngresses BaseStatus `json:"zoneIngresses"`
}

ZonesStats Zone statistics

Directories

Path Synopsis
Package types provides primitives to interact with the openapi HTTP API.
Package types provides primitives to interact with the openapi HTTP API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL