resources

package
v0.6.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (
	// MaxRefLength is the maximum allowed length for a ref
	MaxRefLength = 63
	// MinRefLength is the minimum allowed length for a ref
	MinRefLength = 1
)
View Source 
const (
	// NamespaceExternal is a sentinel (empty string) used internally when handling external resources.
	NamespaceExternal = ""
)

Variables

This section is empty.

Functions

func GetNamespace added in v0.1.4 

func GetNamespace(kongctl *KongctlMeta) string

GetNamespace safely extracts namespace from kongctl metadata

func IsRegistered added in v0.5.0 

func IsRegistered(rt ResourceType) bool

IsRegistered returns true if a resource type is registered in the registry.

func ValidateRef 

func ValidateRef(ref string) error

ValidateRef validates that a resource ref follows naming conventions

Types

type APIDocumentResource 

type APIDocumentResource struct {
	kkComps.CreateAPIDocumentRequest `                      yaml:",inline"                       json:",inline"`
	Ref                              string `yaml:"ref"                           json:"ref"`
	// Parent API reference (for root-level definitions)
	API               string                `yaml:"api,omitempty"                 json:"api,omitempty"`
	ParentDocumentID  string                `yaml:"parent_document_id,omitempty"  json:"parent_document_id,omitempty"`
	ParentDocumentRef string                `yaml:"parent_document_ref,omitempty" json:"parent_document_ref,omitempty"`
	Children          []APIDocumentResource `yaml:"children,omitempty"            json:"children,omitempty"`
	// contains filtered or unexported fields
}

APIDocumentResource represents an API document in declarative configuration

func (APIDocumentResource) GetDependencies 

func (d APIDocumentResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this API document depends on

func (APIDocumentResource) GetKonnectID 

func (d APIDocumentResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (APIDocumentResource) GetKonnectMonikerFilter 

func (d APIDocumentResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (APIDocumentResource) GetMoniker 

func (d APIDocumentResource) GetMoniker() string

GetMoniker returns the resource moniker (for documents, this is the slug)

func (APIDocumentResource) GetParentRef 

func (d APIDocumentResource) GetParentRef() *ResourceRef

GetParentRef returns the parent API reference for ResourceWithParent interface

func (APIDocumentResource) GetRef 

func (d APIDocumentResource) GetRef() string

GetRef returns the reference identifier used for cross-resource references

func (APIDocumentResource) GetReferenceFieldMappings 

func (d APIDocumentResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (APIDocumentResource) GetType added in v0.1.3 

func (d APIDocumentResource) GetType() ResourceType

GetType returns the resource type

func (APIDocumentResource) MarshalJSON added in v0.4.0 

func (d APIDocumentResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures document metadata (ref, api, parent refs, children) are included. Without this, the embedded CreateAPIDocumentRequest's MarshalJSON is promoted and drops metadata fields.

func (*APIDocumentResource) SetDefaults 

func (d *APIDocumentResource) SetDefaults()

SetDefaults applies default values to API document resource

func (*APIDocumentResource) TryMatchKonnectResource 

func (d *APIDocumentResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*APIDocumentResource) UnmarshalJSON 

func (d *APIDocumentResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements custom JSON unmarshaling to handle SDK types

func (APIDocumentResource) Validate 

func (d APIDocumentResource) Validate() error

Validate ensures the API document resource is valid

type APIImplementationResource 

type APIImplementationResource struct {
	kkComps.APIImplementation `       yaml:",inline"       json:",inline"`
	Ref                       string `yaml:"ref"           json:"ref"`
	// Parent API reference (for root-level definitions)
	API string `yaml:"api,omitempty" json:"api,omitempty"`
	// contains filtered or unexported fields
}

APIImplementationResource represents an API implementation in declarative configuration

func (APIImplementationResource) GetDependencies 

func (i APIImplementationResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this API implementation depends on

func (APIImplementationResource) GetKonnectID 

func (i APIImplementationResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (APIImplementationResource) GetKonnectMonikerFilter 

func (i APIImplementationResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (APIImplementationResource) GetMoniker 

func (i APIImplementationResource) GetMoniker() string

GetMoniker returns the resource moniker (for implementations, this is empty)

func (APIImplementationResource) GetParentRef 

func (i APIImplementationResource) GetParentRef() *ResourceRef

GetParentRef returns the parent API reference for ResourceWithParent interface

func (APIImplementationResource) GetRef 

func (i APIImplementationResource) GetRef() string

GetRef returns the reference identifier used for cross-resource references

func (APIImplementationResource) GetReferenceFieldMappings 

func (i APIImplementationResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (APIImplementationResource) GetType added in v0.1.3 

func (i APIImplementationResource) GetType() ResourceType

GetType returns the resource type

func (APIImplementationResource) MarshalJSON added in v0.4.0 

func (i APIImplementationResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures implementation metadata (ref, api) are included. Without this, the embedded APIImplementation's MarshalJSON is promoted and drops metadata fields.

func (*APIImplementationResource) SetDefaults 

func (i *APIImplementationResource) SetDefaults()

SetDefaults applies default values to API implementation resource

func (*APIImplementationResource) TryMatchKonnectResource 

func (i *APIImplementationResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*APIImplementationResource) UnmarshalJSON 

func (i *APIImplementationResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements custom JSON unmarshaling to handle SDK types

func (APIImplementationResource) Validate 

func (i APIImplementationResource) Validate() error

Validate ensures the API implementation resource is valid

type APIPublicationResource 

type APIPublicationResource struct {
	kkComps.APIPublication `       yaml:",inline"       json:",inline"`
	Ref                    string `yaml:"ref"           json:"ref"`
	// Parent API reference (for root-level definitions)
	API      string `yaml:"api,omitempty" json:"api,omitempty"`
	PortalID string `yaml:"portal_id"     json:"portal_id"`
	// contains filtered or unexported fields
}

APIPublicationResource represents an API publication in declarative configuration

func (APIPublicationResource) GetDependencies 

func (p APIPublicationResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this API publication depends on

func (APIPublicationResource) GetKonnectID 

func (p APIPublicationResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (APIPublicationResource) GetKonnectMonikerFilter 

func (p APIPublicationResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (APIPublicationResource) GetMoniker 

func (p APIPublicationResource) GetMoniker() string

GetMoniker returns the resource moniker (for publications, this is the portal ID)

func (APIPublicationResource) GetParentRef 

func (p APIPublicationResource) GetParentRef() *ResourceRef

GetParentRef returns the parent API reference for ResourceWithParent interface

func (APIPublicationResource) GetRef 

func (p APIPublicationResource) GetRef() string

GetRef returns the reference identifier used for cross-resource references

func (APIPublicationResource) GetReferenceFieldMappings 

func (p APIPublicationResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (APIPublicationResource) GetType added in v0.1.3 

func (p APIPublicationResource) GetType() ResourceType

GetType returns the resource type

func (APIPublicationResource) MarshalJSON added in v0.4.0 

func (p APIPublicationResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures publication metadata (ref, portal_id, api) are included. Without this, the embedded APIPublication's MarshalJSON is promoted and drops metadata fields.

func (*APIPublicationResource) SetDefaults 

func (p *APIPublicationResource) SetDefaults()

SetDefaults applies default values to API publication resource

func (*APIPublicationResource) TryMatchKonnectResource 

func (p *APIPublicationResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*APIPublicationResource) UnmarshalJSON 

func (p *APIPublicationResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements custom JSON unmarshaling to handle SDK types

func (APIPublicationResource) Validate 

func (p APIPublicationResource) Validate() error

Validate ensures the API publication resource is valid

type APIResource 

type APIResource struct {
	BaseResource
	kkComps.CreateAPIRequest `yaml:",inline" json:",inline"`

	// Nested child resources
	Versions        []APIVersionResource        `yaml:"versions,omitempty"        json:"versions,omitempty"`
	Publications    []APIPublicationResource    `yaml:"publications,omitempty"    json:"publications,omitempty"`
	Implementations []APIImplementationResource `yaml:"implementations,omitempty" json:"implementations,omitempty"`
	Documents       []APIDocumentResource       `yaml:"documents,omitempty"       json:"documents,omitempty"`
}

APIResource represents an API in declarative configuration

func (APIResource) GetDependencies 

func (a APIResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this API depends on

func (APIResource) GetKonnectMonikerFilter 

func (a APIResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (APIResource) GetLabels 

func (a APIResource) GetLabels() map[string]string

GetLabels returns the labels for this resource

func (APIResource) GetMoniker 

func (a APIResource) GetMoniker() string

GetMoniker returns the resource moniker (for APIs, this is the name)

func (APIResource) GetReferenceFieldMappings 

func (a APIResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (APIResource) GetType added in v0.1.3 

func (a APIResource) GetType() ResourceType

GetType returns the resource type

func (*APIResource) SetDefaults 

func (a *APIResource) SetDefaults()

SetDefaults applies default values to API resource

func (*APIResource) SetLabels 

func (a *APIResource) SetLabels(labels map[string]string)

SetLabels sets the labels for this resource

func (*APIResource) TryMatchKonnectResource 

func (a *APIResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource.

func (APIResource) Validate 

func (a APIResource) Validate() error

Validate ensures the API resource is valid

type APIVersionResource 

type APIVersionResource struct {
	kkComps.CreateAPIVersionRequest `       yaml:",inline"       json:",inline"`
	Ref                             string `yaml:"ref"           json:"ref"`
	// Parent API reference (for root-level definitions)
	API string `yaml:"api,omitempty" json:"api,omitempty"`
	// contains filtered or unexported fields
}

APIVersionResource represents an API version in declarative configuration

func (APIVersionResource) GetDependencies 

func (v APIVersionResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this API version depends on

func (APIVersionResource) GetKonnectID 

func (v APIVersionResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (APIVersionResource) GetKonnectMonikerFilter 

func (v APIVersionResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (APIVersionResource) GetMoniker 

func (v APIVersionResource) GetMoniker() string

GetMoniker returns the resource moniker (for versions, this is the version string)

func (APIVersionResource) GetParentRef 

func (v APIVersionResource) GetParentRef() *ResourceRef

GetParentRef returns the parent API reference for ResourceWithParent interface

func (APIVersionResource) GetRef 

func (v APIVersionResource) GetRef() string

GetRef returns the reference identifier used for cross-resource references

func (APIVersionResource) GetReferenceFieldMappings 

func (v APIVersionResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (APIVersionResource) GetType added in v0.1.3 

func (v APIVersionResource) GetType() ResourceType

GetType returns the resource type

func (*APIVersionResource) SetDefaults 

func (v *APIVersionResource) SetDefaults()

SetDefaults applies default values to API version resource

func (*APIVersionResource) TryMatchKonnectResource 

func (v *APIVersionResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*APIVersionResource) UnmarshalJSON 

func (v *APIVersionResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements custom JSON unmarshaling to handle SDK types

func (APIVersionResource) Validate 

func (v APIVersionResource) Validate() error

Validate ensures the API version resource is valid

type ApplicationAuthStrategyResource 

type ApplicationAuthStrategyResource struct {
	BaseResource
	kkComps.CreateAppAuthStrategyRequest `yaml:",inline" json:",inline"`
}

ApplicationAuthStrategyResource represents an application auth strategy in declarative configuration

func (ApplicationAuthStrategyResource) GetDependencies 

func (a ApplicationAuthStrategyResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this auth strategy depends on

func (ApplicationAuthStrategyResource) GetKonnectMonikerFilter 

func (a ApplicationAuthStrategyResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (ApplicationAuthStrategyResource) GetLabels 

func (a ApplicationAuthStrategyResource) GetLabels() map[string]string

GetLabels returns the labels for this resource

func (ApplicationAuthStrategyResource) GetMoniker 

func (a ApplicationAuthStrategyResource) GetMoniker() string

GetMoniker returns the moniker (name) of the auth strategy from the union type

func (ApplicationAuthStrategyResource) GetReferenceFieldMappings 

func (a ApplicationAuthStrategyResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (ApplicationAuthStrategyResource) GetType added in v0.1.3 

func (a ApplicationAuthStrategyResource) GetType() ResourceType

GetType returns the resource type

func (ApplicationAuthStrategyResource) MarshalJSON added in v0.1.6 

func (a ApplicationAuthStrategyResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures the ref field is always included alongside the union payload

func (*ApplicationAuthStrategyResource) SetDefaults 

func (a *ApplicationAuthStrategyResource) SetDefaults()

SetDefaults applies default values to application auth strategy resource

func (*ApplicationAuthStrategyResource) SetLabels 

func (a *ApplicationAuthStrategyResource) SetLabels(labels map[string]string)

SetLabels sets the labels for this resource

func (*ApplicationAuthStrategyResource) TryMatchKonnectResource 

func (a *ApplicationAuthStrategyResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*ApplicationAuthStrategyResource) UnmarshalJSON 

func (a *ApplicationAuthStrategyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements custom JSON unmarshaling to handle SDK union types (sigs.k8s.io/yaml uses JSON unmarshaling internally)

func (ApplicationAuthStrategyResource) Validate 

func (a ApplicationAuthStrategyResource) Validate() error

Validate ensures the application auth strategy resource is valid

type BaseResource added in v0.5.0 

type BaseResource struct {
	Ref     string       `yaml:"ref" json:"ref"`
	Kongctl *KongctlMeta `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`
	// contains filtered or unexported fields
}

BaseResource provides the minimal common fields for declarative resources. Use this for resources that don't support external resource references.

func (BaseResource) GetKonnectID added in v0.5.0 

func (b BaseResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available.

func (BaseResource) GetKonnectMonikerFilter added in v0.5.0 

func (b BaseResource) GetKonnectMonikerFilter(name string) string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup.

func (BaseResource) GetRef added in v0.5.0 

func (b BaseResource) GetRef() string

GetRef returns the reference identifier used for cross-resource references.

func (BaseResource) IsExternal added in v0.5.0 

func (b BaseResource) IsExternal() bool

IsExternal returns false for core resources (no external support).

func (*BaseResource) SetKonnectID added in v0.5.0 

func (b *BaseResource) SetKonnectID(id string)

SetKonnectID sets the resolved Konnect ID.

func (*BaseResource) TryMatchByName added in v0.5.0 

func (b *BaseResource) TryMatchByName(resourceName string, konnectResource any, opts matchOptions) bool

TryMatchByName attempts to match this resource with a Konnect resource by name. On successful match, sets konnectID and returns true.

type CatalogServiceResource added in v0.3.6 

type CatalogServiceResource struct {
	BaseResource
	kkComps.CreateCatalogService `yaml:",inline" json:",inline"`
}

CatalogServiceResource represents a Service Catalog service in declarative configuration

func (CatalogServiceResource) GetDependencies added in v0.3.6 

func (c CatalogServiceResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this service depends on

func (CatalogServiceResource) GetKonnectMonikerFilter added in v0.3.6 

func (c CatalogServiceResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (CatalogServiceResource) GetLabels added in v0.3.6 

func (c CatalogServiceResource) GetLabels() map[string]string

GetLabels returns the labels for this resource

func (CatalogServiceResource) GetMoniker added in v0.3.6 

func (c CatalogServiceResource) GetMoniker() string

GetMoniker returns the resource moniker (service name)

func (CatalogServiceResource) GetType added in v0.3.6 

func (c CatalogServiceResource) GetType() ResourceType

GetType returns the resource type

func (*CatalogServiceResource) SetDefaults added in v0.3.6 

func (c *CatalogServiceResource) SetDefaults()

SetDefaults applies default values to CatalogService resource

func (*CatalogServiceResource) SetLabels added in v0.3.6 

func (c *CatalogServiceResource) SetLabels(labels map[string]string)

SetLabels sets the labels for this resource

func (*CatalogServiceResource) TryMatchKonnectResource added in v0.3.6 

func (c *CatalogServiceResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource.

func (CatalogServiceResource) Validate added in v0.3.6 

func (c CatalogServiceResource) Validate() error

Validate ensures the CatalogService resource is valid

type ControlPlaneGroupMember added in v0.3.0 

type ControlPlaneGroupMember struct {
	ID string `yaml:"id" json:"id"`
}

ControlPlaneGroupMember represents a member entry for a control plane group.

type ControlPlaneResource 

type ControlPlaneResource struct {
	BaseResource
	kkComps.CreateControlPlaneRequest `                          yaml:",inline"                    json:",inline"`
	External                          *ExternalBlock            `yaml:"_external,omitempty"        json:"_external,omitempty"` //nolint:lll
	Deck                              *DeckConfig               `yaml:"_deck,omitempty"            json:"_deck,omitempty"`
	GatewayServices                   []GatewayServiceResource  `yaml:"gateway_services,omitempty" json:"gateway_services,omitempty"` //nolint:lll
	Members                           []ControlPlaneGroupMember `yaml:"members,omitempty"          json:"members,omitempty"`          //nolint:lll
	// contains filtered or unexported fields
}

ControlPlaneResource represents a control plane in declarative configuration

func (ControlPlaneResource) DeckBaseDir added in v0.3.8 

func (c ControlPlaneResource) DeckBaseDir() string

DeckBaseDir returns the resolved base directory for deck config (if any).

func (ControlPlaneResource) GetDependencies added in v0.1.3 

func (c ControlPlaneResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this control plane depends on

func (ControlPlaneResource) GetKonnectMonikerFilter added in v0.1.3 

func (c ControlPlaneResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (ControlPlaneResource) GetMoniker added in v0.1.3 

func (c ControlPlaneResource) GetMoniker() string

GetMoniker returns the resource moniker (for control planes, this is the name)

func (ControlPlaneResource) GetReferenceFieldMappings 

func (c ControlPlaneResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (ControlPlaneResource) GetType added in v0.1.3 

func (c ControlPlaneResource) GetType() ResourceType

GetType returns the resource type

func (ControlPlaneResource) HasDeckConfig added in v0.3.8 

func (c ControlPlaneResource) HasDeckConfig() bool

HasDeckConfig returns true when a deck config is configured on the control plane.

func (*ControlPlaneResource) IsExternal added in v0.2.0 

func (c *ControlPlaneResource) IsExternal() bool

IsExternal returns true if this control plane is externally managed

func (*ControlPlaneResource) IsGroup added in v0.3.0 

func (c *ControlPlaneResource) IsGroup() bool

IsGroup returns true when the control plane represents a control plane group.

func (*ControlPlaneResource) MemberIDs added in v0.3.0 

func (c *ControlPlaneResource) MemberIDs() []string

MemberIDs returns the list of member IDs declared for a control plane group.

func (*ControlPlaneResource) SetDeckBaseDir added in v0.3.8 

func (c *ControlPlaneResource) SetDeckBaseDir(dir string)

SetDeckBaseDir sets the resolved base directory for deck config.

func (*ControlPlaneResource) SetDefaults 

func (c *ControlPlaneResource) SetDefaults()

SetDefaults applies default values to control plane resource

func (*ControlPlaneResource) TryMatchKonnectResource added in v0.1.3 

func (c *ControlPlaneResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (ControlPlaneResource) Validate 

func (c ControlPlaneResource) Validate() error

Validate ensures the control plane resource is valid

type DeckConfig added in v0.3.8 

type DeckConfig struct {
	Files []string `yaml:"files"           json:"files"`
	Flags []string `yaml:"flags,omitempty" json:"flags,omitempty"`
}

DeckConfig describes deck state files to apply or sync.

func (*DeckConfig) Validate added in v0.3.8 

func (d *DeckConfig) Validate() error

type EventGatewayBackendClusterResource added in v0.3.8 

type EventGatewayBackendClusterResource struct {
	kkComps.CreateBackendClusterRequest `       yaml:",inline"                 json:",inline"`
	Ref                                 string `yaml:"ref"                     json:"ref"`
	// Parent Event Gateway reference (for root-level definitions)
	EventGateway string `yaml:"event_gateway,omitempty" json:"event_gateway,omitempty"`
	// contains filtered or unexported fields
}

func (EventGatewayBackendClusterResource) GetDependencies added in v0.3.8 

func (e EventGatewayBackendClusterResource) GetDependencies() []ResourceRef

func (EventGatewayBackendClusterResource) GetKonnectID added in v0.3.8 

func (e EventGatewayBackendClusterResource) GetKonnectID() string

func (EventGatewayBackendClusterResource) GetKonnectMonikerFilter added in v0.3.8 

func (e EventGatewayBackendClusterResource) GetKonnectMonikerFilter() string

func (EventGatewayBackendClusterResource) GetMoniker added in v0.3.8 

func (e EventGatewayBackendClusterResource) GetMoniker() string

func (EventGatewayBackendClusterResource) GetParentRef added in v0.3.8 

func (e EventGatewayBackendClusterResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayBackendClusterResource) GetRef added in v0.3.8 

func (e EventGatewayBackendClusterResource) GetRef() string

func (EventGatewayBackendClusterResource) GetType added in v0.3.8 

func (e EventGatewayBackendClusterResource) GetType() ResourceType

func (EventGatewayBackendClusterResource) MarshalJSON added in v0.4.0 

func (e EventGatewayBackendClusterResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures backend cluster metadata (ref, event_gateway) are included. Without this, the embedded CreateBackendClusterRequest's MarshalJSON is promoted and drops metadata fields.

func (*EventGatewayBackendClusterResource) SetDefaults added in v0.3.8 

func (e *EventGatewayBackendClusterResource) SetDefaults()

func (*EventGatewayBackendClusterResource) TryMatchKonnectResource added in v0.3.8 

func (e *EventGatewayBackendClusterResource) TryMatchKonnectResource(konnectResource any) bool

func (*EventGatewayBackendClusterResource) UnmarshalJSON added in v0.3.8 

func (e *EventGatewayBackendClusterResource) UnmarshalJSON(data []byte) error

Custom JSON unmarshaling to reject kongctl metadata

func (EventGatewayBackendClusterResource) Validate added in v0.3.8 

func (e EventGatewayBackendClusterResource) Validate() error

type EventGatewayControlPlaneResource added in v0.3.7 

type EventGatewayControlPlaneResource struct {
	BaseResource
	kkComps.CreateGatewayRequest `yaml:",inline" json:",inline"`

	// Nested child resources
	BackendClusters       []EventGatewayBackendClusterResource       `yaml:"backend_clusters,omitempty" json:"backend_clusters,omitempty"`               //nolint:lll
	VirtualClusters       []EventGatewayVirtualClusterResource       `yaml:"virtual_clusters,omitempty" json:"virtual_clusters,omitempty"`               //nolint:lll
	Listeners             []EventGatewayListenerResource             `yaml:"listeners,omitempty"        json:"listeners,omitempty"`                      //nolint:lll
	DataPlaneCertificates []EventGatewayDataPlaneCertificateResource `yaml:"data_plane_certificates,omitempty" json:"data_plane_certificates,omitempty"` //nolint:lll
}

func (EventGatewayControlPlaneResource) GetDependencies added in v0.3.7 

func (e EventGatewayControlPlaneResource) GetDependencies() []ResourceRef

func (EventGatewayControlPlaneResource) GetKonnectMonikerFilter added in v0.3.7 

func (e EventGatewayControlPlaneResource) GetKonnectMonikerFilter() string

func (EventGatewayControlPlaneResource) GetLabels added in v0.3.7 

func (e EventGatewayControlPlaneResource) GetLabels() map[string]string

func (EventGatewayControlPlaneResource) GetMoniker added in v0.3.7 

func (e EventGatewayControlPlaneResource) GetMoniker() string

func (EventGatewayControlPlaneResource) GetType added in v0.3.7 

func (e EventGatewayControlPlaneResource) GetType() ResourceType

func (*EventGatewayControlPlaneResource) SetDefaults added in v0.3.7 

func (e *EventGatewayControlPlaneResource) SetDefaults()

func (*EventGatewayControlPlaneResource) SetLabels added in v0.3.7 

func (e *EventGatewayControlPlaneResource) SetLabels(labels map[string]string)

func (*EventGatewayControlPlaneResource) TryMatchKonnectResource added in v0.3.7 

func (e *EventGatewayControlPlaneResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource.

func (EventGatewayControlPlaneResource) Validate added in v0.3.7 

func (e EventGatewayControlPlaneResource) Validate() error

type EventGatewayDataPlaneCertificateResource added in v0.6.0 

type EventGatewayDataPlaneCertificateResource struct {
	kkComps.CreateEventGatewayDataPlaneCertificateRequest `yaml:",inline" json:",inline"`
	Ref                                                   string `yaml:"ref" json:"ref"`
	// Parent Event Gateway reference (for root-level definitions)
	EventGateway string `yaml:"event_gateway,omitempty" json:"event_gateway,omitempty"`
	// contains filtered or unexported fields
}

func (EventGatewayDataPlaneCertificateResource) GetDependencies added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) GetDependencies() []ResourceRef

func (EventGatewayDataPlaneCertificateResource) GetKonnectID added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) GetKonnectID() string

func (EventGatewayDataPlaneCertificateResource) GetKonnectMonikerFilter added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) GetKonnectMonikerFilter() string

func (EventGatewayDataPlaneCertificateResource) GetMoniker added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) GetMoniker() string

func (EventGatewayDataPlaneCertificateResource) GetParentRef added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayDataPlaneCertificateResource) GetRef added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) GetRef() string

func (EventGatewayDataPlaneCertificateResource) GetType added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) GetType() ResourceType

func (EventGatewayDataPlaneCertificateResource) MarshalJSON added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures certificate metadata (ref, event_gateway) are included. Without this, the embedded CreateEventGatewayDataPlaneCertificateRequest's MarshalJSON is promoted and drops metadata fields.

func (*EventGatewayDataPlaneCertificateResource) SetDefaults added in v0.6.0 

func (e *EventGatewayDataPlaneCertificateResource) SetDefaults()

func (*EventGatewayDataPlaneCertificateResource) TryMatchKonnectResource added in v0.6.0 

func (e *EventGatewayDataPlaneCertificateResource) TryMatchKonnectResource(konnectResource any) bool

func (*EventGatewayDataPlaneCertificateResource) UnmarshalJSON added in v0.6.0 

func (e *EventGatewayDataPlaneCertificateResource) UnmarshalJSON(data []byte) error

Custom JSON unmarshaling to reject kongctl metadata

func (EventGatewayDataPlaneCertificateResource) Validate added in v0.6.0 

func (e EventGatewayDataPlaneCertificateResource) Validate() error

type EventGatewayListenerPolicyResource added in v0.5.0 

type EventGatewayListenerPolicyResource struct {
	kkComps.EventGatewayListenerPolicyCreate `yaml:",inline" json:",inline"`
	Ref                                      string `yaml:"ref"                        json:"ref"`
	// Parent Event Gateway Listener reference (for root-level definitions)
	EventGatewayListener string `yaml:"listener,omitempty" json:"listener,omitempty"`
	EventGateway         string `yaml:"event_gateway,omitempty" json:"event_gateway,omitempty"`
	// contains filtered or unexported fields
}

EventGatewayListenerPolicyResource represents a listener policy in declarative configuration. The SDK represents listener policies as a union type (EventGatewayListenerPolicyCreate) with two variants: TLSServer and ForwardToVirtualCluster.

func (EventGatewayListenerPolicyResource) GetDependencies added in v0.5.0 

func (e EventGatewayListenerPolicyResource) GetDependencies() []ResourceRef

func (EventGatewayListenerPolicyResource) GetKonnectID added in v0.5.0 

func (e EventGatewayListenerPolicyResource) GetKonnectID() string

func (EventGatewayListenerPolicyResource) GetKonnectMonikerFilter added in v0.5.0 

func (e EventGatewayListenerPolicyResource) GetKonnectMonikerFilter() string

func (EventGatewayListenerPolicyResource) GetMoniker added in v0.5.0 

func (e EventGatewayListenerPolicyResource) GetMoniker() string

GetMoniker returns the name of the policy from whichever union variant is set.

func (EventGatewayListenerPolicyResource) GetParentRef added in v0.5.0 

func (e EventGatewayListenerPolicyResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayListenerPolicyResource) GetRef added in v0.5.0 

func (e EventGatewayListenerPolicyResource) GetRef() string

func (EventGatewayListenerPolicyResource) GetType added in v0.5.0 

func (e EventGatewayListenerPolicyResource) GetType() ResourceType

func (EventGatewayListenerPolicyResource) MarshalJSON added in v0.5.0 

func (e EventGatewayListenerPolicyResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures listener policy metadata (ref, event_gateway_listener) are included. Without this, the embedded union type's MarshalJSON is promoted and drops our metadata fields.

func (*EventGatewayListenerPolicyResource) SetDefaults added in v0.5.0 

func (e *EventGatewayListenerPolicyResource) SetDefaults()

func (*EventGatewayListenerPolicyResource) TryMatchKonnectResource added in v0.5.0 

func (e *EventGatewayListenerPolicyResource) TryMatchKonnectResource(konnectResource any) bool

func (*EventGatewayListenerPolicyResource) UnmarshalJSON added in v0.5.0 

func (e *EventGatewayListenerPolicyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON handles the union type correctly. It rejects kongctl metadata and delegates to the SDK union type for the policy body. The SDK union type requires a "type" discriminator field to determine which variant (tls_server or forward_to_virtual_cluster) to use. For forward_to_virtual_cluster policies, the config must also have a "type" field ("sni" or "port_mapping") since ForwardToVirtualClusterPolicyConfig is also a union type.

func (EventGatewayListenerPolicyResource) Validate added in v0.5.0 

func (e EventGatewayListenerPolicyResource) Validate() error

type EventGatewayListenerResource added in v0.5.0 

type EventGatewayListenerResource struct {
	kkComps.CreateEventGatewayListenerRequest `       yaml:",inline"                 json:",inline"`
	Ref                                       string `yaml:"ref"                     json:"ref"`
	// Parent Event Gateway reference (for root-level definitions)
	EventGateway string `yaml:"event_gateway,omitempty" json:"event_gateway,omitempty"`

	// Nested child resources
	Policies []EventGatewayListenerPolicyResource `yaml:"policies,omitempty" json:"policies,omitempty"`
	// contains filtered or unexported fields
}

func (EventGatewayListenerResource) GetDependencies added in v0.5.0 

func (e EventGatewayListenerResource) GetDependencies() []ResourceRef

func (EventGatewayListenerResource) GetKonnectID added in v0.5.0 

func (e EventGatewayListenerResource) GetKonnectID() string

func (EventGatewayListenerResource) GetKonnectMonikerFilter added in v0.5.0 

func (e EventGatewayListenerResource) GetKonnectMonikerFilter() string

func (EventGatewayListenerResource) GetMoniker added in v0.5.0 

func (e EventGatewayListenerResource) GetMoniker() string

func (EventGatewayListenerResource) GetParentRef added in v0.5.0 

func (e EventGatewayListenerResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayListenerResource) GetRef added in v0.5.0 

func (e EventGatewayListenerResource) GetRef() string

func (EventGatewayListenerResource) GetType added in v0.5.0 

func (e EventGatewayListenerResource) GetType() ResourceType

func (EventGatewayListenerResource) MarshalJSON added in v0.5.0 

func (e EventGatewayListenerResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures listener metadata (ref, event_gateway, policies) are included. Without this, the embedded CreateEventGatewayListenerRequest's MarshalJSON is promoted and drops metadata fields.

func (*EventGatewayListenerResource) SetDefaults added in v0.5.0 

func (e *EventGatewayListenerResource) SetDefaults()

func (*EventGatewayListenerResource) TryMatchKonnectResource added in v0.5.0 

func (e *EventGatewayListenerResource) TryMatchKonnectResource(konnectResource any) bool

func (*EventGatewayListenerResource) UnmarshalJSON added in v0.5.0 

func (e *EventGatewayListenerResource) UnmarshalJSON(data []byte) error

Custom JSON unmarshaling to reject kongctl metadata

func (EventGatewayListenerResource) Validate added in v0.5.0 

func (e EventGatewayListenerResource) Validate() error

type EventGatewayVirtualClusterResource added in v0.4.0 

type EventGatewayVirtualClusterResource struct {
	kkComps.CreateVirtualClusterRequest `       yaml:",inline"                 json:",inline"`
	Ref                                 string `yaml:"ref"                     json:"ref"`
	// Parent Event Gateway reference (for root-level definitions)
	EventGateway string `yaml:"event_gateway,omitempty" json:"event_gateway,omitempty"`
	// contains filtered or unexported fields
}

func (EventGatewayVirtualClusterResource) GetDependencies added in v0.4.0 

func (e EventGatewayVirtualClusterResource) GetDependencies() []ResourceRef

func (EventGatewayVirtualClusterResource) GetKonnectID added in v0.4.0 

func (e EventGatewayVirtualClusterResource) GetKonnectID() string

func (EventGatewayVirtualClusterResource) GetKonnectMonikerFilter added in v0.4.0 

func (e EventGatewayVirtualClusterResource) GetKonnectMonikerFilter() string

func (EventGatewayVirtualClusterResource) GetMoniker added in v0.4.0 

func (e EventGatewayVirtualClusterResource) GetMoniker() string

func (EventGatewayVirtualClusterResource) GetParentRef added in v0.4.0 

func (e EventGatewayVirtualClusterResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayVirtualClusterResource) GetRef added in v0.4.0 

func (e EventGatewayVirtualClusterResource) GetRef() string

func (EventGatewayVirtualClusterResource) GetType added in v0.4.0 

func (e EventGatewayVirtualClusterResource) GetType() ResourceType

func (EventGatewayVirtualClusterResource) MarshalJSON added in v0.5.0 

func (e EventGatewayVirtualClusterResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures virtual cluster metadata (ref, event_gateway) are included. Without this, the embedded CreateVirtualClusterRequest's MarshalJSON is promoted and drops metadata fields.

func (*EventGatewayVirtualClusterResource) SetDefaults added in v0.4.0 

func (e *EventGatewayVirtualClusterResource) SetDefaults()

func (*EventGatewayVirtualClusterResource) TryMatchKonnectResource added in v0.4.0 

func (e *EventGatewayVirtualClusterResource) TryMatchKonnectResource(konnectResource any) bool

func (*EventGatewayVirtualClusterResource) UnmarshalJSON added in v0.4.0 

func (e *EventGatewayVirtualClusterResource) UnmarshalJSON(data []byte) error

Custom JSON unmarshaling to reject kongctl metadata

func (EventGatewayVirtualClusterResource) Validate added in v0.4.0 

func (e EventGatewayVirtualClusterResource) Validate() error

type ExternalBlock added in v0.1.5 

type ExternalBlock struct {
	// Direct ID reference (use when you know the exact Konnect ID)
	ID string `yaml:"id,omitempty" json:"id,omitempty"`

	// Selector for querying by fields (use to find by name)
	Selector *ExternalSelector `yaml:"selector,omitempty" json:"selector,omitempty"`
}

ExternalBlock marks a resource as externally managed

func (*ExternalBlock) IsExternal added in v0.1.5 

func (e *ExternalBlock) IsExternal() bool

IsExternal returns true if this resource is externally managed

func (*ExternalBlock) Validate added in v0.1.5 

func (e *ExternalBlock) Validate() error

Validate ensures the external block is properly configured

type ExternalSelector added in v0.1.5 

type ExternalSelector struct {
	// Field equality matches (initially just support name)
	MatchFields map[string]string `yaml:"matchFields" json:"matchFields"`
}

ExternalSelector defines field matching criteria

func (*ExternalSelector) Match added in v0.1.5 

func (s *ExternalSelector) Match(konnectResource any) bool

Match checks if the given Konnect resource matches this selector

type FileDefaults 

type FileDefaults struct {
	Kongctl *KongctlMetaDefaults `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`
}

FileDefaults holds file-level defaults that apply to all resources in the file

type GatewayServiceResource added in v0.2.0 

type GatewayServiceResource struct {
	// Service captures inline gateway service properties. It is excluded from direct
	// YAML/JSON serialization because external services are declared without payloads;
	// the custom UnmarshalYAML implementation below materializes this struct only when
	// inline fields are present in the configuration.
	Service      *kkComps.Service `yaml:"-"                       json:"-"`
	Ref          string           `yaml:"ref"                     json:"ref"`
	ControlPlane string           `yaml:"control_plane,omitempty" json:"control_plane,omitempty"`
	External     *ExternalBlock   `yaml:"_external,omitempty"     json:"_external,omitempty"`
	// contains filtered or unexported fields
}

GatewayServiceResource represents a gateway service within a control plane.

func (GatewayServiceResource) GetDependencies added in v0.2.0 

func (s GatewayServiceResource) GetDependencies() []ResourceRef

GetDependencies declares the resource dependencies.

func (GatewayServiceResource) GetKonnectID added in v0.2.0 

func (s GatewayServiceResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect service ID if available.

func (GatewayServiceResource) GetKonnectMonikerFilter added in v0.2.0 

func (s GatewayServiceResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect lookups.

func (GatewayServiceResource) GetMoniker added in v0.2.0 

func (s GatewayServiceResource) GetMoniker() string

GetMoniker returns a human-friendly identifier (the service name when available).

func (GatewayServiceResource) GetParentRef added in v0.2.0 

func (s GatewayServiceResource) GetParentRef() *ResourceRef

GetParentRef returns the parent control plane reference.

func (GatewayServiceResource) GetRef added in v0.2.0 

func (s GatewayServiceResource) GetRef() string

GetRef returns the declarative reference.

func (GatewayServiceResource) GetReferenceFieldMappings added in v0.2.0 

func (s GatewayServiceResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns reference validation mappings.

func (GatewayServiceResource) GetType added in v0.2.0 

func (s GatewayServiceResource) GetType() ResourceType

GetType returns the resource type.

func (*GatewayServiceResource) IsExternal added in v0.2.0 

func (s *GatewayServiceResource) IsExternal() bool

IsExternal returns true when the service is marked as externally managed.

func (GatewayServiceResource) ResolvedControlPlaneID added in v0.2.0 

func (s GatewayServiceResource) ResolvedControlPlaneID() string

ResolvedControlPlaneID exposes the konnect control plane identifier.

func (*GatewayServiceResource) SetDefaults added in v0.2.0 

func (s *GatewayServiceResource) SetDefaults()

SetDefaults applies default values where applicable.

func (*GatewayServiceResource) SetResolvedControlPlaneID added in v0.2.0 

func (s *GatewayServiceResource) SetResolvedControlPlaneID(id string)

SetResolvedControlPlaneID records the Konnect control plane ID for this service.

func (*GatewayServiceResource) TryMatchKonnectResource added in v0.2.0 

func (s *GatewayServiceResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect service object.

func (*GatewayServiceResource) UnmarshalYAML added in v0.3.3 

func (s *GatewayServiceResource) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML customizes decoding so external services without inline fields bypass SDK validation. Inline gateway service attributes populate the embedded SDK struct, while purely external resources leave it nil so serialization continues to emit only the external metadata.

func (GatewayServiceResource) Validate added in v0.2.0 

func (s GatewayServiceResource) Validate() error

Validate ensures the resource is well-formed.

type KongctlMeta 

type KongctlMeta struct {
	// Protected prevents accidental deletion of critical resources
	Protected *bool `yaml:"protected,omitempty" json:"protected,omitempty"`
	// Namespace for resource isolation and multi-team management
	Namespace *string `yaml:"namespace,omitempty" json:"namespace,omitempty"`
	// NamespaceOrigin tracks how the namespace value was derived (not serialized)
	NamespaceOrigin NamespaceOrigin `yaml:"-"                   json:"-"`
}

KongctlMeta contains tool-specific metadata for resources

type KongctlMetaDefaults 

type KongctlMetaDefaults struct {
	Namespace *string `yaml:"namespace,omitempty" json:"namespace,omitempty"`
	Protected *bool   `yaml:"protected,omitempty" json:"protected,omitempty"`
}

KongctlMetaDefaults holds default values for kongctl metadata fields

type NamespaceOrigin added in v0.1.6 

type NamespaceOrigin int

NamespaceOrigin describes how a namespace value was supplied for a resource 

const (
	// NamespaceOriginUnset indicates no namespace was resolved for the resource
	NamespaceOriginUnset NamespaceOrigin = iota
	// NamespaceOriginExplicit indicates the namespace was explicitly set on the resource
	NamespaceOriginExplicit
	// NamespaceOriginFileDefault indicates the namespace was inherited from _defaults.kongctl.namespace
	NamespaceOriginFileDefault
	// NamespaceOriginImplicitDefault indicates the namespace fell back to the implicit "default" value
	NamespaceOriginImplicitDefault
)

type OrganizationResource added in v0.4.0 

type OrganizationResource struct {
	// Teams nested under this organization
	Teams []OrganizationTeamResource `yaml:"teams,omitempty" json:"teams,omitempty"`
}

OrganizationResource represents an organization grouping in declarative configuration. It's a grouping concept that can contain nested resources like teams.

type OrganizationTeamResource added in v0.4.0 

type OrganizationTeamResource struct {
	BaseResource
	kkComps.CreateTeam `yaml:",inline" json:",inline"`
	External           *ExternalBlock `yaml:"_external,omitempty" json:"_external,omitempty"`
}

OrganizationTeamResource represents a team in declarative configuration

func (OrganizationTeamResource) GetDependencies added in v0.4.0 

func (t OrganizationTeamResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this team depends on

func (OrganizationTeamResource) GetKonnectMonikerFilter added in v0.4.0 

func (t OrganizationTeamResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (OrganizationTeamResource) GetLabels added in v0.4.0 

func (t OrganizationTeamResource) GetLabels() map[string]string

GetLabels returns the labels for this resource

func (OrganizationTeamResource) GetMoniker added in v0.4.0 

func (t OrganizationTeamResource) GetMoniker() string

GetMoniker returns the resource moniker (for teams, this is the name)

func (OrganizationTeamResource) GetReferenceFieldMappings added in v0.4.0 

func (t OrganizationTeamResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (OrganizationTeamResource) GetType added in v0.4.0 

func (t OrganizationTeamResource) GetType() ResourceType

GetType returns the resource type

func (*OrganizationTeamResource) IsExternal added in v0.4.0 

func (t *OrganizationTeamResource) IsExternal() bool

IsExternal returns true if this team is externally managed

func (*OrganizationTeamResource) SetDefaults added in v0.4.0 

func (t *OrganizationTeamResource) SetDefaults()

SetDefaults applies default values to team resource

func (*OrganizationTeamResource) SetLabels added in v0.4.0 

func (t *OrganizationTeamResource) SetLabels(labels map[string]string)

SetLabels sets the labels for this resource

func (*OrganizationTeamResource) TryMatchKonnectResource added in v0.4.0 

func (t *OrganizationTeamResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (OrganizationTeamResource) Validate added in v0.4.0 

func (t OrganizationTeamResource) Validate() error

Validate ensures the team resource is valid

type PortalAssetFaviconResource added in v0.3.5 

type PortalAssetFaviconResource struct {
	Ref    string  `yaml:"ref"            json:"ref"`
	Portal string  `yaml:"portal"         json:"portal"`         // Parent portal reference
	File   *string `yaml:"file,omitempty" json:"file,omitempty"` // Data URL from !file tag
	// contains filtered or unexported fields
}

PortalAssetFaviconResource represents a portal favicon asset This is a singleton resource - only UPDATE operations are supported

func (PortalAssetFaviconResource) GetDependencies added in v0.3.5 

func (r PortalAssetFaviconResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this asset depends on

func (PortalAssetFaviconResource) GetKonnectID added in v0.3.5 

func (r PortalAssetFaviconResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalAssetFaviconResource) GetKonnectMonikerFilter added in v0.3.5 

func (r PortalAssetFaviconResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns filter for API lookup For singleton assets, there's no moniker-based lookup

func (PortalAssetFaviconResource) GetMoniker added in v0.3.5 

func (r PortalAssetFaviconResource) GetMoniker() string

GetMoniker returns the resource moniker (for singletons, this is the ref)

func (PortalAssetFaviconResource) GetParentRef added in v0.3.5 

func (r PortalAssetFaviconResource) GetParentRef() *ResourceRef

GetParentRef returns the parent resource reference

func (PortalAssetFaviconResource) GetRef added in v0.3.5 

func (r PortalAssetFaviconResource) GetRef() string

GetRef returns the reference identifier

func (PortalAssetFaviconResource) GetType added in v0.3.5 

func (r PortalAssetFaviconResource) GetType() ResourceType

GetType returns the resource type

func (*PortalAssetFaviconResource) SetDefaults added in v0.3.5 

func (r *PortalAssetFaviconResource) SetDefaults()

SetDefaults applies default values

func (*PortalAssetFaviconResource) TryMatchKonnectResource added in v0.3.5 

func (r *PortalAssetFaviconResource) TryMatchKonnectResource(_ any) bool

TryMatchKonnectResource matches against Konnect API response For singleton assets, matching is done by portal ID, not by resource attributes

func (PortalAssetFaviconResource) Validate added in v0.3.5 

func (r PortalAssetFaviconResource) Validate() error

Validate ensures the portal asset favicon resource is valid

type PortalAssetLogoResource added in v0.3.5 

type PortalAssetLogoResource struct {
	Ref    string  `yaml:"ref"            json:"ref"`
	Portal string  `yaml:"portal"         json:"portal"`         // Parent portal reference
	File   *string `yaml:"file,omitempty" json:"file,omitempty"` // Data URL from !file tag
	// contains filtered or unexported fields
}

PortalAssetLogoResource represents a portal logo asset This is a singleton resource - only UPDATE operations are supported

func (PortalAssetLogoResource) GetDependencies added in v0.3.5 

func (r PortalAssetLogoResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this asset depends on

func (PortalAssetLogoResource) GetKonnectID added in v0.3.5 

func (r PortalAssetLogoResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalAssetLogoResource) GetKonnectMonikerFilter added in v0.3.5 

func (r PortalAssetLogoResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns filter for API lookup For singleton assets, there's no moniker-based lookup

func (PortalAssetLogoResource) GetMoniker added in v0.3.5 

func (r PortalAssetLogoResource) GetMoniker() string

GetMoniker returns the resource moniker (for singletons, this is the ref)

func (PortalAssetLogoResource) GetParentRef added in v0.3.5 

func (r PortalAssetLogoResource) GetParentRef() *ResourceRef

GetParentRef returns the parent resource reference

func (PortalAssetLogoResource) GetRef added in v0.3.5 

func (r PortalAssetLogoResource) GetRef() string

GetRef returns the reference identifier

func (PortalAssetLogoResource) GetType added in v0.3.5 

func (r PortalAssetLogoResource) GetType() ResourceType

GetType returns the resource type

func (*PortalAssetLogoResource) SetDefaults added in v0.3.5 

func (r *PortalAssetLogoResource) SetDefaults()

SetDefaults applies default values

func (*PortalAssetLogoResource) TryMatchKonnectResource added in v0.3.5 

func (r *PortalAssetLogoResource) TryMatchKonnectResource(_ any) bool

TryMatchKonnectResource matches against Konnect API response For singleton assets, matching is done by portal ID, not by resource attributes

func (PortalAssetLogoResource) Validate added in v0.3.5 

func (r PortalAssetLogoResource) Validate() error

Validate ensures the portal asset logo resource is valid

type PortalAssetsResource added in v0.3.5 

type PortalAssetsResource struct {
	Favicon *string `yaml:"favicon,omitempty" json:"favicon,omitempty"`
}

PortalAssetsResource represents portal assets (logo, favicon) in nested definition

type PortalAuthSettingsResource added in v0.3.4 

type PortalAuthSettingsResource struct {
	kkComps.PortalAuthenticationSettingsUpdateRequest `       yaml:",inline"          json:",inline"`
	Ref                                               string `yaml:"ref,omitempty"    json:"ref,omitempty"`
	Portal                                            string `yaml:"portal,omitempty" json:"portal,omitempty"`
	// contains filtered or unexported fields
}

PortalAuthSettingsResource represents portal authentication settings (singleton child).

func (PortalAuthSettingsResource) GetDependencies added in v0.3.4 

func (a PortalAuthSettingsResource) GetDependencies() []ResourceRef

func (PortalAuthSettingsResource) GetKonnectID added in v0.3.4 

func (a PortalAuthSettingsResource) GetKonnectID() string

func (PortalAuthSettingsResource) GetKonnectMonikerFilter added in v0.3.4 

func (a PortalAuthSettingsResource) GetKonnectMonikerFilter() string

func (PortalAuthSettingsResource) GetMoniker added in v0.3.4 

func (a PortalAuthSettingsResource) GetMoniker() string

func (PortalAuthSettingsResource) GetParentRef added in v0.3.4 

func (a PortalAuthSettingsResource) GetParentRef() *ResourceRef

GetParentRef implements ResourceWithParent for inheritance of namespace and protection.

func (PortalAuthSettingsResource) GetRef added in v0.3.4 

func (a PortalAuthSettingsResource) GetRef() string

func (PortalAuthSettingsResource) GetType added in v0.3.4 

func (a PortalAuthSettingsResource) GetType() ResourceType

func (*PortalAuthSettingsResource) SetDefaults added in v0.3.4 

func (a *PortalAuthSettingsResource) SetDefaults()

func (*PortalAuthSettingsResource) TryMatchKonnectResource added in v0.3.4 

func (a *PortalAuthSettingsResource) TryMatchKonnectResource(_ any) bool

func (*PortalAuthSettingsResource) UnmarshalJSON added in v0.3.4 

func (a *PortalAuthSettingsResource) UnmarshalJSON(data []byte) error

UnmarshalJSON rejects kongctl metadata on child resources.

func (PortalAuthSettingsResource) Validate added in v0.3.4 

func (a PortalAuthSettingsResource) Validate() error

type PortalCustomDomainResource 

type PortalCustomDomainResource struct {
	// Use CreatePortalCustomDomainRequest which contains only user-configurable fields
	// This aligns with the pattern used by other resources (API, APIVersion, etc.)
	kkComps.CreatePortalCustomDomainRequest `       yaml:",inline"          json:",inline"`
	Ref                                     string `yaml:"ref,omitempty"    json:"ref,omitempty"`
	// Parent portal reference
	Portal string `yaml:"portal,omitempty" json:"portal,omitempty"`
	// contains filtered or unexported fields
}

PortalCustomDomainResource represents a portal custom domain configuration

func (PortalCustomDomainResource) GetDependencies added in v0.1.3 

func (d PortalCustomDomainResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this custom domain depends on

func (PortalCustomDomainResource) GetKonnectID added in v0.1.3 

func (d PortalCustomDomainResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalCustomDomainResource) GetKonnectMonikerFilter added in v0.1.3 

func (d PortalCustomDomainResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (PortalCustomDomainResource) GetMoniker added in v0.1.3 

func (d PortalCustomDomainResource) GetMoniker() string

GetMoniker returns the resource moniker (for custom domains, this is the hostname)

func (PortalCustomDomainResource) GetRef 

func (d PortalCustomDomainResource) GetRef() string

GetRef returns the reference identifier

func (PortalCustomDomainResource) GetType added in v0.1.3 

func (d PortalCustomDomainResource) GetType() ResourceType

GetType returns the resource type

func (*PortalCustomDomainResource) SetDefaults 

func (d *PortalCustomDomainResource) SetDefaults()

SetDefaults applies default values

func (*PortalCustomDomainResource) TryMatchKonnectResource added in v0.1.3 

func (d *PortalCustomDomainResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (PortalCustomDomainResource) Validate 

func (d PortalCustomDomainResource) Validate() error

Validate ensures the portal custom domain resource is valid

type PortalCustomizationResource 

type PortalCustomizationResource struct {
	kkComps.PortalCustomization `       yaml:",inline"          json:",inline"`
	Ref                         string `yaml:"ref,omitempty"    json:"ref,omitempty"`
	Portal                      string `yaml:"portal,omitempty" json:"portal,omitempty"` // Parent portal reference
	// contains filtered or unexported fields
}

PortalCustomizationResource represents portal customization settings

func (PortalCustomizationResource) GetDependencies added in v0.1.3 

func (c PortalCustomizationResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this customization depends on

func (PortalCustomizationResource) GetKonnectID added in v0.1.3 

func (c PortalCustomizationResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalCustomizationResource) GetKonnectMonikerFilter added in v0.1.3 

func (c PortalCustomizationResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (PortalCustomizationResource) GetMoniker added in v0.1.3 

func (c PortalCustomizationResource) GetMoniker() string

GetMoniker returns the resource moniker (for customizations, this is the ref)

func (PortalCustomizationResource) GetRef 

func (c PortalCustomizationResource) GetRef() string

GetRef returns the reference identifier

func (PortalCustomizationResource) GetType added in v0.1.3 

func (c PortalCustomizationResource) GetType() ResourceType

GetType returns the resource type

func (*PortalCustomizationResource) SetDefaults 

func (c *PortalCustomizationResource) SetDefaults()

SetDefaults applies default values

func (*PortalCustomizationResource) TryMatchKonnectResource added in v0.1.3 

func (c *PortalCustomizationResource) TryMatchKonnectResource(_ any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (PortalCustomizationResource) Validate 

func (c PortalCustomizationResource) Validate() error

Validate ensures the portal customization resource is valid

type PortalEmailConfigResource added in v0.3.5 

type PortalEmailConfigResource struct {
	kkComps.PostPortalEmailConfig `       yaml:",inline"          json:",inline"`
	Ref                           string `yaml:"ref"              json:"ref"`
	Portal                        string `yaml:"portal,omitempty" json:"portal,omitempty"`

	DomainNameSet   bool `yaml:"-" json:"-"`
	FromNameSet     bool `yaml:"-" json:"-"`
	FromEmailSet    bool `yaml:"-" json:"-"`
	ReplyToEmailSet bool `yaml:"-" json:"-"`
	// contains filtered or unexported fields
}

PortalEmailConfigResource represents the portal email configuration (singleton child).

func (PortalEmailConfigResource) GetDependencies added in v0.3.5 

func (c PortalEmailConfigResource) GetDependencies() []ResourceRef

func (PortalEmailConfigResource) GetKonnectID added in v0.3.5 

func (c PortalEmailConfigResource) GetKonnectID() string

func (PortalEmailConfigResource) GetKonnectMonikerFilter added in v0.3.5 

func (c PortalEmailConfigResource) GetKonnectMonikerFilter() string

func (PortalEmailConfigResource) GetMoniker added in v0.3.5 

func (c PortalEmailConfigResource) GetMoniker() string

func (PortalEmailConfigResource) GetParentRef added in v0.3.5 

func (c PortalEmailConfigResource) GetParentRef() *ResourceRef

GetParentRef implements ResourceWithParent for inheritance of namespace and protection.

func (PortalEmailConfigResource) GetRef added in v0.3.5 

func (c PortalEmailConfigResource) GetRef() string

func (PortalEmailConfigResource) GetReferenceFieldMappings added in v0.3.5 

func (c PortalEmailConfigResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns cross-resource reference mappings for validation.

func (PortalEmailConfigResource) GetType added in v0.3.5 

func (c PortalEmailConfigResource) GetType() ResourceType

func (*PortalEmailConfigResource) SetDefaults added in v0.3.5 

func (c *PortalEmailConfigResource) SetDefaults()

func (*PortalEmailConfigResource) TryMatchKonnectResource added in v0.3.5 

func (c *PortalEmailConfigResource) TryMatchKonnectResource(konnectResource any) bool

func (*PortalEmailConfigResource) UnmarshalJSON added in v0.3.5 

func (c *PortalEmailConfigResource) UnmarshalJSON(data []byte) error

UnmarshalJSON rejects kongctl metadata on child resources.

func (PortalEmailConfigResource) Validate added in v0.3.5 

func (c PortalEmailConfigResource) Validate() error

type PortalEmailTemplateContent added in v0.3.5 

type PortalEmailTemplateContent struct {
	Subject     *string `yaml:"subject,omitempty"      json:"subject,omitempty"`
	Title       *string `yaml:"title,omitempty"        json:"title,omitempty"`
	Body        *string `yaml:"body,omitempty"         json:"body,omitempty"`
	ButtonLabel *string `yaml:"button_label,omitempty" json:"button_label,omitempty"`

	SubjectSet     bool `yaml:"-" json:"-"`
	TitleSet       bool `yaml:"-" json:"-"`
	BodySet        bool `yaml:"-" json:"-"`
	ButtonLabelSet bool `yaml:"-" json:"-"`
}

PortalEmailTemplateContent captures the customizable fields of an email template.

func (*PortalEmailTemplateContent) UnmarshalJSON added in v0.3.5 

func (c *PortalEmailTemplateContent) UnmarshalJSON(data []byte) error

UnmarshalJSON tracks which fields were explicitly set, including nulls.

type PortalEmailTemplateResource added in v0.3.5 

type PortalEmailTemplateResource struct {
	Ref     string                      `yaml:"ref"               json:"ref"`
	Portal  string                      `yaml:"portal,omitempty"  json:"portal,omitempty"`
	Name    kkComps.EmailTemplateName   `yaml:"name,omitempty"    json:"name,omitempty"`
	Content *PortalEmailTemplateContent `yaml:"content,omitempty" json:"content,omitempty"`
	Enabled *bool                       `yaml:"enabled,omitempty" json:"enabled,omitempty"`

	NameSet    bool `yaml:"-" json:"-"`
	ContentSet bool `yaml:"-" json:"-"`
	EnabledSet bool `yaml:"-" json:"-"`
	// contains filtered or unexported fields
}

PortalEmailTemplateResource represents a customizable portal email template.

func (PortalEmailTemplateResource) GetDependencies added in v0.3.5 

func (t PortalEmailTemplateResource) GetDependencies() []ResourceRef

func (PortalEmailTemplateResource) GetKonnectID added in v0.3.5 

func (t PortalEmailTemplateResource) GetKonnectID() string

func (PortalEmailTemplateResource) GetKonnectMonikerFilter added in v0.3.5 

func (t PortalEmailTemplateResource) GetKonnectMonikerFilter() string

func (PortalEmailTemplateResource) GetMoniker added in v0.3.5 

func (t PortalEmailTemplateResource) GetMoniker() string

func (PortalEmailTemplateResource) GetParentRef added in v0.3.5 

func (t PortalEmailTemplateResource) GetParentRef() *ResourceRef

GetParentRef implements ResourceWithParent for inheritance of namespace and protection.

func (PortalEmailTemplateResource) GetRef added in v0.3.5 

func (t PortalEmailTemplateResource) GetRef() string

func (PortalEmailTemplateResource) GetReferenceFieldMappings added in v0.3.5 

func (t PortalEmailTemplateResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns cross-resource reference mappings for validation.

func (PortalEmailTemplateResource) GetType added in v0.3.5 

func (t PortalEmailTemplateResource) GetType() ResourceType

func (*PortalEmailTemplateResource) SetDefaults added in v0.3.5 

func (t *PortalEmailTemplateResource) SetDefaults()

func (*PortalEmailTemplateResource) TryMatchKonnectResource added in v0.3.5 

func (t *PortalEmailTemplateResource) TryMatchKonnectResource(konnectResource any) bool

func (*PortalEmailTemplateResource) UnmarshalJSON added in v0.3.5 

func (t *PortalEmailTemplateResource) UnmarshalJSON(data []byte) error

UnmarshalJSON rejects kongctl metadata on child resources and tracks field presence.

func (PortalEmailTemplateResource) Validate added in v0.3.5 

func (t PortalEmailTemplateResource) Validate() error

type PortalPageResource 

type PortalPageResource struct {
	kkComps.CreatePortalPageRequest `                     yaml:",inline"                   json:",inline"`
	Ref                             string `yaml:"ref"                       json:"ref"`
	// Parent portal reference
	Portal string `yaml:"portal,omitempty"          json:"portal,omitempty"`
	// Reference to parent page
	ParentPageRef string `yaml:"parent_page_ref,omitempty" json:"parent_page_ref,omitempty"`
	// Nested child pages
	Children []PortalPageResource `yaml:"children,omitempty"        json:"children,omitempty"`
	// contains filtered or unexported fields
}

PortalPageResource represents a portal page

func (PortalPageResource) GetDependencies added in v0.1.3 

func (p PortalPageResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this page depends on

func (PortalPageResource) GetKonnectID added in v0.1.3 

func (p PortalPageResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalPageResource) GetKonnectMonikerFilter added in v0.1.3 

func (p PortalPageResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (PortalPageResource) GetMoniker added in v0.1.3 

func (p PortalPageResource) GetMoniker() string

GetMoniker returns the resource moniker (for pages, this is the slug)

func (PortalPageResource) GetRef 

func (p PortalPageResource) GetRef() string

GetRef returns the reference identifier

func (PortalPageResource) GetReferenceFieldMappings added in v0.1.6 

func (p PortalPageResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns cross-resource reference mappings for validation

func (PortalPageResource) GetType added in v0.1.3 

func (p PortalPageResource) GetType() ResourceType

GetType returns the resource type

func (*PortalPageResource) SetDefaults 

func (p *PortalPageResource) SetDefaults()

SetDefaults applies default values

func (*PortalPageResource) TryMatchKonnectResource added in v0.1.3 

func (p *PortalPageResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (PortalPageResource) Validate 

func (p PortalPageResource) Validate() error

Validate ensures the portal page resource is valid

type PortalResource 

type PortalResource struct {
	BaseResource
	kkComps.CreatePortal `yaml:",inline" json:",inline"`

	// Child resources that match API endpoints
	Customization  *PortalCustomizationResource           `yaml:"customization,omitempty"   json:"customization,omitempty"`
	AuthSettings   *PortalAuthSettingsResource            `yaml:"auth_settings,omitempty"   json:"auth_settings,omitempty"`
	CustomDomain   *PortalCustomDomainResource            `yaml:"custom_domain,omitempty"   json:"custom_domain,omitempty"`
	Pages          []PortalPageResource                   `yaml:"pages,omitempty"           json:"pages,omitempty"`
	Snippets       []PortalSnippetResource                `yaml:"snippets,omitempty"        json:"snippets,omitempty"`
	Teams          []PortalTeamResource                   `yaml:"teams,omitempty"           json:"teams,omitempty"`
	EmailConfig    *PortalEmailConfigResource             `yaml:"email_config,omitempty"    json:"email_config,omitempty"`
	EmailTemplates map[string]PortalEmailTemplateResource `yaml:"email_templates,omitempty" json:"email_templates,omitempty"` //nolint:lll

	// Assets object containing logo and favicon (data URLs from !file tag)
	Assets *PortalAssetsResource `yaml:"assets,omitempty" json:"assets,omitempty"`

	// External resource marker
	External *ExternalBlock `yaml:"_external,omitempty" json:"_external,omitempty"`
}

PortalResource represents a portal in declarative configuration

func (PortalResource) GetDependencies 

func (p PortalResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this portal depends on

func (PortalResource) GetKonnectMonikerFilter 

func (p PortalResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (PortalResource) GetLabels 

func (p PortalResource) GetLabels() map[string]string

GetLabels returns the labels for this resource

func (PortalResource) GetMoniker 

func (p PortalResource) GetMoniker() string

GetMoniker returns the resource moniker (for portals, this is the name)

func (PortalResource) GetReferenceFieldMappings 

func (p PortalResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns the field mappings for reference validation

func (PortalResource) GetType added in v0.1.3 

func (p PortalResource) GetType() ResourceType

GetType returns the resource type

func (*PortalResource) IsExternal added in v0.1.5 

func (p *PortalResource) IsExternal() bool

IsExternal returns true if this portal is externally managed

func (PortalResource) MarshalJSON added in v0.3.3 

func (p PortalResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures the embedded SDK model and Kongctl fields are preserved when serializing.

func (PortalResource) MarshalYAML added in v0.3.3 

func (p PortalResource) MarshalYAML() (any, error)

MarshalYAML ensures YAML output mirrors the custom JSON encoding.

func (*PortalResource) SetDefaults 

func (p *PortalResource) SetDefaults()

SetDefaults applies default values to portal resource

func (*PortalResource) SetLabels 

func (p *PortalResource) SetLabels(labels map[string]string)

SetLabels sets the labels for this resource

func (*PortalResource) TryMatchKonnectResource 

func (p *PortalResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*PortalResource) UnmarshalJSON added in v0.3.3 

func (p *PortalResource) UnmarshalJSON(data []byte) error

UnmarshalJSON ensures both the embedded SDK model and portal-specific fields (like ref and kongctl metadata) are populated when decoding from JSON/YAML while still surfacing unknown field errors (used for typo detection).

func (PortalResource) Validate 

func (p PortalResource) Validate() error

Validate ensures the portal resource is valid

type PortalSnippetResource 

type PortalSnippetResource struct {
	Ref string `yaml:"ref"                   json:"ref"`
	// Parent portal reference
	Portal      string                           `yaml:"portal,omitempty"      json:"portal,omitempty"`
	Name        string                           `yaml:"name"                  json:"name"`
	Content     string                           `yaml:"content"               json:"content"`
	Title       *string                          `yaml:"title,omitempty"       json:"title,omitempty"`
	Visibility  *kkComps.SnippetVisibilityStatus `yaml:"visibility,omitempty"  json:"visibility,omitempty"`
	Status      *kkComps.PublishedStatus         `yaml:"status,omitempty"      json:"status,omitempty"`
	Description *string                          `yaml:"description,omitempty" json:"description,omitempty"`
	// contains filtered or unexported fields
}

PortalSnippetResource represents a portal snippet

func (PortalSnippetResource) GetDependencies added in v0.1.3 

func (s PortalSnippetResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this snippet depends on

func (PortalSnippetResource) GetKonnectID added in v0.1.3 

func (s PortalSnippetResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalSnippetResource) GetKonnectMonikerFilter added in v0.1.3 

func (s PortalSnippetResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (PortalSnippetResource) GetMoniker added in v0.1.3 

func (s PortalSnippetResource) GetMoniker() string

GetMoniker returns the resource moniker (for snippets, this is the name)

func (PortalSnippetResource) GetRef 

func (s PortalSnippetResource) GetRef() string

GetRef returns the reference identifier

func (PortalSnippetResource) GetReferenceFieldMappings added in v0.1.6 

func (s PortalSnippetResource) GetReferenceFieldMappings() map[string]string

GetReferenceFieldMappings returns cross-resource reference mappings for validation

func (PortalSnippetResource) GetType added in v0.1.3 

func (s PortalSnippetResource) GetType() ResourceType

GetType returns the resource type

func (*PortalSnippetResource) SetDefaults 

func (s *PortalSnippetResource) SetDefaults()

SetDefaults applies default values

func (*PortalSnippetResource) TryMatchKonnectResource added in v0.1.3 

func (s *PortalSnippetResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (PortalSnippetResource) Validate 

func (s PortalSnippetResource) Validate() error

Validate ensures the portal snippet resource is valid

type PortalTeamResource added in v0.3.3 

type PortalTeamResource struct {
	kkComps.PortalCreateTeamRequest `       yaml:",inline"          json:",inline"`
	Ref                             string `yaml:"ref"              json:"ref"`
	// Parent portal reference
	Portal string `yaml:"portal,omitempty" json:"portal,omitempty"`

	// Child resources
	Roles []PortalTeamRoleResource `yaml:"roles,omitempty" json:"roles,omitempty"`
	// contains filtered or unexported fields
}

PortalTeamResource represents a portal team (developer team)

func (PortalTeamResource) GetDependencies added in v0.3.3 

func (p PortalTeamResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this team depends on

func (PortalTeamResource) GetKonnectID added in v0.3.3 

func (p PortalTeamResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalTeamResource) GetKonnectMonikerFilter added in v0.3.3 

func (p PortalTeamResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (PortalTeamResource) GetMoniker added in v0.3.3 

func (p PortalTeamResource) GetMoniker() string

GetMoniker returns the resource moniker (for portal teams, this is the name)

func (PortalTeamResource) GetParentRef added in v0.3.3 

func (p PortalTeamResource) GetParentRef() *ResourceRef

GetParentRef returns the parent portal reference

func (PortalTeamResource) GetRef added in v0.3.3 

func (p PortalTeamResource) GetRef() string

GetRef returns the reference identifier

func (PortalTeamResource) GetType added in v0.3.3 

func (p PortalTeamResource) GetType() ResourceType

GetType returns the resource type

func (*PortalTeamResource) SetDefaults added in v0.3.3 

func (p *PortalTeamResource) SetDefaults()

SetDefaults applies default values to portal team resource

func (*PortalTeamResource) TryMatchKonnectResource added in v0.3.3 

func (p *PortalTeamResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*PortalTeamResource) UnmarshalJSON added in v0.3.3 

func (p *PortalTeamResource) UnmarshalJSON(data []byte) error

UnmarshalJSON custom unmarshaling to reject kongctl metadata on child resources

func (PortalTeamResource) Validate added in v0.3.3 

func (p PortalTeamResource) Validate() error

Validate ensures the portal team resource is valid

type PortalTeamRoleResource added in v0.3.4 

type PortalTeamRoleResource struct {
	Ref string `yaml:"ref" json:"ref"`

	// Parent references
	Portal string `yaml:"portal,omitempty" json:"portal,omitempty"`
	Team   string `yaml:"team,omitempty"   json:"team,omitempty"`

	// Role assignment fields (API expects literal values)
	RoleName       string `yaml:"role_name"        json:"role_name"`
	EntityID       string `yaml:"entity_id"        json:"entity_id"`
	EntityTypeName string `yaml:"entity_type_name" json:"entity_type_name"`
	EntityRegion   string `yaml:"entity_region"    json:"entity_region"`
	// contains filtered or unexported fields
}

PortalTeamRoleResource represents an assigned role on a portal team This is a child resource (no kongctl metadata support).

func (PortalTeamRoleResource) GetDependencies added in v0.3.4 

func (r PortalTeamRoleResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this assignment depends on

func (PortalTeamRoleResource) GetKonnectID added in v0.3.4 

func (r PortalTeamRoleResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available

func (PortalTeamRoleResource) GetKonnectMonikerFilter added in v0.3.4 

func (r PortalTeamRoleResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup

func (PortalTeamRoleResource) GetMoniker added in v0.3.4 

func (r PortalTeamRoleResource) GetMoniker() string

GetMoniker returns a human-readable moniker for matching purposes

func (PortalTeamRoleResource) GetParentRef added in v0.3.4 

func (r PortalTeamRoleResource) GetParentRef() *ResourceRef

GetParentRef returns the immediate parent reference (portal team)

func (PortalTeamRoleResource) GetRef added in v0.3.4 

func (r PortalTeamRoleResource) GetRef() string

GetRef returns the reference identifier

func (PortalTeamRoleResource) GetType added in v0.3.4 

func (r PortalTeamRoleResource) GetType() ResourceType

GetType returns the resource type

func (*PortalTeamRoleResource) SetDefaults added in v0.3.4 

func (r *PortalTeamRoleResource) SetDefaults()

SetDefaults applies default values (none for team roles)

func (*PortalTeamRoleResource) TryMatchKonnectResource added in v0.3.4 

func (r *PortalTeamRoleResource) TryMatchKonnectResource(konnectResource any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource

func (*PortalTeamRoleResource) UnmarshalJSON added in v0.3.4 

func (r *PortalTeamRoleResource) UnmarshalJSON(data []byte) error

UnmarshalJSON rejects kongctl metadata on child resources

func (PortalTeamRoleResource) Validate added in v0.3.4 

func (r PortalTeamRoleResource) Validate() error

Validate ensures the portal team role resource is valid

type RefReader added in v0.1.3 

type RefReader interface {
	// HasRef checks if a ref exists globally across all resource types
	HasRef(ref string) bool

	// GetResourceByRef returns the resource for a given ref
	// Returns nil and false if not found
	GetResourceByRef(ref string) (Resource, bool)

	// GetResourceTypeByRef returns the resource type for a given ref
	// This is a convenience method that uses GetResourceByRef
	GetResourceTypeByRef(ref string) (ResourceType, bool)
}

RefReader provides read-only access to resources by ref

type ReferenceMapping 

type ReferenceMapping interface {
	GetReferenceFieldMappings() map[string]string
}

ReferenceMapping interface for resources that have reference fields

type ReferencedResource 

type ReferencedResource interface {
	GetRef() string
}

ReferencedResource interface for resources that can be referenced

type Resource 

type Resource interface {
	GetType() ResourceType
	GetRef() string
	GetMoniker() string // Generic identifier (name, username, version, etc.)
	GetDependencies() []ResourceRef
	Validate() error
	SetDefaults()

	// Identity resolution methods
	GetKonnectID() string                             // Returns the Konnect ID if resolved, empty otherwise
	GetKonnectMonikerFilter() string                  // Returns filter string for Konnect API lookup
	TryMatchKonnectResource(konnectResource any) bool // Matches against Konnect resource
}

Resource is the common interface for all declarative resources

type ResourceRef 

type ResourceRef struct {
	Kind string `json:"kind" yaml:"kind"`
	Ref  string `json:"ref"  yaml:"ref"`
}

ResourceRef represents a reference to another resource

type ResourceSet 

type ResourceSet struct {
	Portals []PortalResource `yaml:"portals,omitempty"                        json:"portals,omitempty"`
	// ApplicationAuthStrategies contains auth strategy configurations
	ApplicationAuthStrategies []ApplicationAuthStrategyResource `yaml:"application_auth_strategies,omitempty"    json:"application_auth_strategies,omitempty"` //nolint:lll
	// ControlPlanes contains control plane configurations
	ControlPlanes   []ControlPlaneResource   `yaml:"control_planes,omitempty"                 json:"control_planes,omitempty"`   //nolint:lll
	CatalogServices []CatalogServiceResource `yaml:"catalog_services,omitempty"               json:"catalog_services,omitempty"` //nolint:lll
	APIs            []APIResource            `yaml:"apis,omitempty"                           json:"apis,omitempty"`
	GatewayServices []GatewayServiceResource `yaml:"gateway_services,omitempty"               json:"gateway_services,omitempty"` //nolint:lll
	// API child resources can be defined at root level (with parent reference) or nested under APIs
	APIVersions        []APIVersionResource        `yaml:"api_versions,omitempty"                   json:"api_versions,omitempty"`        //nolint:lll
	APIPublications    []APIPublicationResource    `yaml:"api_publications,omitempty"               json:"api_publications,omitempty"`    //nolint:lll
	APIImplementations []APIImplementationResource `yaml:"api_implementations,omitempty"            json:"api_implementations,omitempty"` //nolint:lll
	APIDocuments       []APIDocumentResource       `yaml:"api_documents,omitempty"                  json:"api_documents,omitempty"`       //nolint:lll
	// Portal child resources can be defined at root level (with parent reference) or nested under Portals
	PortalCustomizations        []PortalCustomizationResource        `yaml:"portal_customizations,omitempty"          json:"portal_customizations,omitempty"`          //nolint:lll
	PortalAuthSettings          []PortalAuthSettingsResource         `yaml:"portal_auth_settings,omitempty"           json:"portal_auth_settings,omitempty"`           //nolint:lll
	PortalCustomDomains         []PortalCustomDomainResource         `yaml:"portal_custom_domains,omitempty"          json:"portal_custom_domains,omitempty"`          //nolint:lll
	PortalPages                 []PortalPageResource                 `yaml:"portal_pages,omitempty"                   json:"portal_pages,omitempty"`                   //nolint:lll
	PortalSnippets              []PortalSnippetResource              `yaml:"portal_snippets,omitempty"                json:"portal_snippets,omitempty"`                //nolint:lll
	PortalTeams                 []PortalTeamResource                 `yaml:"portal_teams,omitempty"                   json:"portal_teams,omitempty"`                   //nolint:lll
	PortalTeamRoles             []PortalTeamRoleResource             `yaml:"portal_team_roles,omitempty"              json:"portal_team_roles,omitempty"`              //nolint:lll
	PortalAssetLogos            []PortalAssetLogoResource            `yaml:"portal_asset_logos,omitempty"             json:"portal_asset_logos,omitempty"`             //nolint:lll
	PortalAssetFavicons         []PortalAssetFaviconResource         `yaml:"portal_asset_favicons,omitempty"          json:"portal_asset_favicons,omitempty"`          //nolint:lll
	PortalEmailConfigs          []PortalEmailConfigResource          `yaml:"portal_email_configs,omitempty"           json:"portal_email_configs,omitempty"`           //nolint:lll
	PortalEmailTemplates        []PortalEmailTemplateResource        `yaml:"portal_email_templates,omitempty"         json:"portal_email_templates,omitempty"`         //nolint:lll
	EventGatewayControlPlanes   []EventGatewayControlPlaneResource   `yaml:"event_gateways,omitempty"                 json:"event_gateways,omitempty"`                 //nolint:lll
	EventGatewayBackendClusters []EventGatewayBackendClusterResource `yaml:"event_gateway_backend_clusters,omitempty" json:"event_gateway_backend_clusters,omitempty"` //nolint:lll
	EventGatewayVirtualClusters []EventGatewayVirtualClusterResource `yaml:"event_gateway_virtual_clusters,omitempty" json:"event_gateway_virtual_clusters,omitempty"` //nolint:lll
	// Organization grouping - contains nested resources like teams
	Organization *OrganizationResource `yaml:"organization,omitempty"                   json:"organization,omitempty"`
	// Teams is populated internally from OrganizationTeams during loading
	// It is not exposed in YAML/JSON to enforce the organization grouping format
	OrganizationTeams                 []OrganizationTeamResource                 `yaml:"-" json:"-"`
	EventGatewayListeners             []EventGatewayListenerResource             `yaml:"event_gateway_listeners,omitempty" json:"event_gateway_listeners,omitempty"`                             //nolint:lll
	EventGatewayListenerPolicies      []EventGatewayListenerPolicyResource       `yaml:"event_gateway_listener_policies,omitempty" json:"event_gateway_listener_policies,omitempty"`             //nolint:lll
	EventGatewayDataPlaneCertificates []EventGatewayDataPlaneCertificateResource `yaml:"event_gateway_data_plane_certificates,omitempty" json:"event_gateway_data_plane_certificates,omitempty"` //nolint:lll
	// DefaultNamespace tracks namespace from _defaults when no resources are present
	// This is used by the planner to determine which namespace to check for deletions
	DefaultNamespace  string   `yaml:"-"                                        json:"-"`
	DefaultNamespaces []string `yaml:"-"                                        json:"-"`
}

ResourceSet contains all declarative resources from configuration files

func (*ResourceSet) AddDefaultNamespace added in v0.3.4 

func (rs *ResourceSet) AddDefaultNamespace(namespace string)

AddDefaultNamespace records a default namespace if not already present. The first value encountered is also stored in DefaultNamespace for backward compatibility.

func (*ResourceSet) AllResources added in v0.5.0 

func (rs *ResourceSet) AllResources() []Resource

AllResources returns all resources in the ResourceSet as a slice of Resource interface. Uses registered accessors to collect resources from all typed slices. Resources not yet registered in the registry will not be included.

NOTE: This allocates a new slice. For iteration without allocation, use ForEachResource.

func (*ResourceSet) AllResourcesByType added in v0.5.0 

func (rs *ResourceSet) AllResourcesByType(rt ResourceType) []Resource

AllResourcesByType returns resources of a specific type from the ResourceSet. Returns nil if the resource type is not registered.

func (*ResourceSet) AppendAll added in v0.5.0 

func (rs *ResourceSet) AppendAll(src *ResourceSet)

AppendAll appends all resources from src to dest for all registered types.

func (*ResourceSet) ForEachResource added in v0.5.0 

func (rs *ResourceSet) ForEachResource(fn func(Resource) bool) bool

ForEachResource iterates over all resources without allocating a slice. The callback returns false to stop iteration early. Returns true if all resources were visited, false if stopped early.

func (*ResourceSet) GetAPIByRef added in v0.1.4 

func (rs *ResourceSet) GetAPIByRef(ref string) *APIResource

GetAPIByRef returns an API resource by its ref from any namespace

func (*ResourceSet) GetAPIDocumentsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetAPIDocumentsByNamespace(namespace string) []APIDocumentResource

GetAPIDocumentsByNamespace returns all API document resources from the specified namespace

func (*ResourceSet) GetAPIImplementationsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetAPIImplementationsByNamespace(namespace string) []APIImplementationResource

GetAPIImplementationsByNamespace returns all API implementation resources from the specified namespace

func (*ResourceSet) GetAPIPublicationsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetAPIPublicationsByNamespace(namespace string) []APIPublicationResource

GetAPIPublicationsByNamespace returns all API publication resources from the specified namespace

func (*ResourceSet) GetAPIVersionsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetAPIVersionsByNamespace(namespace string) []APIVersionResource

GetAPIVersionsByNamespace returns all API version resources from the specified namespace

func (*ResourceSet) GetAPIsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetAPIsByNamespace(namespace string) []APIResource

GetAPIsByNamespace returns all API resources from the specified namespace

func (*ResourceSet) GetAuthStrategiesByNamespace added in v0.1.4 

func (rs *ResourceSet) GetAuthStrategiesByNamespace(namespace string) []ApplicationAuthStrategyResource

GetAuthStrategiesByNamespace returns all auth strategy resources from the specified namespace

func (*ResourceSet) GetAuthStrategyByRef added in v0.1.4 

func (rs *ResourceSet) GetAuthStrategyByRef(ref string) *ApplicationAuthStrategyResource

GetAuthStrategyByRef returns an auth strategy resource by its ref from any namespace

func (*ResourceSet) GetBackendClusterByRef added in v0.4.0 

func (rs *ResourceSet) GetBackendClusterByRef(ref string) *EventGatewayBackendClusterResource

GetBackendClusterByRef returns a backend cluster resource by its ref from any namespace

func (*ResourceSet) GetBackendClustersForGateway added in v0.3.8 

func (rs *ResourceSet) GetBackendClustersForGateway(gatewayRef string) []EventGatewayBackendClusterResource

GetBackendClustersForGateway returns all backend clusters (nested + root-level) for a given gateway ref

func (*ResourceSet) GetCatalogServiceByRef added in v0.3.6 

func (rs *ResourceSet) GetCatalogServiceByRef(ref string) *CatalogServiceResource

GetCatalogServiceByRef returns a catalog service resource by its ref from any namespace

func (*ResourceSet) GetCatalogServicesByNamespace added in v0.3.6 

func (rs *ResourceSet) GetCatalogServicesByNamespace(namespace string) []CatalogServiceResource

GetCatalogServicesByNamespace returns all catalog service resources from the specified namespace

func (*ResourceSet) GetControlPlaneByRef added in v0.3.0 

func (rs *ResourceSet) GetControlPlaneByRef(ref string) *ControlPlaneResource

GetControlPlaneByRef returns a control plane resource by its ref from any namespace

func (*ResourceSet) GetControlPlanesByNamespace added in v0.1.6 

func (rs *ResourceSet) GetControlPlanesByNamespace(namespace string) []ControlPlaneResource

GetControlPlanesByNamespace returns all control plane resources from the specified namespace

func (*ResourceSet) GetDataPlaneCertificatesForGateway added in v0.6.0 

func (rs *ResourceSet) GetDataPlaneCertificatesForGateway(
	gatewayRef string,
) []EventGatewayDataPlaneCertificateResource

GetDataPlaneCertificatesForGateway returns all data plane certificates (nested + root-level) for a specific event gateway

func (*ResourceSet) GetEventGatewayControlPlanesByNamespace added in v0.3.7 

func (rs *ResourceSet) GetEventGatewayControlPlanesByNamespace(namespace string) []EventGatewayControlPlaneResource

GetEventGatewayControlPlanesByNamespace returns all EGW CP resources from the specified namespace

func (*ResourceSet) GetListenersForEventGateway added in v0.5.0 

func (rs *ResourceSet) GetListenersForEventGateway(gatewayRef string) []EventGatewayListenerResource

GetListenersForEventGateway returns all listeners (nested + root-level) for a specific event gateway

func (*ResourceSet) GetOrganizationTeamsByNamespace added in v0.4.0 

func (rs *ResourceSet) GetOrganizationTeamsByNamespace(namespace string) []OrganizationTeamResource

GetOrganizationTeamsByNamespace returns all organization_team resources from the specified namespace

func (*ResourceSet) GetPoliciesForListener added in v0.5.0 

func (rs *ResourceSet) GetPoliciesForListener(listenerRef string) []EventGatewayListenerPolicyResource

GetPoliciesForListener returns all listener policies (nested + root-level) for a specific listener

func (*ResourceSet) GetPortalAuthSettingsByNamespace added in v0.3.4 

func (rs *ResourceSet) GetPortalAuthSettingsByNamespace(namespace string) []PortalAuthSettingsResource

GetPortalAuthSettingsByNamespace returns all portal auth settings resources from the specified namespace

func (*ResourceSet) GetPortalByRef added in v0.1.4 

func (rs *ResourceSet) GetPortalByRef(ref string) *PortalResource

GetPortalByRef returns a portal resource by its ref from any namespace

func (*ResourceSet) GetPortalCustomDomainsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetPortalCustomDomainsByNamespace(namespace string) []PortalCustomDomainResource

GetPortalCustomDomainsByNamespace returns all portal custom domain resources from the specified namespace

func (*ResourceSet) GetPortalCustomizationsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetPortalCustomizationsByNamespace(namespace string) []PortalCustomizationResource

GetPortalCustomizationsByNamespace returns all portal customization resources from the specified namespace

func (*ResourceSet) GetPortalEmailConfigsByNamespace added in v0.3.5 

func (rs *ResourceSet) GetPortalEmailConfigsByNamespace(namespace string) []PortalEmailConfigResource

GetPortalEmailConfigsByNamespace returns all portal email config resources from the specified namespace

func (*ResourceSet) GetPortalEmailTemplatesByNamespace added in v0.3.5 

func (rs *ResourceSet) GetPortalEmailTemplatesByNamespace(namespace string) []PortalEmailTemplateResource

GetPortalEmailTemplatesByNamespace returns all portal email template resources from the specified namespace

func (*ResourceSet) GetPortalPagesByNamespace added in v0.1.4 

func (rs *ResourceSet) GetPortalPagesByNamespace(namespace string) []PortalPageResource

GetPortalPagesByNamespace returns all portal page resources from the specified namespace

func (*ResourceSet) GetPortalSnippetsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetPortalSnippetsByNamespace(namespace string) []PortalSnippetResource

GetPortalSnippetsByNamespace returns all portal snippet resources from the specified namespace

func (*ResourceSet) GetPortalTeamRolesByNamespace added in v0.3.4 

func (rs *ResourceSet) GetPortalTeamRolesByNamespace(namespace string) []PortalTeamRoleResource

GetPortalTeamRolesByNamespace returns all portal team role resources from the specified namespace

func (*ResourceSet) GetPortalTeamsByNamespace added in v0.3.3 

func (rs *ResourceSet) GetPortalTeamsByNamespace(namespace string) []PortalTeamResource

GetPortalTeamsByNamespace returns all portal team resources from the specified namespace

func (*ResourceSet) GetPortalsByNamespace added in v0.1.4 

func (rs *ResourceSet) GetPortalsByNamespace(namespace string) []PortalResource

GetPortalsByNamespace returns all portal resources from the specified namespace

func (*ResourceSet) GetResourceByRef added in v0.1.3 

func (rs *ResourceSet) GetResourceByRef(ref string) (Resource, bool)

GetResourceByRef returns the resource for a given ref

func (*ResourceSet) GetResourceTypeByRef added in v0.1.3 

func (rs *ResourceSet) GetResourceTypeByRef(ref string) (ResourceType, bool)

GetResourceTypeByRef returns the resource type for a given ref

func (*ResourceSet) GetVirtualClusterByRef added in v0.5.0 

func (rs *ResourceSet) GetVirtualClusterByRef(ref string) *EventGatewayVirtualClusterResource

GetVirtualClusterByRef returns a virtual cluster resource by its ref from any namespace

func (*ResourceSet) GetVirtualClustersForGateway added in v0.4.0 

func (rs *ResourceSet) GetVirtualClustersForGateway(gatewayRef string) []EventGatewayVirtualClusterResource

GetVirtualClustersForGateway returns all virtual clusters (nested + root-level) for a given gateway ref

func (*ResourceSet) HasRef added in v0.1.3 

func (rs *ResourceSet) HasRef(ref string) bool

HasRef checks if a ref exists globally across all resource types

func (*ResourceSet) IsEmpty added in v0.5.0 

func (rs *ResourceSet) IsEmpty() bool

IsEmpty returns true if the ResourceSet contains no resources.

func (*ResourceSet) ResourceCount added in v0.5.0 

func (rs *ResourceSet) ResourceCount() int

ResourceCount returns the total number of resources across all registered types. Time complexity - O(number of resource types)

type ResourceType added in v0.1.3 

type ResourceType string

ResourceType represents the type of a declarative resource 

const (
	ResourceTypePortal                           ResourceType = "portal"
	ResourceTypeApplicationAuthStrategy          ResourceType = "application_auth_strategy"
	ResourceTypeControlPlane                     ResourceType = "control_plane"
	ResourceTypeAPI                              ResourceType = "api"
	ResourceTypeAPIVersion                       ResourceType = "api_version"
	ResourceTypeAPIPublication                   ResourceType = "api_publication"
	ResourceTypeAPIImplementation                ResourceType = "api_implementation"
	ResourceTypeAPIDocument                      ResourceType = "api_document"
	ResourceTypeGatewayService                   ResourceType = "gateway_service"
	ResourceTypePortalCustomization              ResourceType = "portal_customization"
	ResourceTypePortalCustomDomain               ResourceType = "portal_custom_domain"
	ResourceTypePortalAuthSettings               ResourceType = "portal_auth_settings"
	ResourceTypePortalPage                       ResourceType = "portal_page"
	ResourceTypePortalSnippet                    ResourceType = "portal_snippet"
	ResourceTypePortalTeam                       ResourceType = "portal_team"
	ResourceTypePortalTeamRole                   ResourceType = "portal_team_role"
	ResourceTypePortalAssetFavicon               ResourceType = "portal_asset_favicon"
	ResourceTypePortalEmailConfig                ResourceType = "portal_email_config"
	ResourceTypePortalEmailTemplate              ResourceType = "portal_email_template"
	ResourceTypeCatalogService                   ResourceType = "catalog_service"
	ResourceTypeEventGatewayControlPlane         ResourceType = "event_gateway"
	ResourceTypeEventGatewayBackendCluster       ResourceType = "event_gateway_backend_cluster"
	ResourceTypeEventGatewayVirtualCluster       ResourceType = "event_gateway_virtual_cluster"
	ResourceTypeOrganizationTeam                 ResourceType = "organization_team"
	ResourceTypeEventGatewayListener             ResourceType = "event_gateway_listener"
	ResourceTypeEventGatewayListenerPolicy       ResourceType = "event_gateway_listener_policy"
	ResourceTypeEventGatewayDataPlaneCertificate ResourceType = "event_gateway_data_plane_certificate"
)

Resource type constants

func RegisteredTypes added in v0.5.0 

func RegisteredTypes() []ResourceType

RegisteredTypes returns all registered resource types.

type ResourceValidator 

type ResourceValidator interface {
	Validate() error
}

ResourceValidator interface for common validation behavior

type ResourceWithLabels 

type ResourceWithLabels interface {
	Resource
	GetLabels() map[string]string
	SetLabels(map[string]string)
}

ResourceWithLabels represents resources that support labels

type ResourceWithParent 

type ResourceWithParent interface {
	Resource
	GetParentRef() *ResourceRef
}

ResourceWithParent represents resources that have a parent

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.