resources

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SchemaFieldRef               = "ref"
	SchemaFieldPortal            = "portal"
	SchemaFieldTeams             = "teams"
	SchemaFieldAIGateway         = "ai_gateway"
	SchemaFieldAIGatewayConsumer = "ai_gateway_consumer"
	SchemaFieldKongctl           = "kongctl"
	SchemaFieldID                = "id"
	SchemaFieldCreatedAt         = "created_at"
	SchemaFieldUpdatedAt         = "updated_at"
)
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 = ""
)
View Source 
const UnknownReferenceID = "[unknown]"

UnknownReferenceID is the sentinel value used when a resource reference or name cannot be resolved.

Variables

This section is empty.

Functions

func AIGatewayAgentDisplayName added in v1.5.0 

func AIGatewayAgentDisplayName(agent any) string

func AIGatewayAgentEnabled added in v1.5.0 

func AIGatewayAgentEnabled(agent any) *bool

func AIGatewayAgentID added in v1.5.0 

func AIGatewayAgentID(agent any) string

func AIGatewayAgentLabels added in v1.5.0 

func AIGatewayAgentLabels(agent any) map[string]string

func AIGatewayAgentMutablePayloadMap added in v1.5.0 

func AIGatewayAgentMutablePayloadMap(agent kkComps.AIGatewayAgent) (map[string]any, error)

func AIGatewayAgentName added in v1.5.0 

func AIGatewayAgentName(agent any) string

func AIGatewayAgentType added in v1.5.0 

func AIGatewayAgentType(agent any) string

func AIGatewayAgentUpdatedAt added in v1.5.0 

func AIGatewayAgentUpdatedAt(agent any) time.Time

func AIGatewayConsumerCredentialDisplayName added in v1.5.0 

func AIGatewayConsumerCredentialDisplayName(credential any) string

func AIGatewayConsumerCredentialID added in v1.5.0 

func AIGatewayConsumerCredentialID(credential any) string

func AIGatewayConsumerCredentialLabels added in v1.5.0 

func AIGatewayConsumerCredentialLabels(credential any) map[string]string

func AIGatewayConsumerCredentialMutablePayloadMap added in v1.5.0 

func AIGatewayConsumerCredentialMutablePayloadMap(
	credential kkComps.AIGatewayConsumerCredential,
) (map[string]any, error)

func AIGatewayConsumerCredentialName added in v1.5.0 

func AIGatewayConsumerCredentialName(credential any) string

func AIGatewayConsumerCredentialUpdatedAt added in v1.5.0 

func AIGatewayConsumerCredentialUpdatedAt(credential any) time.Time

func AIGatewayConsumerDisplayName added in v1.5.0 

func AIGatewayConsumerDisplayName(consumer any) string

func AIGatewayConsumerGroupConsumers added in v1.5.0 

func AIGatewayConsumerGroupConsumers(group any) ([]string, bool, error)

func AIGatewayConsumerGroupDisplayName added in v1.5.0 

func AIGatewayConsumerGroupDisplayName(group any) string

func AIGatewayConsumerGroupID added in v1.5.0 

func AIGatewayConsumerGroupID(group any) string

func AIGatewayConsumerGroupLabels added in v1.5.0 

func AIGatewayConsumerGroupLabels(group any) map[string]string

func AIGatewayConsumerGroupMutablePayloadMap added in v1.5.0 

func AIGatewayConsumerGroupMutablePayloadMap(group kkComps.AIGatewayConsumerGroup) (map[string]any, error)

func AIGatewayConsumerGroupName added in v1.5.0 

func AIGatewayConsumerGroupName(group any) string

func AIGatewayConsumerGroupUpdatedAt added in v1.5.0 

func AIGatewayConsumerGroupUpdatedAt(group any) time.Time

func AIGatewayConsumerID added in v1.5.0 

func AIGatewayConsumerID(consumer any) string

func AIGatewayConsumerLabels added in v1.5.0 

func AIGatewayConsumerLabels(consumer any) map[string]string

func AIGatewayConsumerMutablePayloadMap added in v1.5.0 

func AIGatewayConsumerMutablePayloadMap(consumer kkComps.AIGatewayConsumer) (map[string]any, error)

func AIGatewayConsumerName added in v1.5.0 

func AIGatewayConsumerName(consumer any) string

func AIGatewayConsumerUpdatedAt added in v1.5.0 

func AIGatewayConsumerUpdatedAt(consumer any) time.Time

func AIGatewayDataPlaneCertificateID added in v1.5.0 

func AIGatewayDataPlaneCertificateID(cert any) string

func AIGatewayDataPlaneCertificateTitle added in v1.5.0 

func AIGatewayDataPlaneCertificateTitle(cert any) string

func AIGatewayMCPServerDisplayName added in v1.5.0 

func AIGatewayMCPServerDisplayName(server any) string

func AIGatewayMCPServerEnabled added in v1.5.0 

func AIGatewayMCPServerEnabled(server any) *bool

func AIGatewayMCPServerID added in v1.5.0 

func AIGatewayMCPServerID(server any) string

func AIGatewayMCPServerLabels added in v1.5.0 

func AIGatewayMCPServerLabels(server any) map[string]string

func AIGatewayMCPServerMutablePayloadMap added in v1.5.0 

func AIGatewayMCPServerMutablePayloadMap(server kkComps.AIGatewayMCPServer) (map[string]any, error)

func AIGatewayMCPServerName added in v1.5.0 

func AIGatewayMCPServerName(server any) string

func AIGatewayMCPServerType added in v1.5.0 

func AIGatewayMCPServerType(server any) string

func AIGatewayMCPServerUpdatedAt added in v1.5.0 

func AIGatewayMCPServerUpdatedAt(server any) time.Time

func AIGatewayModelDisplayName added in v1.5.0 

func AIGatewayModelDisplayName(model kkComps.AIGatewayModel) string

func AIGatewayModelEnabled added in v1.5.0 

func AIGatewayModelEnabled(model kkComps.AIGatewayModel) *bool

func AIGatewayModelID added in v1.5.0 

func AIGatewayModelID(model any) string

func AIGatewayModelLabels added in v1.5.0 

func AIGatewayModelLabels(model any) map[string]string

func AIGatewayModelMutablePayloadMap added in v1.5.0 

func AIGatewayModelMutablePayloadMap(model kkComps.AIGatewayModel) (map[string]any, error)

func AIGatewayModelName added in v1.5.0 

func AIGatewayModelName(model any) string

func AIGatewayModelType added in v1.5.0 

func AIGatewayModelType(model kkComps.AIGatewayModel) string

func AIGatewayModelUpdatedAt added in v1.5.0 

func AIGatewayModelUpdatedAt(model kkComps.AIGatewayModel) time.Time

func AIGatewayPolicyDisplayName added in v1.5.0 

func AIGatewayPolicyDisplayName(policy any) string

func AIGatewayPolicyEnabled added in v1.5.0 

func AIGatewayPolicyEnabled(policy any) *bool

func AIGatewayPolicyGlobal added in v1.5.0 

func AIGatewayPolicyGlobal(policy any) *bool

func AIGatewayPolicyID added in v1.5.0 

func AIGatewayPolicyID(policy any) string

func AIGatewayPolicyLabels added in v1.5.0 

func AIGatewayPolicyLabels(policy any) map[string]string

func AIGatewayPolicyMutablePayloadMap added in v1.5.0 

func AIGatewayPolicyMutablePayloadMap(policy kkComps.AIGatewayPolicy) (map[string]any, error)

func AIGatewayPolicyName added in v1.5.0 

func AIGatewayPolicyName(policy any) string

func AIGatewayPolicyType added in v1.5.0 

func AIGatewayPolicyType(policy any) string

func AIGatewayPolicyUpdatedAt added in v1.5.0 

func AIGatewayPolicyUpdatedAt(policy any) time.Time

func AIGatewayVaultDescription added in v1.5.0 

func AIGatewayVaultDescription(vault any) string

func AIGatewayVaultID added in v1.5.0 

func AIGatewayVaultID(vault any) string

func AIGatewayVaultLabels added in v1.5.0 

func AIGatewayVaultLabels(vault any) map[string]string

func AIGatewayVaultMutablePayloadMap added in v1.5.0 

func AIGatewayVaultMutablePayloadMap(vault kkComps.AIGatewayVault) (map[string]any, error)

func AIGatewayVaultName added in v1.5.0 

func AIGatewayVaultName(vault any) string

func AIGatewayVaultType added in v1.5.0 

func AIGatewayVaultType(vault any) string

func AIGatewayVaultUpdatedAt added in v1.5.0 

func AIGatewayVaultUpdatedAt(vault any) time.Time

func ControlPlaneDataPlaneCertificateIdentity added in v0.10.0 

func ControlPlaneDataPlaneCertificateIdentity(cert string) string

ControlPlaneDataPlaneCertificateIdentity returns the stable identity for a certificate. The exact certificate contents are the remote identity; hashing keeps map keys and plan labels compact without changing matching semantics.

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 MaturityFor added in v1.5.0 

func MaturityFor(resourceType ResourceType, operations ...Operation) (capmaturity.Resolution, error)

MaturityFor resolves a resource's default maturity or one operation's maturity. With no operation it resolves the resource. Exactly one operation may be supplied.

func NormalizeDCRProviderIssuer added in v0.8.0 

func NormalizeDCRProviderIssuer(issuer string) string

func NormalizeResourceRef added in v1.5.0 

func NormalizeResourceRef(value string) string

NormalizeResourceRef returns the declarative ref for either a plain ref or a deferred !ref placeholder.

func RenderExplainText added in v0.8.0 

func RenderExplainText(subject *ExplainSubject, extended bool) string

func RenderScaffoldYAML added in v0.8.0 

func RenderScaffoldYAML(subject *ExplainSubject) (string, error)

func ShortControlPlaneDataPlaneCertificateIdentity added in v0.10.0 

func ShortControlPlaneDataPlaneCertificateIdentity(cert string) string

func StripAIGatewayConsumerGroupMembershipFields added in v1.5.0 

func StripAIGatewayConsumerGroupMembershipFields(payload map[string]any)

func ValidateRef 

func ValidateRef(ref string) error

ValidateRef validates that a resource ref follows naming conventions

Types

type AIGatewayAgentResource added in v1.5.0 

type AIGatewayAgentResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	kkComps.CreateAIGatewayAgentRequest `yaml:",inline" json:",inline"`
}

AIGatewayAgentResource represents an Agent nested under a Konnect AI Gateway.

func AIGatewayAgentResourceFromResponse added in v1.5.0 

func AIGatewayAgentResourceFromResponse(
	gatewayRef string,
	agent kkComps.AIGatewayAgent,
) (AIGatewayAgentResource, error)

func (AIGatewayAgentResource) CreateRequest added in v1.5.0 

func (a AIGatewayAgentResource) CreateRequest() kkComps.CreateAIGatewayAgentRequest

func (AIGatewayAgentResource) GetDependencies added in v1.5.0 

func (a AIGatewayAgentResource) GetDependencies() []ResourceRef

func (AIGatewayAgentResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayAgentResource) GetKonnectMonikerFilter() string

func (AIGatewayAgentResource) GetMoniker added in v1.5.0 

func (a AIGatewayAgentResource) GetMoniker() string

func (AIGatewayAgentResource) GetParentRef added in v1.5.0 

func (a AIGatewayAgentResource) GetParentRef() *ResourceRef

func (AIGatewayAgentResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayAgentResource) GetType added in v1.5.0 

func (a AIGatewayAgentResource) GetType() ResourceType

func (AIGatewayAgentResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayAgentResource) MarshalYAML added in v1.5.0 

func (a AIGatewayAgentResource) MarshalYAML() (any, error)

func (AIGatewayAgentResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayAgentResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayAgentResource) PayloadMap added in v1.5.0 

func (a AIGatewayAgentResource) PayloadMap() (map[string]any, error)

func (*AIGatewayAgentResource) SetDefaults added in v1.5.0 

func (a *AIGatewayAgentResource) SetDefaults()

func (*AIGatewayAgentResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayAgentResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayAgentResource) UpdateRequest added in v1.5.0 

func (a AIGatewayAgentResource) UpdateRequest() kkComps.UpdateAIGatewayAgentRequest

func (AIGatewayAgentResource) Validate added in v1.5.0 

func (a AIGatewayAgentResource) Validate() error

type AIGatewayConsumerCredentialResource added in v1.5.0 

type AIGatewayConsumerCredentialResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway Consumer reference for root-level declarations.
	AIGatewayConsumer string `yaml:"ai_gateway_consumer,omitempty" json:"ai_gateway_consumer,omitempty"`

	kkComps.CreateAIGatewayConsumerCredentialRequest `yaml:",inline" json:",inline"`
}

AIGatewayConsumerCredentialResource represents a Credential nested under a Konnect AI Gateway Consumer.

func AIGatewayConsumerCredentialResourceFromResponse added in v1.5.0 

func AIGatewayConsumerCredentialResourceFromResponse(
	consumerRef string,
	credential kkComps.AIGatewayConsumerCredential,
) (AIGatewayConsumerCredentialResource, error)

func (AIGatewayConsumerCredentialResource) CreateRequest added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) CreateRequest() kkComps.CreateAIGatewayConsumerCredentialRequest

func (AIGatewayConsumerCredentialResource) GetDependencies added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) GetDependencies() []ResourceRef

func (AIGatewayConsumerCredentialResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) GetKonnectMonikerFilter() string

func (AIGatewayConsumerCredentialResource) GetMoniker added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) GetMoniker() string

func (AIGatewayConsumerCredentialResource) GetParentRef added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) GetParentRef() *ResourceRef

func (AIGatewayConsumerCredentialResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayConsumerCredentialResource) GetType added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) GetType() ResourceType

func (AIGatewayConsumerCredentialResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayConsumerCredentialResource) MarshalYAML added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) MarshalYAML() (any, error)

func (AIGatewayConsumerCredentialResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayConsumerCredentialResource) PayloadMap added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) PayloadMap() (map[string]any, error)

func (*AIGatewayConsumerCredentialResource) SetDefaults added in v1.5.0 

func (a *AIGatewayConsumerCredentialResource) SetDefaults()

func (*AIGatewayConsumerCredentialResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayConsumerCredentialResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayConsumerCredentialResource) Validate added in v1.5.0 

func (a AIGatewayConsumerCredentialResource) Validate() error

type AIGatewayConsumerGroupResource added in v1.5.0 

type AIGatewayConsumerGroupResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	kkComps.CreateAIGatewayConsumerGroupRequest `yaml:",inline" json:",inline"`
}

AIGatewayConsumerGroupResource represents a Consumer Group nested under a Konnect AI Gateway.

func AIGatewayConsumerGroupResourceFromResponse added in v1.5.0 

func AIGatewayConsumerGroupResourceFromResponse(
	gatewayRef string,
	group kkComps.AIGatewayConsumerGroup,
) (AIGatewayConsumerGroupResource, error)

func (AIGatewayConsumerGroupResource) ConsumerNames added in v1.5.0 

func (a AIGatewayConsumerGroupResource) ConsumerNames() ([]string, bool, error)

func (AIGatewayConsumerGroupResource) CreateRequest added in v1.5.0 

func (a AIGatewayConsumerGroupResource) CreateRequest() kkComps.CreateAIGatewayConsumerGroupRequest

func (AIGatewayConsumerGroupResource) GetDependencies added in v1.5.0 

func (a AIGatewayConsumerGroupResource) GetDependencies() []ResourceRef

func (AIGatewayConsumerGroupResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayConsumerGroupResource) GetKonnectMonikerFilter() string

func (AIGatewayConsumerGroupResource) GetMoniker added in v1.5.0 

func (a AIGatewayConsumerGroupResource) GetMoniker() string

func (AIGatewayConsumerGroupResource) GetParentRef added in v1.5.0 

func (a AIGatewayConsumerGroupResource) GetParentRef() *ResourceRef

func (AIGatewayConsumerGroupResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayConsumerGroupResource) GetType added in v1.5.0 

func (a AIGatewayConsumerGroupResource) GetType() ResourceType

func (AIGatewayConsumerGroupResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayConsumerGroupResource) MarshalYAML added in v1.5.0 

func (a AIGatewayConsumerGroupResource) MarshalYAML() (any, error)

func (AIGatewayConsumerGroupResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayConsumerGroupResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayConsumerGroupResource) PayloadMap added in v1.5.0 

func (a AIGatewayConsumerGroupResource) PayloadMap() (map[string]any, error)

func (*AIGatewayConsumerGroupResource) SetDefaults added in v1.5.0 

func (a *AIGatewayConsumerGroupResource) SetDefaults()

func (*AIGatewayConsumerGroupResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayConsumerGroupResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayConsumerGroupResource) UpdateRequest added in v1.5.0 

func (a AIGatewayConsumerGroupResource) UpdateRequest() kkComps.UpdateAIGatewayConsumerGroupRequest

func (AIGatewayConsumerGroupResource) Validate added in v1.5.0 

func (a AIGatewayConsumerGroupResource) Validate() error

type AIGatewayConsumerResource added in v1.5.0 

type AIGatewayConsumerResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	Credentials []AIGatewayConsumerCredentialResource `yaml:"credentials,omitempty" json:"credentials,omitempty"`

	kkComps.CreateAIGatewayConsumerRequest `yaml:",inline" json:",inline"`
}

AIGatewayConsumerResource represents a Consumer nested under a Konnect AI Gateway.

func AIGatewayConsumerResourceFromResponse added in v1.5.0 

func AIGatewayConsumerResourceFromResponse(
	gatewayRef string,
	consumer kkComps.AIGatewayConsumer,
) (AIGatewayConsumerResource, error)

func (AIGatewayConsumerResource) CreateRequest added in v1.5.0 

func (a AIGatewayConsumerResource) CreateRequest() kkComps.CreateAIGatewayConsumerRequest

func (AIGatewayConsumerResource) GetDependencies added in v1.5.0 

func (a AIGatewayConsumerResource) GetDependencies() []ResourceRef

func (AIGatewayConsumerResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayConsumerResource) GetKonnectMonikerFilter() string

func (AIGatewayConsumerResource) GetMoniker added in v1.5.0 

func (a AIGatewayConsumerResource) GetMoniker() string

func (AIGatewayConsumerResource) GetParentRef added in v1.5.0 

func (a AIGatewayConsumerResource) GetParentRef() *ResourceRef

func (AIGatewayConsumerResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayConsumerResource) GetType added in v1.5.0 

func (a AIGatewayConsumerResource) GetType() ResourceType

func (AIGatewayConsumerResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayConsumerResource) MarshalYAML added in v1.5.0 

func (a AIGatewayConsumerResource) MarshalYAML() (any, error)

func (AIGatewayConsumerResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayConsumerResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayConsumerResource) PayloadMap added in v1.5.0 

func (a AIGatewayConsumerResource) PayloadMap() (map[string]any, error)

func (*AIGatewayConsumerResource) SetDefaults added in v1.5.0 

func (a *AIGatewayConsumerResource) SetDefaults()

func (*AIGatewayConsumerResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayConsumerResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayConsumerResource) UpdateRequest added in v1.5.0 

func (a AIGatewayConsumerResource) UpdateRequest() kkComps.UpdateAIGatewayConsumerRequest

func (AIGatewayConsumerResource) Validate added in v1.5.0 

func (a AIGatewayConsumerResource) Validate() error

type AIGatewayDataPlaneCertificateResource added in v1.5.0 

type AIGatewayDataPlaneCertificateResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	kkComps.CreateAIGatewayDataPlaneCertificateRequest `yaml:",inline" json:",inline"`
}

AIGatewayDataPlaneCertificateResource represents a data plane certificate nested under a Konnect AI Gateway.

func AIGatewayDataPlaneCertificateResourceFromResponse added in v1.5.0 

func AIGatewayDataPlaneCertificateResourceFromResponse(
	gatewayRef string,
	cert kkComps.AIGatewayDataPlaneClientCertificate,
) AIGatewayDataPlaneCertificateResource

func (AIGatewayDataPlaneCertificateResource) CreateRequest added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) CreateRequest() kkComps.CreateAIGatewayDataPlaneCertificateRequest

func (AIGatewayDataPlaneCertificateResource) GetDependencies added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) GetDependencies() []ResourceRef

func (AIGatewayDataPlaneCertificateResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) GetKonnectMonikerFilter() string

func (AIGatewayDataPlaneCertificateResource) GetMoniker added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) GetMoniker() string

func (AIGatewayDataPlaneCertificateResource) GetParentRef added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) GetParentRef() *ResourceRef

func (AIGatewayDataPlaneCertificateResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayDataPlaneCertificateResource) GetType added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) GetType() ResourceType

func (AIGatewayDataPlaneCertificateResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayDataPlaneCertificateResource) MarshalYAML added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) MarshalYAML() (any, error)

func (AIGatewayDataPlaneCertificateResource) PayloadMap added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) PayloadMap() map[string]any

func (*AIGatewayDataPlaneCertificateResource) SetDefaults added in v1.5.0 

func (a *AIGatewayDataPlaneCertificateResource) SetDefaults()

func (*AIGatewayDataPlaneCertificateResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayDataPlaneCertificateResource) UnmarshalJSON added in v1.5.0 

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

func (*AIGatewayDataPlaneCertificateResource) UnmarshalYAML added in v1.5.0 

func (a *AIGatewayDataPlaneCertificateResource) UnmarshalYAML(unmarshal func(any) error) error

func (AIGatewayDataPlaneCertificateResource) Validate added in v1.5.0 

func (a AIGatewayDataPlaneCertificateResource) Validate() error

type AIGatewayIdentityProviderResource added in v1.5.0 

type AIGatewayIdentityProviderResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level identity provider declarations.
	AIGateway   string            `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`
	Name        string            `yaml:"name"                 json:"name"`
	Type        string            `yaml:"type"                 json:"type"`
	DisplayName string            `yaml:"display_name"         json:"display_name"`
	Labels      map[string]string `yaml:"labels,omitempty"     json:"labels,omitempty"`
	ManagedBy   map[string]string `yaml:"managed_by,omitempty" json:"managed_by,omitempty"`
	Config      map[string]any    `yaml:"config"               json:"config"`
}

AIGatewayIdentityProviderResource represents a Konnect AI Gateway Identity Provider in declarative configuration.

func (AIGatewayIdentityProviderResource) GetDependencies added in v1.5.0 

func (a AIGatewayIdentityProviderResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this provider depends on.

func (AIGatewayIdentityProviderResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayIdentityProviderResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup.

func (AIGatewayIdentityProviderResource) GetMoniker added in v1.5.0 

func (a AIGatewayIdentityProviderResource) GetMoniker() string

GetMoniker returns the provider name used for matching within the parent gateway.

func (AIGatewayIdentityProviderResource) GetParentRef added in v1.5.0 

func (a AIGatewayIdentityProviderResource) GetParentRef() *ResourceRef

GetParentRef returns the parent AI Gateway reference.

func (AIGatewayIdentityProviderResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayIdentityProviderResource) GetType added in v1.5.0 

func (a AIGatewayIdentityProviderResource) GetType() ResourceType

GetType returns the resource type.

func (AIGatewayIdentityProviderResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayIdentityProviderResource) MarshalYAML added in v1.5.0 

func (a AIGatewayIdentityProviderResource) MarshalYAML() (any, error)

func (AIGatewayIdentityProviderResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayIdentityProviderResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayIdentityProviderResource) PayloadMap added in v1.5.0 

func (a AIGatewayIdentityProviderResource) PayloadMap() (map[string]any, error)

func (*AIGatewayIdentityProviderResource) SetDefaults added in v1.5.0 

func (a *AIGatewayIdentityProviderResource) SetDefaults()

SetDefaults applies default values to AI Gateway Identity Provider resources.

func (*AIGatewayIdentityProviderResource) TryMatchKonnectResource added in v1.5.0 

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

TryMatchKonnectResource attempts to match this provider with a Konnect resource.

func (*AIGatewayIdentityProviderResource) UnmarshalJSON added in v1.5.0 

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

UnmarshalJSON rejects kongctl metadata on child provider resources.

func (AIGatewayIdentityProviderResource) Validate added in v1.5.0 

func (a AIGatewayIdentityProviderResource) Validate() error

Validate ensures the AI Gateway Identity Provider resource is valid.

type AIGatewayMCPServerResource added in v1.5.0 

type AIGatewayMCPServerResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	kkComps.CreateAIGatewayMCPServerRequest `yaml:",inline" json:",inline"`
}

AIGatewayMCPServerResource represents an MCP Server nested under a Konnect AI Gateway.

func AIGatewayMCPServerResourceFromResponse added in v1.5.0 

func AIGatewayMCPServerResourceFromResponse(
	gatewayRef string,
	server kkComps.AIGatewayMCPServer,
) (AIGatewayMCPServerResource, error)

func (AIGatewayMCPServerResource) CreateRequest added in v1.5.0 

func (a AIGatewayMCPServerResource) CreateRequest() kkComps.CreateAIGatewayMCPServerRequest

func (AIGatewayMCPServerResource) DisplayName added in v1.5.0 

func (a AIGatewayMCPServerResource) DisplayName() string

func (AIGatewayMCPServerResource) GetDependencies added in v1.5.0 

func (a AIGatewayMCPServerResource) GetDependencies() []ResourceRef

func (AIGatewayMCPServerResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayMCPServerResource) GetKonnectMonikerFilter() string

func (AIGatewayMCPServerResource) GetMoniker added in v1.5.0 

func (a AIGatewayMCPServerResource) GetMoniker() string

func (AIGatewayMCPServerResource) GetParentRef added in v1.5.0 

func (a AIGatewayMCPServerResource) GetParentRef() *ResourceRef

func (AIGatewayMCPServerResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayMCPServerResource) GetType added in v1.5.0 

func (a AIGatewayMCPServerResource) GetType() ResourceType

func (AIGatewayMCPServerResource) MCPServerType added in v1.5.0 

func (a AIGatewayMCPServerResource) MCPServerType() string

func (AIGatewayMCPServerResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayMCPServerResource) MarshalYAML added in v1.5.0 

func (a AIGatewayMCPServerResource) MarshalYAML() (any, error)

func (AIGatewayMCPServerResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayMCPServerResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayMCPServerResource) Name added in v1.5.0 

func (a AIGatewayMCPServerResource) Name() string

func (AIGatewayMCPServerResource) PayloadMap added in v1.5.0 

func (a AIGatewayMCPServerResource) PayloadMap() (map[string]any, error)

func (*AIGatewayMCPServerResource) SetDefaults added in v1.5.0 

func (a *AIGatewayMCPServerResource) SetDefaults()

func (*AIGatewayMCPServerResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayMCPServerResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayMCPServerResource) UpdateRequest added in v1.5.0 

func (a AIGatewayMCPServerResource) UpdateRequest() kkComps.UpdateAIGatewayMCPServerRequest

func (AIGatewayMCPServerResource) Validate added in v1.5.0 

func (a AIGatewayMCPServerResource) Validate() error

type AIGatewayModelResource added in v1.5.0 

type AIGatewayModelResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	kkComps.CreateAIGatewayModelRequest `yaml:",inline" json:",inline"`
}

AIGatewayModelResource represents a model nested under a Konnect AI Gateway.

func AIGatewayModelResourceFromResponse added in v1.5.0 

func AIGatewayModelResourceFromResponse(
	gatewayRef string,
	model kkComps.AIGatewayModel,
) (AIGatewayModelResource, error)

func (AIGatewayModelResource) CreateRequest added in v1.5.0 

func (a AIGatewayModelResource) CreateRequest() kkComps.CreateAIGatewayModelRequest

func (AIGatewayModelResource) DisplayName added in v1.5.0 

func (a AIGatewayModelResource) DisplayName() string

func (AIGatewayModelResource) GetDependencies added in v1.5.0 

func (a AIGatewayModelResource) GetDependencies() []ResourceRef

func (AIGatewayModelResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayModelResource) GetKonnectMonikerFilter() string

func (AIGatewayModelResource) GetMoniker added in v1.5.0 

func (a AIGatewayModelResource) GetMoniker() string

func (AIGatewayModelResource) GetParentRef added in v1.5.0 

func (a AIGatewayModelResource) GetParentRef() *ResourceRef

func (AIGatewayModelResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayModelResource) GetType added in v1.5.0 

func (a AIGatewayModelResource) GetType() ResourceType

func (AIGatewayModelResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayModelResource) MarshalYAML added in v1.5.0 

func (a AIGatewayModelResource) MarshalYAML() (any, error)

func (AIGatewayModelResource) ModelType added in v1.5.0 

func (a AIGatewayModelResource) ModelType() string

func (AIGatewayModelResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayModelResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayModelResource) Name added in v1.5.0 

func (a AIGatewayModelResource) Name() string

func (AIGatewayModelResource) PayloadMap added in v1.5.0 

func (a AIGatewayModelResource) PayloadMap() (map[string]any, error)

func (*AIGatewayModelResource) SetDefaults added in v1.5.0 

func (a *AIGatewayModelResource) SetDefaults()

func (*AIGatewayModelResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayModelResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayModelResource) UpdateRequest added in v1.5.0 

func (a AIGatewayModelResource) UpdateRequest() kkComps.UpdateAIGatewayModelRequest

func (AIGatewayModelResource) Validate added in v1.5.0 

func (a AIGatewayModelResource) Validate() error

type AIGatewayPolicyResource added in v1.5.0 

type AIGatewayPolicyResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	kkComps.CreateAIGatewayPolicyRequest `yaml:",inline" json:",inline"`
}

AIGatewayPolicyResource represents a Policy nested under a Konnect AI Gateway.

func AIGatewayPolicyResourceFromResponse added in v1.5.0 

func AIGatewayPolicyResourceFromResponse(
	gatewayRef string,
	policy kkComps.AIGatewayPolicy,
) (AIGatewayPolicyResource, error)

func (AIGatewayPolicyResource) CreateRequest added in v1.5.0 

func (a AIGatewayPolicyResource) CreateRequest() kkComps.CreateAIGatewayPolicyRequest

func (AIGatewayPolicyResource) GetDependencies added in v1.5.0 

func (a AIGatewayPolicyResource) GetDependencies() []ResourceRef

func (AIGatewayPolicyResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayPolicyResource) GetKonnectMonikerFilter() string

func (AIGatewayPolicyResource) GetMoniker added in v1.5.0 

func (a AIGatewayPolicyResource) GetMoniker() string

func (AIGatewayPolicyResource) GetParentRef added in v1.5.0 

func (a AIGatewayPolicyResource) GetParentRef() *ResourceRef

func (AIGatewayPolicyResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayPolicyResource) GetType added in v1.5.0 

func (a AIGatewayPolicyResource) GetType() ResourceType

func (AIGatewayPolicyResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayPolicyResource) MarshalYAML added in v1.5.0 

func (a AIGatewayPolicyResource) MarshalYAML() (any, error)

func (AIGatewayPolicyResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayPolicyResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayPolicyResource) PayloadMap added in v1.5.0 

func (a AIGatewayPolicyResource) PayloadMap() (map[string]any, error)

func (*AIGatewayPolicyResource) SetDefaults added in v1.5.0 

func (a *AIGatewayPolicyResource) SetDefaults()

func (*AIGatewayPolicyResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayPolicyResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayPolicyResource) UpdateRequest added in v1.5.0 

func (a AIGatewayPolicyResource) UpdateRequest() kkComps.UpdateAIGatewayPolicyRequest

func (AIGatewayPolicyResource) Validate added in v1.5.0 

func (a AIGatewayPolicyResource) Validate() error

type AIGatewayProviderResource added in v1.5.0 

type AIGatewayProviderResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level model provider declarations.
	AIGateway   string            `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`
	Name        string            `yaml:"name"                 json:"name"`
	Type        string            `yaml:"type"                 json:"type"`
	DisplayName string            `yaml:"display_name"         json:"display_name"`
	Labels      map[string]string `yaml:"labels,omitempty"     json:"labels,omitempty"`
	ManagedBy   map[string]string `yaml:"managed_by,omitempty" json:"managed_by,omitempty"`
	Config      map[string]any    `yaml:"config"               json:"config"`
}

AIGatewayProviderResource represents a Konnect AI Gateway Model Provider in declarative configuration.

func (AIGatewayProviderResource) GetDependencies added in v1.5.0 

func (a AIGatewayProviderResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this provider depends on.

func (AIGatewayProviderResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayProviderResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup.

func (AIGatewayProviderResource) GetMoniker added in v1.5.0 

func (a AIGatewayProviderResource) GetMoniker() string

GetMoniker returns the provider name used for matching within the parent gateway.

func (AIGatewayProviderResource) GetParentRef added in v1.5.0 

func (a AIGatewayProviderResource) GetParentRef() *ResourceRef

GetParentRef returns the parent AI Gateway reference.

func (AIGatewayProviderResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayProviderResource) GetType added in v1.5.0 

func (a AIGatewayProviderResource) GetType() ResourceType

GetType returns the resource type.

func (AIGatewayProviderResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayProviderResource) MarshalYAML added in v1.5.0 

func (a AIGatewayProviderResource) MarshalYAML() (any, error)

func (AIGatewayProviderResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayProviderResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayProviderResource) PayloadMap added in v1.5.0 

func (a AIGatewayProviderResource) PayloadMap() (map[string]any, error)

func (*AIGatewayProviderResource) SetDefaults added in v1.5.0 

func (a *AIGatewayProviderResource) SetDefaults()

SetDefaults applies default values to AI Gateway Model Provider resources.

func (*AIGatewayProviderResource) TryMatchKonnectResource added in v1.5.0 

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

TryMatchKonnectResource attempts to match this provider with a Konnect resource.

func (*AIGatewayProviderResource) UnmarshalJSON added in v1.5.0 

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

UnmarshalJSON rejects kongctl metadata on child provider resources.

func (AIGatewayProviderResource) Validate added in v1.5.0 

func (a AIGatewayProviderResource) Validate() error

Validate ensures the AI Gateway Model Provider resource is valid.

type AIGatewayResource added in v1.5.0 

type AIGatewayResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	kkComps.CreateAIGatewayRequest
	External              *ExternalBlock                          `yaml:"_external,omitempty" json:"_external,omitempty"`
	Providers             []AIGatewayProviderResource             `yaml:"model_providers,omitempty" json:"model_providers,omitempty"`       //nolint:lll
	IdentityProviders     []AIGatewayIdentityProviderResource     `yaml:"identity_providers,omitempty" json:"identity_providers,omitempty"` //nolint:lll
	Policies              []AIGatewayPolicyResource               `yaml:"policies,omitempty" json:"policies,omitempty"`
	Agents                []AIGatewayAgentResource                `yaml:"agents,omitempty" json:"agents,omitempty"`
	Consumers             []AIGatewayConsumerResource             `yaml:"consumers,omitempty" json:"consumers,omitempty"`
	ConsumerGroups        []AIGatewayConsumerGroupResource        `yaml:"consumer_groups,omitempty" json:"consumer_groups,omitempty"` //nolint:lll
	Models                []AIGatewayModelResource                `yaml:"models,omitempty"    json:"models,omitempty"`
	MCPServers            []AIGatewayMCPServerResource            `yaml:"mcp_servers,omitempty" json:"mcp_servers,omitempty"` //nolint:lll
	Vaults                []AIGatewayVaultResource                `yaml:"vaults,omitempty" json:"vaults,omitempty"`
	DataPlaneCertificates []AIGatewayDataPlaneCertificateResource `yaml:"data_plane_certificates,omitempty" json:"data_plane_certificates,omitempty"` //nolint:lll
}

AIGatewayResource represents a Konnect AI Gateway in declarative configuration.

func (AIGatewayResource) GetDependencies added in v1.5.0 

func (a AIGatewayResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this gateway depends on.

func (AIGatewayResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup.

func (AIGatewayResource) GetLabels added in v1.5.0 

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

GetLabels returns the labels for this resource.

func (AIGatewayResource) GetMoniker added in v1.5.0 

func (a AIGatewayResource) GetMoniker() string

GetMoniker returns the resource moniker.

func (AIGatewayResource) GetType added in v1.5.0 

func (a AIGatewayResource) GetType() ResourceType

GetType returns the resource type.

func (AIGatewayResource) IsExternal added in v1.5.0 

func (a AIGatewayResource) IsExternal() bool

IsExternal returns true if this AI Gateway is externally managed.

func (AIGatewayResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayResource) MarshalYAML added in v1.5.0 

func (a AIGatewayResource) MarshalYAML() (any, error)

MarshalYAML ensures YAML output mirrors the custom JSON encoding.

func (*AIGatewayResource) SetDefaults added in v1.5.0 

func (a *AIGatewayResource) SetDefaults()

SetDefaults applies default values to AI Gateway resource.

func (*AIGatewayResource) SetLabels added in v1.5.0 

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

SetLabels sets the labels for this resource.

func (*AIGatewayResource) TryMatchKonnectResource added in v1.5.0 

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

TryMatchKonnectResource attempts to match this resource with a Konnect resource.

func (*AIGatewayResource) UnmarshalJSON added in v1.5.0 

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

UnmarshalJSON decodes AI Gateways explicitly because YAML loading goes through JSON tags and the embedded SDK request type has a custom unmarshaler.

func (*AIGatewayResource) UnmarshalYAML added in v1.5.0 

func (a *AIGatewayResource) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML decodes AI Gateway fields explicitly because the SDK request type only carries JSON tags.

func (AIGatewayResource) Validate added in v1.5.0 

func (a AIGatewayResource) Validate() error

Validate ensures the AI Gateway resource is valid.

type AIGatewayVaultResource added in v1.5.0 

type AIGatewayVaultResource struct {
	BaseResource `yaml:",inline" json:",inline"`
	// Parent AI Gateway reference for root-level declarations.
	AIGateway string `yaml:"ai_gateway,omitempty" json:"ai_gateway,omitempty"`

	kkComps.CreateAIGatewayVaultRequest `yaml:",inline" json:",inline"`
}

AIGatewayVaultResource represents a Vault nested under a Konnect AI Gateway.

func AIGatewayVaultResourceFromResponse added in v1.5.0 

func AIGatewayVaultResourceFromResponse(
	gatewayRef string,
	vault kkComps.AIGatewayVault,
) (AIGatewayVaultResource, error)

func (AIGatewayVaultResource) CreateRequest added in v1.5.0 

func (a AIGatewayVaultResource) CreateRequest() kkComps.CreateAIGatewayVaultRequest

func (AIGatewayVaultResource) GetDependencies added in v1.5.0 

func (a AIGatewayVaultResource) GetDependencies() []ResourceRef

func (AIGatewayVaultResource) GetKonnectMonikerFilter added in v1.5.0 

func (a AIGatewayVaultResource) GetKonnectMonikerFilter() string

func (AIGatewayVaultResource) GetMoniker added in v1.5.0 

func (a AIGatewayVaultResource) GetMoniker() string

func (AIGatewayVaultResource) GetParentRef added in v1.5.0 

func (a AIGatewayVaultResource) GetParentRef() *ResourceRef

func (AIGatewayVaultResource) GetReferenceFieldMappings added in v1.5.0 

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

func (AIGatewayVaultResource) GetType added in v1.5.0 

func (a AIGatewayVaultResource) GetType() ResourceType

func (AIGatewayVaultResource) MarshalJSON added in v1.5.0 

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

func (AIGatewayVaultResource) MarshalYAML added in v1.5.0 

func (a AIGatewayVaultResource) MarshalYAML() (any, error)

func (AIGatewayVaultResource) MutablePayloadMap added in v1.5.0 

func (a AIGatewayVaultResource) MutablePayloadMap() (map[string]any, error)

func (AIGatewayVaultResource) Name added in v1.5.0 

func (a AIGatewayVaultResource) Name() string

func (AIGatewayVaultResource) PayloadMap added in v1.5.0 

func (a AIGatewayVaultResource) PayloadMap() (map[string]any, error)

func (*AIGatewayVaultResource) SetDefaults added in v1.5.0 

func (a *AIGatewayVaultResource) SetDefaults()

func (*AIGatewayVaultResource) TryMatchKonnectResource added in v1.5.0 

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

func (*AIGatewayVaultResource) UnmarshalJSON added in v1.5.0 

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

func (AIGatewayVaultResource) UpdateRequest added in v1.5.0 

func (a AIGatewayVaultResource) UpdateRequest() kkComps.UpdateAIGatewayVaultRequest

func (AIGatewayVaultResource) Validate added in v1.5.0 

func (a AIGatewayVaultResource) Validate() error

func (AIGatewayVaultResource) VaultType added in v1.5.0 

func (a AIGatewayVaultResource) VaultType() string

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) UnmarshalJSON added in v1.0.0 

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

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 AnalyticsResource added in v1.0.0 

type AnalyticsResource struct {
	// Dashboards nested under analytics
	Dashboards []DashboardResource `yaml:"dashboards,omitempty" json:"dashboards,omitempty"`
}

AnalyticsResource represents the analytics grouping in declarative configuration. It's a grouping concept that can contain nested analytics resources.

type ApplicationAuthStrategyResource 

type ApplicationAuthStrategyResource struct {
	BaseResource
	DCRProviderID                        *string `yaml:"dcr_provider_id,omitempty" json:"dcr_provider_id,omitempty"`
	kkComps.CreateAppAuthStrategyRequest `yaml:",inline" json:",inline"`
}

ApplicationAuthStrategyResource represents an application auth strategy in declarative configuration

func (ApplicationAuthStrategyResource) GetDCRProviderID added in v0.8.0 

func (a ApplicationAuthStrategyResource) GetDCRProviderID() string

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 AuditLogWebhookDestinationResource added in v0.10.0 

type AuditLogWebhookDestinationResource struct {
	BaseResource
	External *ExternalBlock `yaml:"_external,omitempty" json:"_external,omitempty"`
}

AuditLogWebhookDestinationResource references an externally managed Konnect audit-log webhook destination.

func (AuditLogWebhookDestinationResource) GetDependencies added in v0.10.0 

func (d AuditLogWebhookDestinationResource) GetDependencies() []ResourceRef

func (AuditLogWebhookDestinationResource) GetKonnectMonikerFilter added in v0.10.0 

func (d AuditLogWebhookDestinationResource) GetKonnectMonikerFilter() string

func (AuditLogWebhookDestinationResource) GetMoniker added in v0.10.0 

func (d AuditLogWebhookDestinationResource) GetMoniker() string

func (AuditLogWebhookDestinationResource) GetType added in v0.10.0 

func (d AuditLogWebhookDestinationResource) GetType() ResourceType

func (*AuditLogWebhookDestinationResource) IsExternal added in v0.10.0 

func (d *AuditLogWebhookDestinationResource) IsExternal() bool

func (*AuditLogWebhookDestinationResource) SetDefaults added in v0.10.0 

func (d *AuditLogWebhookDestinationResource) SetDefaults()

func (*AuditLogWebhookDestinationResource) TryMatchKonnectResource added in v0.10.0 

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

func (AuditLogWebhookDestinationResource) Validate added in v0.10.0 

func (d AuditLogWebhookDestinationResource) Validate() error

type AuditLogsResource added in v0.10.0 

type AuditLogsResource struct {
	Destinations []AuditLogWebhookDestinationResource `yaml:"destinations,omitempty" json:"destinations,omitempty"`
}

AuditLogsResource groups organization-scoped audit-log declarative resources.

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                 `yaml:",inline" json:",inline"`
	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) UnmarshalJSON added in v1.4.0 

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

UnmarshalJSON decodes catalog services explicitly because YAML loading goes through JSON tags and the embedded SDK request type has a custom unmarshaler.

func (*CatalogServiceResource) UnmarshalYAML added in v1.4.0 

func (c *CatalogServiceResource) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML decodes catalog service fields explicitly because the SDK request type only carries JSON tags.

func (CatalogServiceResource) Validate added in v0.3.6 

func (c CatalogServiceResource) Validate() error

Validate ensures the CatalogService resource is valid

type ChildSyncScope added in v1.0.0 

type ChildSyncScope struct {
	ParentType   ResourceType
	ParentRef    string
	ResourceType ResourceType
}

ChildSyncScope identifies a child collection scoped under a specific parent.

type ControlPlaneDataPlaneCertificateResource added in v0.10.0 

type ControlPlaneDataPlaneCertificateResource struct {
	Ref          string `yaml:"ref"                     json:"ref"`
	ControlPlane string `yaml:"control_plane,omitempty" json:"control_plane,omitempty"`
	Cert         string `yaml:"cert"                    json:"cert"`
	// contains filtered or unexported fields
}

ControlPlaneDataPlaneCertificateResource represents a data plane certificate pinned to an API Gateway control plane.

func (ControlPlaneDataPlaneCertificateResource) GetDependencies added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) GetDependencies() []ResourceRef

func (ControlPlaneDataPlaneCertificateResource) GetKonnectID added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) GetKonnectID() string

func (ControlPlaneDataPlaneCertificateResource) GetKonnectMonikerFilter added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) GetKonnectMonikerFilter() string

func (ControlPlaneDataPlaneCertificateResource) GetMoniker added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) GetMoniker() string

func (ControlPlaneDataPlaneCertificateResource) GetParentRef added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) GetParentRef() *ResourceRef

func (ControlPlaneDataPlaneCertificateResource) GetRef added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) GetRef() string

func (ControlPlaneDataPlaneCertificateResource) GetReferenceFieldMappings added in v0.10.0 

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

func (ControlPlaneDataPlaneCertificateResource) GetType added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) GetType() ResourceType

func (*ControlPlaneDataPlaneCertificateResource) SetDefaults added in v0.10.0 

func (c *ControlPlaneDataPlaneCertificateResource) SetDefaults()

func (*ControlPlaneDataPlaneCertificateResource) TryMatchKonnectResource added in v0.10.0 

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

func (ControlPlaneDataPlaneCertificateResource) Validate added in v0.10.0 

func (c ControlPlaneDataPlaneCertificateResource) Validate() error

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"`                   //nolint:lll
	GatewayServices                   []GatewayServiceResource                   `yaml:"gateway_services,omitempty"        json:"gateway_services,omitempty"`        //nolint:lll
	DataPlaneCertificates             []ControlPlaneDataPlaneCertificateResource `yaml:"data_plane_certificates,omitempty" json:"data_plane_certificates,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 DCRProviderResource added in v0.8.0 

type DCRProviderResource struct {
	BaseResource
	Name         string            `yaml:"name,omitempty"          json:"name,omitempty"`
	DisplayName  string            `yaml:"display_name,omitempty"  json:"display_name,omitempty"`
	ProviderType string            `yaml:"provider_type,omitempty" json:"provider_type,omitempty"`
	Issuer       string            `yaml:"issuer,omitempty"        json:"issuer,omitempty"`
	DCRConfig    map[string]any    `yaml:"dcr_config,omitempty"    json:"dcr_config,omitempty"`
	Labels       map[string]string `yaml:"labels,omitempty"        json:"labels,omitempty"`
}

DCRProviderResource represents a DCR provider in declarative configuration.

func (DCRProviderResource) GetDependencies added in v0.8.0 

func (d DCRProviderResource) GetDependencies() []ResourceRef

func (DCRProviderResource) GetKonnectMonikerFilter added in v0.8.0 

func (d DCRProviderResource) GetKonnectMonikerFilter() string

func (DCRProviderResource) GetLabels added in v0.8.0 

func (d DCRProviderResource) GetLabels() map[string]string

func (DCRProviderResource) GetMoniker added in v0.8.0 

func (d DCRProviderResource) GetMoniker() string

func (DCRProviderResource) GetReferenceFieldMappings added in v0.8.0 

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

func (DCRProviderResource) GetType added in v0.8.0 

func (d DCRProviderResource) GetType() ResourceType

func (*DCRProviderResource) SetDefaults added in v0.8.0 

func (d *DCRProviderResource) SetDefaults()

func (*DCRProviderResource) SetLabels added in v0.8.0 

func (d *DCRProviderResource) SetLabels(labels map[string]string)

func (DCRProviderResource) ToCreatePayload added in v0.8.0 

func (d DCRProviderResource) ToCreatePayload() map[string]any

func (DCRProviderResource) ToSDKRequest added in v0.8.0 

func (d DCRProviderResource) ToSDKRequest() (kkComps.CreateDcrProviderRequest, error)

func (DCRProviderResource) ToUpdatePayload added in v0.8.0 

func (d DCRProviderResource) ToUpdatePayload() map[string]any

func (*DCRProviderResource) TryMatchKonnectResource added in v0.8.0 

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

func (DCRProviderResource) Validate added in v0.8.0 

func (d DCRProviderResource) Validate() error

type DashboardResource added in v1.0.0 

type DashboardResource struct {
	BaseResource
	Name       string            `yaml:"name"             json:"name"`
	Definition kkComps.Dashboard `yaml:"definition"       json:"definition"`
	Labels     map[string]string `yaml:"labels,omitempty" json:"labels,omitempty"`
	// contains filtered or unexported fields
}

DashboardResource represents a Konnect Analytics custom dashboard.

func (DashboardResource) GetDependencies added in v1.0.0 

func (d DashboardResource) GetDependencies() []ResourceRef

func (DashboardResource) GetKonnectMonikerFilter added in v1.0.0 

func (d DashboardResource) GetKonnectMonikerFilter() string

func (DashboardResource) GetLabels added in v1.0.0 

func (d DashboardResource) GetLabels() map[string]string

func (DashboardResource) GetMoniker added in v1.0.0 

func (d DashboardResource) GetMoniker() string

func (DashboardResource) GetType added in v1.0.0 

func (d DashboardResource) GetType() ResourceType

func (DashboardResource) MarshalJSON added in v1.0.0 

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

func (*DashboardResource) SetDefaults added in v1.0.0 

func (d *DashboardResource) SetDefaults()

func (*DashboardResource) SetLabels added in v1.0.0 

func (d *DashboardResource) SetLabels(labels map[string]string)

func (*DashboardResource) TryMatchKonnectResource added in v1.0.0 

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

func (*DashboardResource) UnmarshalJSON added in v1.0.0 

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

func (*DashboardResource) UnmarshalYAML added in v1.0.0 

func (d *DashboardResource) UnmarshalYAML(unmarshal func(any) error) error

func (DashboardResource) Validate added in v1.0.0 

func (d DashboardResource) Validate() error

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 EventGatewayClusterPolicyResource added in v0.8.0 

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

EventGatewayClusterPolicyResource represents a cluster-level policy in declarative configuration. The SDK represents cluster policies as a union type (EventGatewayClusterPolicyModify) with the "acls" variant (EventGatewayACLsPolicy).

func (EventGatewayClusterPolicyResource) GetDependencies added in v0.8.0 

func (e EventGatewayClusterPolicyResource) GetDependencies() []ResourceRef

func (EventGatewayClusterPolicyResource) GetKonnectID added in v0.8.0 

func (e EventGatewayClusterPolicyResource) GetKonnectID() string

func (EventGatewayClusterPolicyResource) GetKonnectMonikerFilter added in v0.8.0 

func (e EventGatewayClusterPolicyResource) GetKonnectMonikerFilter() string

func (EventGatewayClusterPolicyResource) GetMoniker added in v0.8.0 

func (e EventGatewayClusterPolicyResource) GetMoniker() string

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

func (EventGatewayClusterPolicyResource) GetParentRef added in v0.8.0 

func (e EventGatewayClusterPolicyResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayClusterPolicyResource) GetRef added in v0.8.0 

func (e EventGatewayClusterPolicyResource) GetRef() string

func (EventGatewayClusterPolicyResource) GetType added in v0.8.0 

func (e EventGatewayClusterPolicyResource) GetType() ResourceType

func (EventGatewayClusterPolicyResource) MarshalJSON added in v0.8.0 

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

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

func (*EventGatewayClusterPolicyResource) SetDefaults added in v0.8.0 

func (e *EventGatewayClusterPolicyResource) SetDefaults()

func (*EventGatewayClusterPolicyResource) TryMatchKonnectResource added in v0.8.0 

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

func (*EventGatewayClusterPolicyResource) UnmarshalJSON added in v0.8.0 

func (e *EventGatewayClusterPolicyResource) 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 to use. Currently only "acls" type is supported (EventGatewayACLsPolicy).

func (EventGatewayClusterPolicyResource) Validate added in v0.8.0 

func (e EventGatewayClusterPolicyResource) Validate() error

type EventGatewayConsumePolicyResource added in v0.8.0 

type EventGatewayConsumePolicyResource struct {
	kkComps.EventGatewayConsumePolicyCreate `yaml:",inline" json:",inline"`
	Ref                                     string `yaml:"ref"                       json:"ref"`
	// Parent Virtual Cluster reference (for root-level definitions)
	VirtualCluster string `yaml:"virtual_cluster,omitempty" json:"virtual_cluster,omitempty"`
	EventGateway   string `yaml:"event_gateway,omitempty"   json:"event_gateway,omitempty"`
	// contains filtered or unexported fields
}

EventGatewayConsumePolicyResource represents a consume policy in declarative configuration. Consume policies are grandchildren: Event Gateway → Virtual Cluster → Consume Policy. The SDK represents consume policies as a discriminated union type (EventGatewayConsumePolicyCreate) with five variants: modify_headers, schema_validation, decrypt, skip_record, decrypt_fields. The "type" discriminator field is required.

func (EventGatewayConsumePolicyResource) GetDependencies added in v0.8.0 

func (e EventGatewayConsumePolicyResource) GetDependencies() []ResourceRef

func (EventGatewayConsumePolicyResource) GetKonnectID added in v0.8.0 

func (e EventGatewayConsumePolicyResource) GetKonnectID() string

func (EventGatewayConsumePolicyResource) GetKonnectMonikerFilter added in v0.8.0 

func (e EventGatewayConsumePolicyResource) GetKonnectMonikerFilter() string

func (EventGatewayConsumePolicyResource) GetMoniker added in v0.8.0 

func (e EventGatewayConsumePolicyResource) GetMoniker() string

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

func (EventGatewayConsumePolicyResource) GetParentRef added in v0.8.0 

func (e EventGatewayConsumePolicyResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayConsumePolicyResource) GetRef added in v0.8.0 

func (e EventGatewayConsumePolicyResource) GetRef() string

func (EventGatewayConsumePolicyResource) GetType added in v0.8.0 

func (e EventGatewayConsumePolicyResource) GetType() ResourceType

func (EventGatewayConsumePolicyResource) MarshalJSON added in v0.8.0 

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

MarshalJSON ensures consume policy metadata (ref, virtual_cluster, event_gateway) are included in the serialized output.

func (*EventGatewayConsumePolicyResource) SetDefaults added in v0.8.0 

func (e *EventGatewayConsumePolicyResource) SetDefaults()

func (*EventGatewayConsumePolicyResource) TryMatchKonnectResource added in v0.8.0 

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

func (*EventGatewayConsumePolicyResource) UnmarshalJSON added in v0.8.0 

func (e *EventGatewayConsumePolicyResource) 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 to use:

  • "modify_headers" → EventGatewayModifyHeadersPolicyCreate
  • "schema_validation" → EventGatewayConsumeSchemaValidationPolicy
  • "decrypt" → EventGatewayDecryptPolicy
  • "skip_record" → EventGatewaySkipRecordPolicyCreate
  • "decrypt_fields" → EventGatewayParsedRecordDecryptFieldsPolicyCreate

func (EventGatewayConsumePolicyResource) Validate added in v0.8.0 

func (e EventGatewayConsumePolicyResource) 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
	SchemaRegistries      []EventGatewaySchemaRegistryResource       `yaml:"schema_registries,omitempty"       json:"schema_registries,omitempty"`       //nolint:lll
	StaticKeys            []EventGatewayStaticKeyResource            `yaml:"static_keys,omitempty"             json:"static_keys,omitempty"`             //nolint:lll
	TrustBundles          []EventGatewayTLSTrustBundleResource       `yaml:"tls_trust_bundles,omitempty"       json:"tls_trust_bundles,omitempty"`       //nolint:lll

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

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) IsExternal added in v1.4.1 

func (e *EventGatewayControlPlaneResource) IsExternal() bool

IsExternal returns true if this Event Gateway is externally managed.

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 EventGatewayProducePolicyResource added in v0.8.0 

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

EventGatewayProducePolicyResource represents a produce policy in declarative configuration. The SDK represents produce policies as a union type (EventGatewayProducePolicyCreate) with variants: modify_headers, schema_validation, encrypt, and encrypt_fields.

func (EventGatewayProducePolicyResource) GetDependencies added in v0.8.0 

func (e EventGatewayProducePolicyResource) GetDependencies() []ResourceRef

func (EventGatewayProducePolicyResource) GetKonnectID added in v0.8.0 

func (e EventGatewayProducePolicyResource) GetKonnectID() string

func (EventGatewayProducePolicyResource) GetKonnectMonikerFilter added in v0.8.0 

func (e EventGatewayProducePolicyResource) GetKonnectMonikerFilter() string

func (EventGatewayProducePolicyResource) GetMoniker added in v0.8.0 

func (e EventGatewayProducePolicyResource) GetMoniker() string

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

func (EventGatewayProducePolicyResource) GetParentRef added in v0.8.0 

func (e EventGatewayProducePolicyResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewayProducePolicyResource) GetRef added in v0.8.0 

func (e EventGatewayProducePolicyResource) GetRef() string

func (EventGatewayProducePolicyResource) GetType added in v0.8.0 

func (e EventGatewayProducePolicyResource) GetType() ResourceType

func (EventGatewayProducePolicyResource) MarshalJSON added in v0.8.0 

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

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

func (*EventGatewayProducePolicyResource) SetDefaults added in v0.8.0 

func (e *EventGatewayProducePolicyResource) SetDefaults()

func (*EventGatewayProducePolicyResource) TryMatchKonnectResource added in v0.8.0 

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

func (*EventGatewayProducePolicyResource) UnmarshalJSON added in v0.8.0 

func (e *EventGatewayProducePolicyResource) 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 to use. Supported types: modify_headers, schema_validation, encrypt, encrypt_fields.

func (EventGatewayProducePolicyResource) Validate added in v0.8.0 

func (e EventGatewayProducePolicyResource) Validate() error

type EventGatewaySchemaRegistryResource added in v0.8.0 

type EventGatewaySchemaRegistryResource struct {
	kkComps.SchemaRegistryCreate `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
}

EventGatewaySchemaRegistryResource represents a schema registry in declarative configuration. The SDK represents schema registries as a union type (SchemaRegistryCreate) with the "confluent" variant (SchemaRegistryConfluent).

func (EventGatewaySchemaRegistryResource) GetDependencies added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) GetDependencies() []ResourceRef

func (EventGatewaySchemaRegistryResource) GetKonnectID added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) GetKonnectID() string

func (EventGatewaySchemaRegistryResource) GetKonnectMonikerFilter added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) GetKonnectMonikerFilter() string

func (EventGatewaySchemaRegistryResource) GetMoniker added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) GetMoniker() string

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

func (EventGatewaySchemaRegistryResource) GetParentRef added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) GetParentRef() *ResourceRef

REQUIRED: Implement ResourceWithParent

func (EventGatewaySchemaRegistryResource) GetRef added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) GetRef() string

func (EventGatewaySchemaRegistryResource) GetType added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) GetType() ResourceType

func (EventGatewaySchemaRegistryResource) MarshalJSON added in v0.8.0 

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

MarshalJSON ensures schema registry metadata (ref, event_gateway) are included along with the union body. Without this, the embedded SchemaRegistryCreate's MarshalJSON is promoted and drops our metadata fields.

func (*EventGatewaySchemaRegistryResource) SetDefaults added in v0.8.0 

func (e *EventGatewaySchemaRegistryResource) SetDefaults()

func (*EventGatewaySchemaRegistryResource) TryMatchKonnectResource added in v0.8.0 

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

func (*EventGatewaySchemaRegistryResource) UnmarshalJSON added in v0.8.0 

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

UnmarshalJSON handles the union type correctly. It rejects kongctl metadata and delegates to the SDK union type for the registry body. The SDK union type requires a "type" discriminator field to determine which variant to use. Currently only "confluent" type is supported.

func (EventGatewaySchemaRegistryResource) Validate added in v0.8.0 

func (e EventGatewaySchemaRegistryResource) Validate() error

type EventGatewayStaticKeyResource added in v0.8.0 

type EventGatewayStaticKeyResource struct {
	kkComps.EventGatewayStaticKeyCreate `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
}

EventGatewayStaticKeyResource represents an Event Gateway Static Key resource. Static keys are used by Encrypt and Decrypt policies to encrypt data at rest. This resource does not support update operations – changes are implemented as delete + create.

func (EventGatewayStaticKeyResource) GetDependencies added in v0.8.0 

func (e EventGatewayStaticKeyResource) GetDependencies() []ResourceRef

func (EventGatewayStaticKeyResource) GetKonnectID added in v0.8.0 

func (e EventGatewayStaticKeyResource) GetKonnectID() string

func (EventGatewayStaticKeyResource) GetKonnectMonikerFilter added in v0.8.0 

func (e EventGatewayStaticKeyResource) GetKonnectMonikerFilter() string

func (EventGatewayStaticKeyResource) GetMoniker added in v0.8.0 

func (e EventGatewayStaticKeyResource) GetMoniker() string

func (EventGatewayStaticKeyResource) GetParentRef added in v0.8.0 

func (e EventGatewayStaticKeyResource) GetParentRef() *ResourceRef

GetParentRef REQUIRED: marks resource as a child of Event Gateway.

func (EventGatewayStaticKeyResource) GetRef added in v0.8.0 

func (e EventGatewayStaticKeyResource) GetRef() string

func (EventGatewayStaticKeyResource) GetType added in v0.8.0 

func (e EventGatewayStaticKeyResource) GetType() ResourceType

func (EventGatewayStaticKeyResource) MarshalJSON added in v0.8.0 

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

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

func (*EventGatewayStaticKeyResource) SetDefaults added in v0.8.0 

func (e *EventGatewayStaticKeyResource) SetDefaults()

func (*EventGatewayStaticKeyResource) TryMatchKonnectResource added in v0.8.0 

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

func (*EventGatewayStaticKeyResource) UnmarshalJSON added in v0.8.0 

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

UnmarshalJSON rejects kongctl metadata (not supported on child resources).

func (EventGatewayStaticKeyResource) Validate added in v0.8.0 

func (e EventGatewayStaticKeyResource) Validate() error

type EventGatewayTLSTrustBundleResource added in v0.8.0 

type EventGatewayTLSTrustBundleResource struct {
	kkComps.CreateTLSTrustBundleRequest `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
}

EventGatewayTLSTrustBundleResource represents an Event Gateway TLS Trust Bundle resource. Trust bundles define trusted certificate authorities used for mTLS client certificate verification. They are referenced by TLS listener policies. This resource supports update operations.

func (EventGatewayTLSTrustBundleResource) GetDependencies added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) GetDependencies() []ResourceRef

func (EventGatewayTLSTrustBundleResource) GetKonnectID added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) GetKonnectID() string

func (EventGatewayTLSTrustBundleResource) GetKonnectMonikerFilter added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) GetKonnectMonikerFilter() string

func (EventGatewayTLSTrustBundleResource) GetMoniker added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) GetMoniker() string

func (EventGatewayTLSTrustBundleResource) GetParentRef added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) GetParentRef() *ResourceRef

GetParentRef REQUIRED: marks resource as a child of Event Gateway.

func (EventGatewayTLSTrustBundleResource) GetRef added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) GetRef() string

func (EventGatewayTLSTrustBundleResource) GetType added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) GetType() ResourceType

func (EventGatewayTLSTrustBundleResource) MarshalJSON added in v0.8.0 

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

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

func (*EventGatewayTLSTrustBundleResource) SetDefaults added in v0.8.0 

func (e *EventGatewayTLSTrustBundleResource) SetDefaults()

func (*EventGatewayTLSTrustBundleResource) TryMatchKonnectResource added in v0.8.0 

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

func (*EventGatewayTLSTrustBundleResource) UnmarshalJSON added in v0.8.0 

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

UnmarshalJSON rejects kongctl metadata (not supported on child resources).

func (EventGatewayTLSTrustBundleResource) Validate added in v0.8.0 

func (e EventGatewayTLSTrustBundleResource) 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"`

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

	// Nested child resources
	ClusterPolicies []EventGatewayClusterPolicyResource `yaml:"cluster_policies,omitempty" json:"cluster_policies,omitempty"` //nolint:lll
	ProducePolicies []EventGatewayProducePolicyResource `yaml:"produce_policies,omitempty" json:"produce_policies,omitempty"` //nolint:lll
	ConsumePolicies []EventGatewayConsumePolicyResource `yaml:"consume_policies,omitempty" json:"consume_policies,omitempty"` //nolint:lll
	// 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) IsExternal added in v1.4.1 

func (e *EventGatewayVirtualClusterResource) IsExternal() bool

IsExternal returns true if this virtual cluster is externally managed.

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) SetKonnectID added in v1.4.1 

func (e *EventGatewayVirtualClusterResource) SetKonnectID(id string)

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 ExplainBuildContext added in v0.8.0 

type ExplainBuildContext struct {
	ResourceType ResourceType
	Registration ExplainRegistration
}

type ExplainDoc added in v0.8.0 

type ExplainDoc struct {
	ResourceType              ResourceType      `json:"resource_type"               yaml:"resource_type"`
	CanonicalAlias            string            `json:"canonical_alias"             yaml:"canonical_alias"`
	Aliases                   []string          `json:"aliases,omitempty"           yaml:"aliases,omitempty"`
	ResourceClass             string            `json:"resource_class"              yaml:"resource_class"`
	RootKey                   string            `json:"root_key,omitempty"          yaml:"root_key,omitempty"`
	SupportsRoot              bool              `json:"supports_root"               yaml:"supports_root"`
	SupportsNestedDeclaration bool              `json:"supports_nested_declaration" yaml:"supports_nested_declaration"`
	NestedRelations           []ExplainRelation `json:"nested_relations,omitempty"  yaml:"nested_relations,omitempty"`
	ParentRelations           []ExplainRelation `json:"parent_relations,omitempty"  yaml:"parent_relations,omitempty"`
	SupportsKongctl           bool              `json:"supports_kongctl"            yaml:"supports_kongctl"`
	Maturity                  ExplainMaturity   `json:"maturity"                    yaml:"maturity"`
	Schema                    *ExplainNode      `json:"-"                           yaml:"-"`
	// contains filtered or unexported fields
}

type ExplainField added in v0.8.0 

type ExplainField struct {
	Name        string
	Node        *ExplainNode
	Required    bool
	Recommended bool
}

type ExplainFieldHint added in v0.8.0 

type ExplainFieldHint struct {
	Description  string
	Default      any
	DefaultFrom  string
	Enum         []any
	FileSample   string
	Literal      string
	Recommended  *bool
	PreferredTag string
	RefKind      string
	Notes        []string
}

type ExplainMaturity added in v1.5.0 

type ExplainMaturity struct {
	Level        capmaturity.Level               `json:"level"                   yaml:"level"`
	Message      string                          `json:"message,omitempty"       yaml:"message,omitempty"`
	ReferenceURL string                          `json:"reference_url,omitempty" yaml:"reference_url,omitempty"`
	Operations   map[string]capmaturity.Metadata `json:"operations"              yaml:"operations"`
}

ExplainMaturity is the machine-readable resource maturity schema extension.

type ExplainNode added in v0.8.0 

type ExplainNode struct {
	Kind         string
	Description  string
	Default      any
	DefaultFrom  string
	Enum         []any
	Const        any
	Nullable     bool
	Recommended  bool
	PreferredTag string
	RefKind      string
	Notes        []string
	Literal      string
	Properties   []*ExplainField

	Items      *ExplainNode
	Additional *ExplainNode
	OneOf      []*ExplainNode
	// contains filtered or unexported fields
}

type ExplainOption added in v0.8.0 

type ExplainOption func(*ExplainRegistration)

func WithExplainAliases added in v0.8.0 

func WithExplainAliases(aliases ...string) ExplainOption

func WithExplainFieldHint added in v0.8.0 

func WithExplainFieldHint(path string, hint ExplainFieldHint) ExplainOption

func WithExplainRecommendedFields added in v0.8.0 

func WithExplainRecommendedFields(paths ...string) ExplainOption

func WithExplainSchemaBuilder added in v0.8.0 

func WithExplainSchemaBuilder(fn func(ExplainBuildContext) (*ExplainNode, error)) ExplainOption

type ExplainRegistration added in v0.8.0 

type ExplainRegistration struct {
	// contains filtered or unexported fields
}

func AutoExplain added in v0.8.0 

func AutoExplain[R any](opts ...ExplainOption) ExplainRegistration

type ExplainRelation added in v0.8.0 

type ExplainRelation struct {
	ParentAlias   string `json:"parent_alias"    yaml:"parent_alias"`
	ParentType    string `json:"parent_type"     yaml:"parent_type"`
	FieldName     string `json:"field_name"      yaml:"field_name"`
	FieldArray    bool   `json:"field_array"     yaml:"field_array"`
	ChildAlias    string `json:"child_alias"     yaml:"child_alias"`
	ParentRootKey string `json:"parent_root_key" yaml:"parent_root_key"`
}

type ExplainScaffoldNode added in v0.8.0 

type ExplainScaffoldNode struct {
	Step ExplainScaffoldStep
	Node *ExplainNode
	Omit []string
}

type ExplainScaffoldStep added in v0.8.0 

type ExplainScaffoldStep struct {
	Name  string
	Array bool
}

type ExplainSchemaPlacement added in v0.8.0 

type ExplainSchemaPlacement struct {
	YAMLPath        string   `json:"yaml_path,omitempty"         yaml:"yaml_path,omitempty"`
	RootYAMLPath    string   `json:"root_yaml_path,omitempty"    yaml:"root_yaml_path,omitempty"`
	NestedYAMLPath  string   `json:"nested_yaml_path,omitempty"  yaml:"nested_yaml_path,omitempty"`
	NestedYAMLPaths []string `json:"nested_yaml_paths,omitempty" yaml:"nested_yaml_paths,omitempty"`
}

type ExplainSchemaResource added in v0.8.0 

type ExplainSchemaResource struct {
	Name          string `json:"name"           yaml:"name"`
	ResourceClass string `json:"resource_class" yaml:"resource_class"`
}

type ExplainSchemaSubject added in v0.8.0 

type ExplainSchemaSubject struct {
	Kind        string `json:"kind"                  yaml:"kind"`
	Path        string `json:"path"                  yaml:"path"`
	Required    *bool  `json:"required,omitempty"    yaml:"required,omitempty"`
	Recommended *bool  `json:"recommended,omitempty" yaml:"recommended,omitempty"`
}

type ExplainSubject added in v0.8.0 

type ExplainSubject struct {
	Doc               *ExplainDoc
	Node              *ExplainNode
	DisplayPath       string
	FieldPath         []string
	FieldRelativePath []string
	FieldRequired     bool
	FieldRecommended  bool
	ScaffoldSteps     []ExplainScaffoldStep
	ScaffoldOmit      []string
	ScaffoldTrail     []ExplainScaffoldNode
	AncestorTypes     []ResourceType
	ResourceTarget    bool
}

func ResolveExplainSubject added in v0.8.0 

func ResolveExplainSubject(path string) (*ExplainSubject, 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 JSONSchema added in v0.8.0 

type JSONSchema struct {
	Schema      string                  `json:"$schema,omitempty" yaml:"$schema,omitempty"`
	ID          string                  `json:"$id,omitempty" yaml:"$id,omitempty"`
	Title       string                  `json:"title,omitempty" yaml:"title,omitempty"`
	Description string                  `json:"description,omitempty" yaml:"description,omitempty"`
	Type        any                     `json:"type,omitempty" yaml:"type,omitempty"`
	Properties  map[string]*JSONSchema  `json:"properties,omitempty" yaml:"properties,omitempty"`
	Required    []string                `json:"required,omitempty" yaml:"required,omitempty"`
	Items       *JSONSchema             `json:"items,omitempty" yaml:"items,omitempty"`
	Additional  any                     `json:"additionalProperties,omitempty" yaml:"additionalProperties,omitempty"`
	OneOf       []*JSONSchema           `json:"oneOf,omitempty" yaml:"oneOf,omitempty"`
	Const       any                     `json:"const,omitempty" yaml:"const,omitempty"`
	Enum        []any                   `json:"enum,omitempty" yaml:"enum,omitempty"`
	Default     any                     `json:"default,omitempty" yaml:"default,omitempty"`
	XResource   any                     `json:"x-kongctl-resource,omitempty" yaml:"x-kongctl-resource,omitempty"`
	XPath       string                  `json:"x-kongctl-path,omitempty" yaml:"x-kongctl-path,omitempty"`
	XRootKey    string                  `json:"x-kongctl-root-key,omitempty" yaml:"x-kongctl-root-key,omitempty"`
	XClass      string                  `json:"x-kongctl-resource-class,omitempty" yaml:"x-kongctl-resource-class,omitempty"` //nolint:lll
	XRefKind    string                  `json:"x-kongctl-ref-kind,omitempty" yaml:"x-kongctl-ref-kind,omitempty"`
	XTag        string                  `json:"x-kongctl-preferred-tag,omitempty" yaml:"x-kongctl-preferred-tag,omitempty"`
	XDefault    string                  `json:"x-kongctl-default-from,omitempty" yaml:"x-kongctl-default-from,omitempty"`
	XNotes      []string                `json:"x-kongctl-notes,omitempty" yaml:"x-kongctl-notes,omitempty"`
	XSubject    *ExplainSchemaSubject   `json:"x-kongctl-subject,omitempty" yaml:"x-kongctl-subject,omitempty"`
	XPlacement  *ExplainSchemaPlacement `json:"x-kongctl-placement,omitempty" yaml:"x-kongctl-placement,omitempty"`
	XRoot       *bool                   `json:"x-kongctl-supports-root,omitempty" yaml:"x-kongctl-supports-root,omitempty"`
	XNestedDecl *bool                   `json:"x-kongctl-supports-nested-declaration,omitempty" yaml:"x-kongctl-supports-nested-declaration,omitempty"` //nolint:lll
	XMaturity   *ExplainMaturity        `json:"x-kongctl-maturity,omitempty" yaml:"x-kongctl-maturity,omitempty"`
}

func RenderExplainSchema added in v0.8.0 

func RenderExplainSchema(subject *ExplainSubject) *JSONSchema

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 Operation added in v1.5.0 

type Operation string

Operation identifies a declarative resource operation with independent maturity. 

const (
	OperationRead   Operation = "read"
	OperationCreate Operation = "create"
	OperationUpdate Operation = "update"
	OperationDelete Operation = "delete"
	OperationAdopt  Operation = "adopt"
)

func Operations added in v1.5.0 

func Operations() []Operation

Operations returns all supported declarative maturity operations in display order.

type OrganizationResource added in v0.4.0 

type OrganizationResource struct {
	// Teams nested under this organization
	Teams []OrganizationTeamResource `yaml:"teams,omitempty"           json:"teams,omitempty"`
	// Users contains user-bound team memberships and role assignments.
	Users []OrganizationUserResource `yaml:"users,omitempty"           json:"users,omitempty"`
	// SystemAccounts contains system-account-bound team memberships and role assignments.
	SystemAccounts []OrganizationSystemAccountResource `yaml:"system-accounts,omitempty" json:"system-accounts,omitempty"`
}

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

type OrganizationSystemAccountResource added in v1.0.0 

type OrganizationSystemAccountResource struct {
	Ref     string                                            `yaml:"ref"               json:"ref"`
	Name    string                                            `yaml:"name,omitempty"    json:"name,omitempty"`
	ID      string                                            `yaml:"id,omitempty"      json:"id,omitempty"`
	Kongctl *KongctlMeta                                      `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`
	Teams   []OrganizationSystemAccountTeamMembershipResource `yaml:"teams,omitempty"   json:"teams,omitempty"`
	Roles   []OrganizationSystemAccountRoleResource           `yaml:"roles,omitempty"   json:"roles,omitempty"`
	// contains filtered or unexported fields
}

OrganizationSystemAccountResource selects an existing Konnect system account and declares assignments.

func (OrganizationSystemAccountResource) GetKonnectID added in v1.0.0 

func (s OrganizationSystemAccountResource) GetKonnectID() string

func (OrganizationSystemAccountResource) GetRef added in v1.0.0 

func (s OrganizationSystemAccountResource) GetRef() string

func (*OrganizationSystemAccountResource) SetKonnectID added in v1.0.0 

func (s *OrganizationSystemAccountResource) SetKonnectID(id string)

func (OrganizationSystemAccountResource) Validate added in v1.0.0 

func (s OrganizationSystemAccountResource) Validate() error

type OrganizationSystemAccountRoleResource added in v1.0.0 

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

	SystemAccount string `yaml:"-" json:"-"`

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

OrganizationSystemAccountRoleResource represents an assigned role on a system account.

func (OrganizationSystemAccountRoleResource) GetDependencies added in v1.0.0 

func (r OrganizationSystemAccountRoleResource) GetDependencies() []ResourceRef

func (OrganizationSystemAccountRoleResource) GetKonnectID added in v1.0.0 

func (r OrganizationSystemAccountRoleResource) GetKonnectID() string

func (OrganizationSystemAccountRoleResource) GetKonnectMonikerFilter added in v1.0.0 

func (r OrganizationSystemAccountRoleResource) GetKonnectMonikerFilter() string

func (OrganizationSystemAccountRoleResource) GetMoniker added in v1.0.0 

func (r OrganizationSystemAccountRoleResource) GetMoniker() string

func (OrganizationSystemAccountRoleResource) GetRef added in v1.0.0 

func (r OrganizationSystemAccountRoleResource) GetRef() string

func (OrganizationSystemAccountRoleResource) GetType added in v1.0.0 

func (r OrganizationSystemAccountRoleResource) GetType() ResourceType

func (*OrganizationSystemAccountRoleResource) SetDefaults added in v1.0.0 

func (r *OrganizationSystemAccountRoleResource) SetDefaults()

func (*OrganizationSystemAccountRoleResource) TryMatchKonnectResource added in v1.0.0 

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

func (OrganizationSystemAccountRoleResource) Validate added in v1.0.0 

func (r OrganizationSystemAccountRoleResource) Validate() error

type OrganizationSystemAccountTeamMembershipResource added in v1.0.0 

type OrganizationSystemAccountTeamMembershipResource struct {
	Ref           string `yaml:"ref"  json:"ref"`
	SystemAccount string `yaml:"-"    json:"-"`
	Team          string `yaml:"team" json:"team"`
}

OrganizationSystemAccountTeamMembershipResource is an internal relation resource.

func (OrganizationSystemAccountTeamMembershipResource) GetDependencies added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) GetDependencies() []ResourceRef

func (OrganizationSystemAccountTeamMembershipResource) GetKonnectID added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) GetKonnectID() string

func (OrganizationSystemAccountTeamMembershipResource) GetKonnectMonikerFilter added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) GetKonnectMonikerFilter() string

func (OrganizationSystemAccountTeamMembershipResource) GetMoniker added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) GetMoniker() string

func (OrganizationSystemAccountTeamMembershipResource) GetRef added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) GetRef() string

func (OrganizationSystemAccountTeamMembershipResource) GetType added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) GetType() ResourceType

func (*OrganizationSystemAccountTeamMembershipResource) SetDefaults added in v1.0.0 

func (r *OrganizationSystemAccountTeamMembershipResource) SetDefaults()

func (*OrganizationSystemAccountTeamMembershipResource) TryMatchKonnectResource added in v1.0.0 

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

func (OrganizationSystemAccountTeamMembershipResource) Validate added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) Validate() error

func (OrganizationSystemAccountTeamMembershipResource) ValidateNested added in v1.0.0 

func (r OrganizationSystemAccountTeamMembershipResource) ValidateNested() error

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"`
	Roles              []OrganizationTeamRoleResource `yaml:"roles,omitempty"     json:"roles,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) MarshalJSON added in v1.0.0 

func (t OrganizationTeamResource) MarshalJSON() ([]byte, error)

func (OrganizationTeamResource) MarshalYAML added in v1.0.0 

func (t OrganizationTeamResource) MarshalYAML() (any, error)

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 OrganizationTeamRoleResource added in v1.0.0 

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

	// Parent team reference.
	Team string `yaml:"team,omitempty" json:"team,omitempty"`

	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
}

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

func (OrganizationTeamRoleResource) GetDependencies added in v1.0.0 

func (r OrganizationTeamRoleResource) GetDependencies() []ResourceRef

func (OrganizationTeamRoleResource) GetKonnectID added in v1.0.0 

func (r OrganizationTeamRoleResource) GetKonnectID() string

func (OrganizationTeamRoleResource) GetKonnectMonikerFilter added in v1.0.0 

func (r OrganizationTeamRoleResource) GetKonnectMonikerFilter() string

func (OrganizationTeamRoleResource) GetMoniker added in v1.0.0 

func (r OrganizationTeamRoleResource) GetMoniker() string

func (OrganizationTeamRoleResource) GetParentRef added in v1.0.0 

func (r OrganizationTeamRoleResource) GetParentRef() *ResourceRef

func (OrganizationTeamRoleResource) GetRef added in v1.0.0 

func (r OrganizationTeamRoleResource) GetRef() string

func (OrganizationTeamRoleResource) GetType added in v1.0.0 

func (r OrganizationTeamRoleResource) GetType() ResourceType

func (OrganizationTeamRoleResource) MarshalJSON added in v1.0.0 

func (r OrganizationTeamRoleResource) MarshalJSON() ([]byte, error)

func (OrganizationTeamRoleResource) MarshalYAML added in v1.0.0 

func (r OrganizationTeamRoleResource) MarshalYAML() (any, error)

func (*OrganizationTeamRoleResource) SetDefaults added in v1.0.0 

func (r *OrganizationTeamRoleResource) SetDefaults()

func (*OrganizationTeamRoleResource) TryMatchKonnectResource added in v1.0.0 

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

func (*OrganizationTeamRoleResource) UnmarshalJSON added in v1.0.0 

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

func (OrganizationTeamRoleResource) Validate added in v1.0.0 

func (r OrganizationTeamRoleResource) Validate() error

type OrganizationUserResource added in v1.0.0 

type OrganizationUserResource struct {
	Ref     string                                   `yaml:"ref"               json:"ref"`
	Email   string                                   `yaml:"email,omitempty"   json:"email,omitempty"`
	ID      string                                   `yaml:"id,omitempty"      json:"id,omitempty"`
	Kongctl *KongctlMeta                             `yaml:"kongctl,omitempty" json:"kongctl,omitempty"`
	Teams   []OrganizationUserTeamMembershipResource `yaml:"teams,omitempty"   json:"teams,omitempty"`
	Roles   []OrganizationUserRoleResource           `yaml:"roles,omitempty"   json:"roles,omitempty"`
	// contains filtered or unexported fields
}

OrganizationUserResource selects an existing Konnect user and declares user-bound assignments.

func (OrganizationUserResource) GetKonnectID added in v1.0.0 

func (u OrganizationUserResource) GetKonnectID() string

func (OrganizationUserResource) GetRef added in v1.0.0 

func (u OrganizationUserResource) GetRef() string

func (*OrganizationUserResource) SetKonnectID added in v1.0.0 

func (u *OrganizationUserResource) SetKonnectID(id string)

func (OrganizationUserResource) Validate added in v1.0.0 

func (u OrganizationUserResource) Validate() error

type OrganizationUserRoleResource added in v1.0.0 

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

	User string `yaml:"-" json:"-"`

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

OrganizationUserRoleResource represents an assigned role on an organization user.

func (OrganizationUserRoleResource) GetDependencies added in v1.0.0 

func (r OrganizationUserRoleResource) GetDependencies() []ResourceRef

func (OrganizationUserRoleResource) GetKonnectID added in v1.0.0 

func (r OrganizationUserRoleResource) GetKonnectID() string

func (OrganizationUserRoleResource) GetKonnectMonikerFilter added in v1.0.0 

func (r OrganizationUserRoleResource) GetKonnectMonikerFilter() string

func (OrganizationUserRoleResource) GetMoniker added in v1.0.0 

func (r OrganizationUserRoleResource) GetMoniker() string

func (OrganizationUserRoleResource) GetRef added in v1.0.0 

func (r OrganizationUserRoleResource) GetRef() string

func (OrganizationUserRoleResource) GetType added in v1.0.0 

func (r OrganizationUserRoleResource) GetType() ResourceType

func (*OrganizationUserRoleResource) SetDefaults added in v1.0.0 

func (r *OrganizationUserRoleResource) SetDefaults()

func (*OrganizationUserRoleResource) TryMatchKonnectResource added in v1.0.0 

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

func (OrganizationUserRoleResource) Validate added in v1.0.0 

func (r OrganizationUserRoleResource) Validate() error

type OrganizationUserTeamMembershipResource added in v1.0.0 

type OrganizationUserTeamMembershipResource struct {
	Ref  string `yaml:"ref"  json:"ref"`
	User string `yaml:"-"    json:"-"`
	Team string `yaml:"team" json:"team"`
}

OrganizationUserTeamMembershipResource is an internal relation resource.

func (OrganizationUserTeamMembershipResource) GetDependencies added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) GetDependencies() []ResourceRef

func (OrganizationUserTeamMembershipResource) GetKonnectID added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) GetKonnectID() string

func (OrganizationUserTeamMembershipResource) GetKonnectMonikerFilter added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) GetKonnectMonikerFilter() string

func (OrganizationUserTeamMembershipResource) GetMoniker added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) GetMoniker() string

func (OrganizationUserTeamMembershipResource) GetRef added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) GetRef() string

func (OrganizationUserTeamMembershipResource) GetType added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) GetType() ResourceType

func (*OrganizationUserTeamMembershipResource) SetDefaults added in v1.0.0 

func (r *OrganizationUserTeamMembershipResource) SetDefaults()

func (*OrganizationUserTeamMembershipResource) TryMatchKonnectResource added in v1.0.0 

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

func (OrganizationUserTeamMembershipResource) Validate added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) Validate() error

func (OrganizationUserTeamMembershipResource) ValidateNested added in v1.0.0 

func (r OrganizationUserTeamMembershipResource) ValidateNested() error

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 PortalAuditLogWebhookResource added in v0.10.0 

type PortalAuditLogWebhookResource struct {
	Ref                   string `yaml:"ref"                                json:"ref"`
	Portal                string `yaml:"portal,omitempty"                   json:"portal,omitempty"`
	Enabled               *bool  `yaml:"enabled,omitempty"                  json:"enabled,omitempty"`
	AuditLogDestinationID string `yaml:"audit_log_destination_id,omitempty" json:"audit_log_destination_id,omitempty"`
	// contains filtered or unexported fields
}

PortalAuditLogWebhookResource represents the portal audit-log webhook singleton child resource.

func (PortalAuditLogWebhookResource) GetDependencies added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetDependencies() []ResourceRef

func (PortalAuditLogWebhookResource) GetKonnectID added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetKonnectID() string

func (PortalAuditLogWebhookResource) GetKonnectMonikerFilter added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetKonnectMonikerFilter() string

func (PortalAuditLogWebhookResource) GetMoniker added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetMoniker() string

func (PortalAuditLogWebhookResource) GetParentRef added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetParentRef() *ResourceRef

func (PortalAuditLogWebhookResource) GetRef added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetRef() string

func (PortalAuditLogWebhookResource) GetReferenceFieldMappings added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetReferenceFieldMappings() map[string]string

func (PortalAuditLogWebhookResource) GetType added in v0.10.0 

func (w PortalAuditLogWebhookResource) GetType() ResourceType

func (*PortalAuditLogWebhookResource) SetDefaults added in v0.10.0 

func (w *PortalAuditLogWebhookResource) SetDefaults()

func (*PortalAuditLogWebhookResource) TryMatchKonnectResource added in v0.10.0 

func (w *PortalAuditLogWebhookResource) TryMatchKonnectResource(konnectResource any) bool

func (PortalAuditLogWebhookResource) Validate added in v0.10.0 

func (w PortalAuditLogWebhookResource) Validate() error

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 PortalIPAllowListResource added in v0.10.0 

type PortalIPAllowListResource struct {
	Ref        string   `yaml:"ref"              json:"ref"`
	Portal     string   `yaml:"portal,omitempty" json:"portal,omitempty"`
	AllowedIPs []string `yaml:"allowed_ips"      json:"allowed_ips"`
	// contains filtered or unexported fields
}

PortalIPAllowListResource represents a portal IP allow-list entry.

func (PortalIPAllowListResource) GetDependencies added in v0.10.0 

func (l PortalIPAllowListResource) GetDependencies() []ResourceRef

func (PortalIPAllowListResource) GetKonnectID added in v0.10.0 

func (l PortalIPAllowListResource) GetKonnectID() string

func (PortalIPAllowListResource) GetKonnectMonikerFilter added in v0.10.0 

func (l PortalIPAllowListResource) GetKonnectMonikerFilter() string

func (PortalIPAllowListResource) GetMoniker added in v0.10.0 

func (l PortalIPAllowListResource) GetMoniker() string

func (PortalIPAllowListResource) GetParentRef added in v0.10.0 

func (l PortalIPAllowListResource) GetParentRef() *ResourceRef

GetParentRef implements ResourceWithParent for inheritance of namespace and protection.

func (PortalIPAllowListResource) GetRef added in v0.10.0 

func (l PortalIPAllowListResource) GetRef() string

func (PortalIPAllowListResource) GetReferenceFieldMappings added in v0.10.0 

func (l PortalIPAllowListResource) GetReferenceFieldMappings() map[string]string

func (PortalIPAllowListResource) GetType added in v0.10.0 

func (l PortalIPAllowListResource) GetType() ResourceType

func (*PortalIPAllowListResource) SetDefaults added in v0.10.0 

func (l *PortalIPAllowListResource) SetDefaults()

func (*PortalIPAllowListResource) TryMatchKonnectResource added in v0.10.0 

func (l *PortalIPAllowListResource) TryMatchKonnectResource(_ any) bool

func (*PortalIPAllowListResource) UnmarshalJSON added in v0.10.0 

func (l *PortalIPAllowListResource) UnmarshalJSON(data []byte) error

UnmarshalJSON rejects kongctl metadata on child resources.

func (PortalIPAllowListResource) Validate added in v0.10.0 

func (l PortalIPAllowListResource) Validate() error

type PortalIdentityProviderResource added in v0.9.0 

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

PortalIdentityProviderResource represents a portal identity provider child resource.

func (PortalIdentityProviderResource) GetDependencies added in v0.9.0 

func (p PortalIdentityProviderResource) GetDependencies() []ResourceRef

GetDependencies returns references to other resources this provider depends on.

func (PortalIdentityProviderResource) GetKonnectID added in v0.9.0 

func (p PortalIdentityProviderResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available.

func (PortalIdentityProviderResource) GetKonnectMonikerFilter added in v0.9.0 

func (p PortalIdentityProviderResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup.

func (PortalIdentityProviderResource) GetMoniker added in v0.9.0 

func (p PortalIdentityProviderResource) GetMoniker() string

GetMoniker returns the resource moniker.

func (PortalIdentityProviderResource) GetParentRef added in v0.9.0 

func (p PortalIdentityProviderResource) GetParentRef() *ResourceRef

GetParentRef implements ResourceWithParent for inheritance of namespace and protection.

func (PortalIdentityProviderResource) GetRef added in v0.9.0 

func (p PortalIdentityProviderResource) GetRef() string

GetRef returns the reference identifier.

func (PortalIdentityProviderResource) GetType added in v0.9.0 

func (p PortalIdentityProviderResource) GetType() ResourceType

GetType returns the resource type.

func (PortalIdentityProviderResource) MarshalJSON added in v0.9.0 

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

MarshalJSON ensures the embedded SDK request and kongctl fields are preserved when serializing.

func (PortalIdentityProviderResource) MarshalYAML added in v0.9.0 

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

MarshalYAML ensures YAML output mirrors the custom JSON encoding.

func (*PortalIdentityProviderResource) SetDefaults added in v0.9.0 

func (p *PortalIdentityProviderResource) SetDefaults()

SetDefaults applies default values to the resource.

func (*PortalIdentityProviderResource) TryMatchKonnectResource added in v0.9.0 

func (p *PortalIdentityProviderResource) TryMatchKonnectResource(_ any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource.

func (*PortalIdentityProviderResource) UnmarshalJSON added in v0.9.0 

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

UnmarshalJSON rejects kongctl metadata on child resources.

func (PortalIdentityProviderResource) Validate added in v0.9.0 

func (p PortalIdentityProviderResource) Validate() error

Validate ensures the portal identity provider resource is valid.

type PortalIntegrationResource added in v0.10.0 

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

PortalIntegrationResource represents portal integration configuration (singleton child).

func (PortalIntegrationResource) GetDependencies added in v0.10.0 

func (i PortalIntegrationResource) GetDependencies() []ResourceRef

func (PortalIntegrationResource) GetKonnectID added in v0.10.0 

func (i PortalIntegrationResource) GetKonnectID() string

func (PortalIntegrationResource) GetKonnectMonikerFilter added in v0.10.0 

func (i PortalIntegrationResource) GetKonnectMonikerFilter() string

func (PortalIntegrationResource) GetMoniker added in v0.10.0 

func (i PortalIntegrationResource) GetMoniker() string

func (PortalIntegrationResource) GetParentRef added in v0.10.0 

func (i PortalIntegrationResource) GetParentRef() *ResourceRef

GetParentRef implements ResourceWithParent for inheritance of namespace and protection.

func (PortalIntegrationResource) GetRef added in v0.10.0 

func (i PortalIntegrationResource) GetRef() string

func (PortalIntegrationResource) GetReferenceFieldMappings added in v0.10.0 

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

GetReferenceFieldMappings returns cross-resource reference mappings for validation.

func (PortalIntegrationResource) GetType added in v0.10.0 

func (i PortalIntegrationResource) GetType() ResourceType

func (*PortalIntegrationResource) SetDefaults added in v0.10.0 

func (i *PortalIntegrationResource) SetDefaults()

func (*PortalIntegrationResource) TryMatchKonnectResource added in v0.10.0 

func (i *PortalIntegrationResource) TryMatchKonnectResource(_ any) bool

func (*PortalIntegrationResource) UnmarshalJSON added in v0.10.0 

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

UnmarshalJSON rejects kongctl metadata on child resources.

func (PortalIntegrationResource) Validate added in v0.10.0 

func (i PortalIntegrationResource) 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"`      //nolint:lll
	AuthSettings      *PortalAuthSettingsResource            `yaml:"auth_settings,omitempty"      json:"auth_settings,omitempty"`      //nolint:lll
	IPAllowList       *PortalIPAllowListResource             `yaml:"ip_allow_list,omitempty"      json:"ip_allow_list,omitempty"`      //nolint:lll
	Integrations      *PortalIntegrationResource             `yaml:"integrations,omitempty"       json:"integrations,omitempty"`       //nolint:lll
	IdentityProviders []PortalIdentityProviderResource       `yaml:"identity_providers,omitempty" json:"identity_providers,omitempty"` //nolint:lll
	CustomDomain      *PortalCustomDomainResource            `yaml:"custom_domain,omitempty"      json:"custom_domain,omitempty"`      //nolint:lll
	Pages             []PortalPageResource                   `yaml:"pages,omitempty"              json:"pages,omitempty"`
	Snippets          []PortalSnippetResource                `yaml:"snippets,omitempty"           json:"snippets,omitempty"` //nolint:lll
	Teams             []PortalTeamResource                   `yaml:"teams,omitempty"              json:"teams,omitempty"`
	EmailConfig       *PortalEmailConfigResource             `yaml:"email_config,omitempty"       json:"email_config,omitempty"`      //nolint:lll
	EmailTemplates    map[string]PortalEmailTemplateResource `yaml:"email_templates,omitempty"    json:"email_templates,omitempty"`   //nolint:lll
	AuditLogWebhook   *PortalAuditLogWebhookResource         `yaml:"audit_log_webhook,omitempty"  json:"audit_log_webhook,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 PortalTeamGroupMappingResource added in v1.0.0 

type PortalTeamGroupMappingResource struct {
	Ref    string   `yaml:"ref"              json:"ref"`
	Portal string   `yaml:"portal,omitempty" json:"portal,omitempty"`
	Team   string   `yaml:"team"             json:"team"`
	Groups []string `yaml:"groups"           json:"groups"`
}

PortalTeamGroupMappingResource maps a portal team to IdP groups.

func (PortalTeamGroupMappingResource) GetDependencies added in v1.0.0 

func (p PortalTeamGroupMappingResource) GetDependencies() []ResourceRef

GetDependencies returns parent and team dependencies.

func (PortalTeamGroupMappingResource) GetKonnectID added in v1.0.0 

func (p PortalTeamGroupMappingResource) GetKonnectID() string

GetKonnectID returns the resolved Konnect ID if available.

func (PortalTeamGroupMappingResource) GetKonnectMonikerFilter added in v1.0.0 

func (p PortalTeamGroupMappingResource) GetKonnectMonikerFilter() string

GetKonnectMonikerFilter returns the filter string for Konnect API lookup.

func (PortalTeamGroupMappingResource) GetMoniker added in v1.0.0 

func (p PortalTeamGroupMappingResource) GetMoniker() string

GetMoniker returns the resource moniker.

func (PortalTeamGroupMappingResource) GetParentRef added in v1.0.0 

func (p PortalTeamGroupMappingResource) GetParentRef() *ResourceRef

GetParentRef implements ResourceWithParent.

func (PortalTeamGroupMappingResource) GetRef added in v1.0.0 

func (p PortalTeamGroupMappingResource) GetRef() string

GetRef returns the reference identifier.

func (PortalTeamGroupMappingResource) GetType added in v1.0.0 

func (p PortalTeamGroupMappingResource) GetType() ResourceType

GetType returns the resource type.

func (PortalTeamGroupMappingResource) MarshalJSON added in v1.0.0 

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

MarshalJSON keeps kongctl metadata fields stable.

func (*PortalTeamGroupMappingResource) SetDefaults added in v1.0.0 

func (p *PortalTeamGroupMappingResource) SetDefaults()

SetDefaults applies default values to the resource.

func (*PortalTeamGroupMappingResource) TryMatchKonnectResource added in v1.0.0 

func (p *PortalTeamGroupMappingResource) TryMatchKonnectResource(_ any) bool

TryMatchKonnectResource attempts to match this resource with a Konnect resource.

func (*PortalTeamGroupMappingResource) UnmarshalJSON added in v1.0.0 

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

UnmarshalJSON rejects unsupported metadata on child resources.

func (PortalTeamGroupMappingResource) Validate added in v1.0.0 

func (p PortalTeamGroupMappingResource) Validate() error

Validate ensures the mapping has the required declarative identifiers.

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"`
	GroupMappings []PortalTeamGroupMappingResource `yaml:"group_mappings,omitempty" json:"group_mappings,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) MarshalJSON added in v0.8.0 

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

MarshalJSON ensures the embedded SDK request and kongctl fields are preserved when serializing.

func (PortalTeamResource) MarshalYAML added in v0.8.0 

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

MarshalYAML ensures YAML output mirrors the custom JSON encoding.

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) MarshalJSON added in v0.8.0 

func (r PortalTeamRoleResource) MarshalJSON() ([]byte, error)

MarshalJSON ensures role metadata is preserved when serializing nested child resources.

func (PortalTeamRoleResource) MarshalYAML added in v0.8.0 

func (r PortalTeamRoleResource) MarshalYAML() (any, error)

MarshalYAML ensures YAML output mirrors the custom JSON encoding.

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 ResourceType `json:"kind" yaml:"kind"`
	Ref  string       `json:"ref"  yaml:"ref"`
}

ResourceRef represents a reference to another resource

type ResourceRegistrationOption added in v1.5.0 

type ResourceRegistrationOption func(*resourceOps) error

ResourceRegistrationOption configures metadata stored beside resource registration.

func WithMaturity added in v1.5.0 

func WithMaturity(metadata capmaturity.Metadata) ResourceRegistrationOption

WithMaturity sets the default maturity of a declarative resource type.

func WithOperationMaturity added in v1.5.0 

func WithOperationMaturity(
	operation Operation,
	metadata capmaturity.Metadata,
) ResourceRegistrationOption

WithOperationMaturity sets a maturity override for a declarative resource operation.

type ResourceSet 

type ResourceSet struct {
	Portals []PortalResource `yaml:"portals,omitempty"                                        json:"portals,omitempty"`
	// AuditLogs contains organization-scoped audit-log resources.
	AuditLogs *AuditLogsResource `yaml:"audit-logs,omitempty"                                     json:"audit-logs,omitempty"` //nolint:lll
	// ApplicationAuthStrategies contains auth strategy configurations
	ApplicationAuthStrategies []ApplicationAuthStrategyResource `yaml:"application_auth_strategies,omitempty"                    json:"application_auth_strategies,omitempty"` //nolint:lll
	DCRProviders              []DCRProviderResource             `yaml:"dcr_providers,omitempty"                                  json:"dcr_providers,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
	AIGateways                        []AIGatewayResource                        `yaml:"ai_gateways,omitempty"                                    json:"ai_gateways,omitempty"`                           //nolint:lll
	AIGatewayProviders                []AIGatewayProviderResource                `yaml:"ai_gateway_model_providers,omitempty"                    json:"ai_gateway_model_providers,omitempty"`             //nolint:lll
	AIGatewayIdentityProviders        []AIGatewayIdentityProviderResource        `yaml:"ai_gateway_identity_providers,omitempty"                 json:"ai_gateway_identity_providers,omitempty"`          //nolint:lll
	AIGatewayPolicies                 []AIGatewayPolicyResource                  `yaml:"ai_gateway_policies,omitempty"                           json:"ai_gateway_policies,omitempty"`                    //nolint:lll
	AIGatewayAgents                   []AIGatewayAgentResource                   `yaml:"ai_gateway_agents,omitempty"                             json:"ai_gateway_agents,omitempty"`                      //nolint:lll
	AIGatewayConsumers                []AIGatewayConsumerResource                `yaml:"ai_gateway_consumers,omitempty"                          json:"ai_gateway_consumers,omitempty"`                   //nolint:lll
	AIGatewayConsumerCredentials      []AIGatewayConsumerCredentialResource      `yaml:"ai_gateway_consumer_credentials,omitempty"               json:"ai_gateway_consumer_credentials,omitempty"`        //nolint:lll
	AIGatewayConsumerGroups           []AIGatewayConsumerGroupResource           `yaml:"ai_gateway_consumer_groups,omitempty"                    json:"ai_gateway_consumer_groups,omitempty"`             //nolint:lll
	AIGatewayModels                   []AIGatewayModelResource                   `yaml:"ai_gateway_models,omitempty"                              json:"ai_gateway_models,omitempty"`                     //nolint:lll
	AIGatewayMCPServers               []AIGatewayMCPServerResource               `yaml:"ai_gateway_mcp_servers,omitempty"                         json:"ai_gateway_mcp_servers,omitempty"`                //nolint:lll
	AIGatewayVaults                   []AIGatewayVaultResource                   `yaml:"ai_gateway_vaults,omitempty"                              json:"ai_gateway_vaults,omitempty"`                     //nolint:lll
	AIGatewayDataPlaneCertificates    []AIGatewayDataPlaneCertificateResource    `yaml:"ai_gateway_data_plane_certificates,omitempty"              json:"ai_gateway_data_plane_certificates,omitempty"`   //nolint:lll
	APIs                              []APIResource                              `yaml:"apis,omitempty"                                           json:"apis,omitempty"`                                  //nolint:lll
	GatewayServices                   []GatewayServiceResource                   `yaml:"gateway_services,omitempty"                               json:"gateway_services,omitempty"`                      //nolint:lll
	ControlPlaneDataPlaneCertificates []ControlPlaneDataPlaneCertificateResource `yaml:"control_plane_data_plane_certificates,omitempty"          json:"control_plane_data_plane_certificates,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
	PortalIPAllowLists          []PortalIPAllowListResource          `yaml:"portal_ip_allow_lists,omitempty"                          json:"portal_ip_allow_lists,omitempty"`          //nolint:lll
	PortalIntegrations          []PortalIntegrationResource          `yaml:"portal_integrations,omitempty"                            json:"portal_integrations,omitempty"`            //nolint:lll
	PortalIdentityProviders     []PortalIdentityProviderResource     `yaml:"portal_identity_providers,omitempty"                      json:"portal_identity_providers,omitempty"`      //nolint:lll
	PortalTeamGroupMappings     []PortalTeamGroupMappingResource     `yaml:"portal_team_group_mappings,omitempty"                     json:"portal_team_group_mappings,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
	PortalAuditLogWebhooks      []PortalAuditLogWebhookResource      `yaml:"portal_audit_log_webhooks,omitempty"                      json:"portal_audit_log_webhooks,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"` //nolint:lll
	// Analytics grouping - contains nested resources like dashboards
	Analytics *AnalyticsResource `yaml:"analytics,omitempty" json:"analytics,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:"-"`
	OrganizationTeamRoles                    []OrganizationTeamRoleResource                    `yaml:"organization_team_roles,omitempty"                        json:"organization_team_roles,omitempty"` //nolint:lll
	OrganizationUserTeamMemberships          []OrganizationUserTeamMembershipResource          `yaml:"-" json:"-"`
	OrganizationUserRoles                    []OrganizationUserRoleResource                    `yaml:"-" json:"-"`
	OrganizationSystemAccountTeamMemberships []OrganizationSystemAccountTeamMembershipResource `yaml:"-" json:"-"`
	OrganizationSystemAccountRoles           []OrganizationSystemAccountRoleResource           `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
	EventGatewayClusterPolicies              []EventGatewayClusterPolicyResource               ``                                                                                                                 //nolint:lll
	/* 127-byte string literal not displayed */
	EventGatewayProducePolicies []EventGatewayProducePolicyResource `` //nolint:lll
	/* 127-byte string literal not displayed */
	EventGatewayConsumePolicies []EventGatewayConsumePolicyResource `` //nolint:lll
	/* 127-byte string literal not displayed */
	EventGatewayDataPlaneCertificates []EventGatewayDataPlaneCertificateResource `yaml:"event_gateway_data_plane_certificates,omitempty"          json:"event_gateway_data_plane_certificates,omitempty"` //nolint:lll
	EventGatewaySchemaRegistries      []EventGatewaySchemaRegistryResource       `yaml:"event_gateway_schema_registries,omitempty"                json:"event_gateway_schema_registries,omitempty"`       //nolint:lll
	EventGatewayStaticKeys            []EventGatewayStaticKeyResource            `yaml:"event_gateway_static_keys,omitempty"                      json:"event_gateway_static_keys,omitempty"`             //nolint:lll
	EventGatewayTLSTrustBundles       []EventGatewayTLSTrustBundleResource       `yaml:"event_gateway_tls_trust_bundles,omitempty"                json:"event_gateway_tls_trust_bundles,omitempty"`       //nolint:lll
	// Dashboards is populated internally from Analytics.Dashboards during loading.
	// It is not exposed in YAML/JSON to enforce the analytics grouping format.
	Dashboards []DashboardResource `yaml:"-"                                                        json:"-"`
	// 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:"-"`
	// EnvSources tracks deferred !env placeholders by resource ref and field path.
	EnvSources map[string]map[string]string `yaml:"-"                                                        json:"-"`
	// SyncScope tracks resource collection keys explicitly present in the input.
	SyncScope *SyncScope `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) AddEnvSource added in v0.8.0 

func (rs *ResourceSet) AddEnvSource(resourceRef, fieldPath, placeholder string)

AddEnvSource records a deferred !env placeholder for a resource field path.

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) EnsureSyncScope added in v1.0.0 

func (rs *ResourceSet) EnsureSyncScope() *SyncScope

EnsureSyncScope returns the ResourceSet scope, creating it if necessary.

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) GetAIGatewayAgentByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayAgentByRef(ref string) *AIGatewayAgentResource

GetAIGatewayAgentByRef returns an AI Gateway Agent resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayAgentsByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayAgentsByNamespace(namespace string) []AIGatewayAgentResource

GetAIGatewayAgentsByNamespace returns AI Gateway Agent resources from the specified namespace.

func (*ResourceSet) GetAIGatewayAgentsForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayAgentsForGateway(gatewayRef string) []AIGatewayAgentResource

GetAIGatewayAgentsForGateway returns all AI Gateway Agents for a given gateway ref.

func (*ResourceSet) GetAIGatewayByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayByRef(ref string) *AIGatewayResource

GetAIGatewayByRef returns an AI Gateway resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayConsumerByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumerByRef(ref string) *AIGatewayConsumerResource

GetAIGatewayConsumerByRef returns an AI Gateway Consumer resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayConsumerCredentialByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumerCredentialByRef(ref string) *AIGatewayConsumerCredentialResource

GetAIGatewayConsumerCredentialByRef returns an AI Gateway Consumer Credential resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayConsumerCredentialsByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumerCredentialsByNamespace(
	namespace string,
) []AIGatewayConsumerCredentialResource

GetAIGatewayConsumerCredentialsByNamespace returns AI Gateway Consumer Credential resources from the specified namespace.

func (*ResourceSet) GetAIGatewayConsumerCredentialsForConsumer added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumerCredentialsForConsumer(
	consumerRef string,
) []AIGatewayConsumerCredentialResource

GetAIGatewayConsumerCredentialsForConsumer returns all AI Gateway Consumer Credentials for a given consumer ref.

func (*ResourceSet) GetAIGatewayConsumerGroupByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumerGroupByRef(ref string) *AIGatewayConsumerGroupResource

GetAIGatewayConsumerGroupByRef returns an AI Gateway Consumer Group resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayConsumerGroupsByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumerGroupsByNamespace(namespace string) []AIGatewayConsumerGroupResource

GetAIGatewayConsumerGroupsByNamespace returns AI Gateway Consumer Group resources from the specified namespace.

func (*ResourceSet) GetAIGatewayConsumerGroupsForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumerGroupsForGateway(gatewayRef string) []AIGatewayConsumerGroupResource

GetAIGatewayConsumerGroupsForGateway returns all AI Gateway Consumer Groups for a given gateway ref.

func (*ResourceSet) GetAIGatewayConsumersByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumersByNamespace(namespace string) []AIGatewayConsumerResource

GetAIGatewayConsumersByNamespace returns AI Gateway Consumer resources from the specified namespace.

func (*ResourceSet) GetAIGatewayConsumersForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayConsumersForGateway(gatewayRef string) []AIGatewayConsumerResource

GetAIGatewayConsumersForGateway returns all AI Gateway Consumers for a given gateway ref.

func (*ResourceSet) GetAIGatewayDataPlaneCertificateByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayDataPlaneCertificateByRef(
	ref string,
) *AIGatewayDataPlaneCertificateResource

GetAIGatewayDataPlaneCertificateByRef returns an AI Gateway data plane certificate resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayDataPlaneCertificatesByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayDataPlaneCertificatesByNamespace(
	namespace string,
) []AIGatewayDataPlaneCertificateResource

GetAIGatewayDataPlaneCertificatesByNamespace returns AI Gateway data plane certificate resources from the specified namespace.

func (*ResourceSet) GetAIGatewayDataPlaneCertificatesForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayDataPlaneCertificatesForGateway(
	gatewayRef string,
) []AIGatewayDataPlaneCertificateResource

GetAIGatewayDataPlaneCertificatesForGateway returns all AI Gateway data plane certificates for a given gateway ref.

func (*ResourceSet) GetAIGatewayIdentityProviderByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayIdentityProviderByRef(ref string) *AIGatewayIdentityProviderResource

GetAIGatewayIdentityProviderByRef returns an AI Gateway Identity Provider resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayIdentityProvidersByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayIdentityProvidersByNamespace(
	namespace string,
) []AIGatewayIdentityProviderResource

GetAIGatewayIdentityProvidersByNamespace returns AI Gateway Identity Provider resources from the specified namespace.

func (*ResourceSet) GetAIGatewayIdentityProvidersForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayIdentityProvidersForGateway(
	gatewayRef string,
) []AIGatewayIdentityProviderResource

GetAIGatewayIdentityProvidersForGateway returns all identity providers for a given AI Gateway ref.

func (*ResourceSet) GetAIGatewayMCPServerByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayMCPServerByRef(ref string) *AIGatewayMCPServerResource

GetAIGatewayMCPServerByRef returns an AI Gateway MCP Server resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayMCPServersByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayMCPServersByNamespace(namespace string) []AIGatewayMCPServerResource

GetAIGatewayMCPServersByNamespace returns AI Gateway MCP Server resources from the specified namespace.

func (*ResourceSet) GetAIGatewayMCPServersForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayMCPServersForGateway(gatewayRef string) []AIGatewayMCPServerResource

GetAIGatewayMCPServersForGateway returns all AI Gateway MCP Servers for a given gateway ref.

func (*ResourceSet) GetAIGatewayModelByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayModelByRef(ref string) *AIGatewayModelResource

GetAIGatewayModelByRef returns an AI Gateway Model resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayModelsByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayModelsByNamespace(namespace string) []AIGatewayModelResource

GetAIGatewayModelsByNamespace returns AI Gateway model resources from the specified namespace.

func (*ResourceSet) GetAIGatewayModelsForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayModelsForGateway(gatewayRef string) []AIGatewayModelResource

GetAIGatewayModelsForGateway returns all AI Gateway Models for a given gateway ref.

func (*ResourceSet) GetAIGatewayPoliciesByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayPoliciesByNamespace(namespace string) []AIGatewayPolicyResource

GetAIGatewayPoliciesByNamespace returns AI Gateway policy resources from the specified namespace.

func (*ResourceSet) GetAIGatewayPoliciesForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayPoliciesForGateway(gatewayRef string) []AIGatewayPolicyResource

GetAIGatewayPoliciesForGateway returns all AI Gateway Policies for a given gateway ref.

func (*ResourceSet) GetAIGatewayPolicyByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayPolicyByRef(ref string) *AIGatewayPolicyResource

GetAIGatewayPolicyByRef returns an AI Gateway Policy resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayProviderByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayProviderByRef(ref string) *AIGatewayProviderResource

GetAIGatewayProviderByRef returns an AI Gateway Model Provider resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayProvidersByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayProvidersByNamespace(namespace string) []AIGatewayProviderResource

GetAIGatewayProvidersByNamespace returns all AI Gateway Model Provider resources from the specified namespace.

func (*ResourceSet) GetAIGatewayProvidersForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayProvidersForGateway(gatewayRef string) []AIGatewayProviderResource

GetAIGatewayProvidersForGateway returns all providers for a given AI Gateway ref.

func (*ResourceSet) GetAIGatewayVaultByRef added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayVaultByRef(ref string) *AIGatewayVaultResource

GetAIGatewayVaultByRef returns an AI Gateway Vault resource by its ref from any namespace.

func (*ResourceSet) GetAIGatewayVaultsByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayVaultsByNamespace(namespace string) []AIGatewayVaultResource

GetAIGatewayVaultsByNamespace returns AI Gateway Vault resources from the specified namespace.

func (*ResourceSet) GetAIGatewayVaultsForGateway added in v1.5.0 

func (rs *ResourceSet) GetAIGatewayVaultsForGateway(gatewayRef string) []AIGatewayVaultResource

GetAIGatewayVaultsForGateway returns all AI Gateway Vaults for a given gateway ref.

func (*ResourceSet) GetAIGatewaysByNamespace added in v1.5.0 

func (rs *ResourceSet) GetAIGatewaysByNamespace(namespace string) []AIGatewayResource

GetAIGatewaysByNamespace returns all AI Gateway resources from the specified namespace.

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) GetClusterPoliciesForVirtualCluster added in v0.8.0 

func (rs *ResourceSet) GetClusterPoliciesForVirtualCluster(
	virtualClusterRef string,
) []EventGatewayClusterPolicyResource

GetClusterPoliciesForVirtualCluster returns all cluster policies (nested + root-level) for a specific virtual cluster

func (*ResourceSet) GetConsumePoliciesForVirtualCluster added in v0.8.0 

func (rs *ResourceSet) GetConsumePoliciesForVirtualCluster(
	virtualClusterRef string,
) []EventGatewayConsumePolicyResource

GetConsumePoliciesForVirtualCluster returns all consume policies (nested + root-level) for a specific virtual cluster.

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) GetDCRProviderByRef added in v0.8.0 

func (rs *ResourceSet) GetDCRProviderByRef(ref string) *DCRProviderResource

GetDCRProviderByRef returns a DCR provider resource by its ref from any namespace

func (*ResourceSet) GetDCRProvidersByNamespace added in v0.8.0 

func (rs *ResourceSet) GetDCRProvidersByNamespace(namespace string) []DCRProviderResource

GetDCRProvidersByNamespace returns all DCR provider resources from the specified namespace

func (*ResourceSet) GetDashboardByRef added in v1.0.0 

func (rs *ResourceSet) GetDashboardByRef(ref string) *DashboardResource

GetDashboardByRef returns a dashboard resource by its ref from any namespace.

func (*ResourceSet) GetDashboardsByNamespace added in v1.0.0 

func (rs *ResourceSet) GetDashboardsByNamespace(namespace string) []DashboardResource

GetDashboardsByNamespace returns all dashboard resources from the specified namespace.

func (*ResourceSet) GetDataPlaneCertificatesForControlPlane added in v0.10.0 

func (rs *ResourceSet) GetDataPlaneCertificatesForControlPlane(
	controlPlaneRef string,
) []ControlPlaneDataPlaneCertificateResource

GetDataPlaneCertificatesForControlPlane returns all data plane certificates (nested + root-level) for a specific control plane.

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) GetEnvSources added in v0.8.0 

func (rs *ResourceSet) GetEnvSources(resourceRef string) map[string]string

GetEnvSources returns deferred !env placeholders for a resource ref.

func (*ResourceSet) GetEventGatewayControlPlaneByRef added in v1.4.1 

func (rs *ResourceSet) GetEventGatewayControlPlaneByRef(ref string) *EventGatewayControlPlaneResource

GetEventGatewayControlPlaneByRef returns an Event Gateway resource by its ref from any namespace.

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) GetOrganizationSystemAccountRolesByNamespace added in v1.0.0 

func (rs *ResourceSet) GetOrganizationSystemAccountRolesByNamespace(
	namespace string,
) []OrganizationSystemAccountRoleResource

GetOrganizationSystemAccountRolesByNamespace returns all system account role resources in a namespace.

func (*ResourceSet) GetOrganizationSystemAccountTeamMembershipsByNamespace added in v1.0.0 

func (rs *ResourceSet) GetOrganizationSystemAccountTeamMembershipsByNamespace(
	namespace string,
) []OrganizationSystemAccountTeamMembershipResource

GetOrganizationSystemAccountTeamMembershipsByNamespace returns all system account team memberships in a namespace.

func (*ResourceSet) GetOrganizationTeamRolesByNamespace added in v1.0.0 

func (rs *ResourceSet) GetOrganizationTeamRolesByNamespace(namespace string) []OrganizationTeamRoleResource

GetOrganizationTeamRolesByNamespace returns all organization_team_role resources from the specified namespace.

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) GetOrganizationUserRolesByNamespace added in v1.0.0 

func (rs *ResourceSet) GetOrganizationUserRolesByNamespace(namespace string) []OrganizationUserRoleResource

GetOrganizationUserRolesByNamespace returns all user role resources in a namespace.

func (*ResourceSet) GetOrganizationUserTeamMembershipsByNamespace added in v1.0.0 

func (rs *ResourceSet) GetOrganizationUserTeamMembershipsByNamespace(
	namespace string,
) []OrganizationUserTeamMembershipResource

GetOrganizationUserTeamMembershipsByNamespace returns all user team membership resources in a 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) GetPortalAuditLogWebhooksByNamespace added in v0.10.0 

func (rs *ResourceSet) GetPortalAuditLogWebhooksByNamespace(namespace string) []PortalAuditLogWebhookResource

GetPortalAuditLogWebhooksByNamespace returns all portal audit-log webhook resources from the specified namespace

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) GetPortalIPAllowListsByNamespace added in v0.10.0 

func (rs *ResourceSet) GetPortalIPAllowListsByNamespace(namespace string) []PortalIPAllowListResource

GetPortalIPAllowListsByNamespace returns all portal IP allow-list resources from the specified namespace.

func (*ResourceSet) GetPortalIdentityProvidersByNamespace added in v0.9.0 

func (rs *ResourceSet) GetPortalIdentityProvidersByNamespace(namespace string) []PortalIdentityProviderResource

GetPortalIdentityProvidersByNamespace returns all portal identity provider resources from the specified namespace

func (*ResourceSet) GetPortalIntegrationsByNamespace added in v0.10.0 

func (rs *ResourceSet) GetPortalIntegrationsByNamespace(namespace string) []PortalIntegrationResource

GetPortalIntegrationsByNamespace returns all portal integration 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) GetPortalTeamGroupMappingsByNamespace added in v1.0.0 

func (rs *ResourceSet) GetPortalTeamGroupMappingsByNamespace(namespace string) []PortalTeamGroupMappingResource

GetPortalTeamGroupMappingsByNamespace returns portal team group mappings 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) GetProducePoliciesForVirtualCluster added in v0.8.0 

func (rs *ResourceSet) GetProducePoliciesForVirtualCluster(
	virtualClusterRef string,
) []EventGatewayProducePolicyResource

GetProducePoliciesForVirtualCluster returns all produce policies (nested + root-level) for a specific virtual cluster

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) GetSchemaRegistriesForGateway added in v0.8.0 

func (rs *ResourceSet) GetSchemaRegistriesForGateway(
	gatewayRef string,
) []EventGatewaySchemaRegistryResource

GetSchemaRegistriesForGateway returns all schema registries (nested + root-level) for a specific event gateway

func (*ResourceSet) GetStaticKeysForGateway added in v0.8.0 

func (rs *ResourceSet) GetStaticKeysForGateway(
	gatewayRef string,
) []EventGatewayStaticKeyResource

GetStaticKeysForGateway returns all static keys (nested + root-level) for a specific event gateway

func (*ResourceSet) GetTrustBundlesForGateway added in v0.8.0 

func (rs *ResourceSet) GetTrustBundlesForGateway(
	gatewayRef string,
) []EventGatewayTLSTrustBundleResource

GetTrustBundlesForGateway returns all TLS trust bundles (nested + root-level) for a specific event gateway

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) HasEnvSources added in v0.8.0 

func (rs *ResourceSet) HasEnvSources() bool

HasEnvSources returns true when any deferred !env placeholders were recorded.

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) MergeEnvSources added in v0.8.0 

func (rs *ResourceSet) MergeEnvSources(other *ResourceSet)

MergeEnvSources copies deferred !env placeholders from another ResourceSet.

func (*ResourceSet) MergeSyncScope added in v1.0.0 

func (rs *ResourceSet) MergeSyncScope(other *ResourceSet)

MergeSyncScope merges sync scope from another ResourceSet.

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"
	ResourceTypeDCRProvider                             ResourceType = "dcr_provider"
	ResourceTypeControlPlane                            ResourceType = "control_plane"
	ResourceTypeControlPlaneGroup                       ResourceType = "control_plane_group"
	ResourceTypeAPI                                     ResourceType = "api"
	ResourceTypeAIGateway                               ResourceType = "ai_gateway"
	ResourceTypeAIGatewayProvider                       ResourceType = "ai_gateway_model_provider"
	ResourceTypeAIGatewayIdentityProvider               ResourceType = "ai_gateway_identity_provider"
	ResourceTypeAIGatewayPolicy                         ResourceType = "ai_gateway_policy"
	ResourceTypeAIGatewayAgent                          ResourceType = "ai_gateway_agent"
	ResourceTypeAIGatewayConsumer                       ResourceType = "ai_gateway_consumer"
	ResourceTypeAIGatewayConsumerCredential             ResourceType = "ai_gateway_consumer_credential"
	ResourceTypeAIGatewayConsumerGroup                  ResourceType = "ai_gateway_consumer_group"
	ResourceTypeAIGatewayModel                          ResourceType = "ai_gateway_model"
	ResourceTypeAIGatewayMCPServer                      ResourceType = "ai_gateway_mcp_server"
	ResourceTypeAIGatewayVault                          ResourceType = "ai_gateway_vault"
	ResourceTypeAIGatewayDataPlaneCertificate           ResourceType = "ai_gateway_data_plane_certificate"
	ResourceTypeDashboard                               ResourceType = "dashboard"
	ResourceTypeAPIVersion                              ResourceType = "api_version"
	ResourceTypeAPIPublication                          ResourceType = "api_publication"
	ResourceTypeAPIImplementation                       ResourceType = "api_implementation"
	ResourceTypeAPIDocument                             ResourceType = "api_document"
	ResourceTypeGatewayService                          ResourceType = "gateway_service"
	ResourceTypeControlPlaneDataPlaneCertificate        ResourceType = "control_plane_data_plane_certificate"
	ResourceTypePortalCustomization                     ResourceType = "portal_customization"
	ResourceTypePortalCustomDomain                      ResourceType = "portal_custom_domain"
	ResourceTypePortalAuthSettings                      ResourceType = "portal_auth_settings"
	ResourceTypePortalIPAllowList                       ResourceType = "portal_ip_allow_list"
	ResourceTypePortalIntegration                       ResourceType = "portal_integration"
	ResourceTypePortalIdentityProvider                  ResourceType = "portal_identity_provider"
	ResourceTypePortalTeamGroupMapping                  ResourceType = "portal_team_group_mapping"
	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"
	ResourceTypePortalAuditLogWebhook                   ResourceType = "portal_audit_log_webhook"
	ResourceTypeAuditLogWebhookDestination              ResourceType = "audit_log_webhook_destination"
	ResourceTypeCatalogService                          ResourceType = "catalog_service"
	ResourceTypeEventGatewayControlPlane                ResourceType = "event_gateway"
	ResourceTypeEventGatewayBackendCluster              ResourceType = "event_gateway_backend_cluster"
	ResourceTypeEventGatewayVirtualCluster              ResourceType = "event_gateway_virtual_cluster"
	ResourceTypeOrganizationTeam                        ResourceType = "organization_team"
	ResourceTypeOrganizationTeamRole                    ResourceType = "organization_team_role"
	ResourceTypeOrganizationUser                        ResourceType = "organization_user"
	ResourceTypeOrganizationUserTeamMembership          ResourceType = "organization_user_team_membership"
	ResourceTypeOrganizationUserRole                    ResourceType = "organization_user_role"
	ResourceTypeOrganizationSystemAccount               ResourceType = "organization_system_account"
	ResourceTypeOrganizationSystemAccountTeamMembership ResourceType = "organization_system_account_team_membership"
	ResourceTypeOrganizationSystemAccountRole           ResourceType = "organization_system_account_role"
	ResourceTypeTeam                                    ResourceType = "team"
	ResourceTypeEventGatewayListener                    ResourceType = "event_gateway_listener"
	ResourceTypeEventGatewayListenerPolicy              ResourceType = "event_gateway_listener_policy"
	ResourceTypeEventGatewayDataPlaneCertificate        ResourceType = "event_gateway_data_plane_certificate"
	ResourceTypeEventGatewayClusterPolicy               ResourceType = "event_gateway_virtual_cluster_cluster_policy"
	ResourceTypeEventGatewayProducePolicy               ResourceType = "event_gateway_virtual_cluster_produce_policy"
	ResourceTypeEventGatewayConsumePolicy               ResourceType = "event_gateway_virtual_cluster_consume_policy"
	ResourceTypeEventGatewaySchemaRegistry              ResourceType = "event_gateway_schema_registry"
	ResourceTypeEventGatewayStaticKey                   ResourceType = "event_gateway_static_key"
	ResourceTypeEventGatewayTLSTrustBundle              ResourceType = "event_gateway_tls_trust_bundle"
)

Resource type constants

func RegisteredTypes added in v0.5.0 

func RegisteredTypes() []ResourceType

RegisteredTypes returns all registered resource types.

func RoleEntityResourceType added in v1.1.0 

func RoleEntityResourceType(entityTypeName string) (ResourceType, bool)

RoleEntityResourceType maps Konnect role entity_type_name values to the declarative resource type that can supply the referenced entity_id.

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

type SyncScope added in v1.0.0 

type SyncScope struct {
	RootResourceTypes                map[ResourceType]struct{}
	ChildResourceTypes               map[ResourceType]map[string]map[ResourceType]struct{}
	RootChildResourceTypes           map[ResourceType]struct{}
	OrganizationUsersScoped          bool
	OrganizationSystemAccountsScoped bool
}

SyncScope records the resource collections that were explicitly present in declarative input. Sync planning uses this to distinguish omitted collections from collections intentionally set to zero desired resources.

func NewSyncScope added in v1.0.0 

func NewSyncScope() *SyncScope

NewSyncScope creates an empty sync scope.

func (*SyncScope) AddChild added in v1.0.0 

func (s *SyncScope) AddChild(parentType ResourceType, parentRef string, rt ResourceType)

AddChild marks a child resource collection as in scope for one parent ref.

func (*SyncScope) AddRoot added in v1.0.0 

func (s *SyncScope) AddRoot(rt ResourceType)

AddRoot marks a top-level resource collection as in scope.

func (*SyncScope) AddRootChildCollection added in v1.0.0 

func (s *SyncScope) AddRootChildCollection(rt ResourceType)

AddRootChildCollection records an explicit root-level empty child collection. This cannot express a parent and is rejected by sync planning with guidance.

func (*SyncScope) ChildInScope added in v1.0.0 

func (s *SyncScope) ChildInScope(parentType ResourceType, parentRef string, rt ResourceType) bool

ChildInScope reports whether a child resource collection is in scope for a parent ref.

func (*SyncScope) ChildScopes added in v1.0.0 

func (s *SyncScope) ChildScopes() []ChildSyncScope

ChildScopes returns sorted child collection scopes.

func (*SyncScope) HasAny added in v1.0.0 

func (s *SyncScope) HasAny() bool

HasAny reports whether any scope was recorded.

func (*SyncScope) MarkOrganizationSystemAccountsScoped added in v1.0.0 

func (s *SyncScope) MarkOrganizationSystemAccountsScoped()

MarkOrganizationSystemAccountsScoped records that organization.system-accounts was present.

func (*SyncScope) MarkOrganizationUsersScoped added in v1.0.0 

func (s *SyncScope) MarkOrganizationUsersScoped()

MarkOrganizationUsersScoped records that organization.users was present.

func (*SyncScope) Merge added in v1.0.0 

func (s *SyncScope) Merge(other *SyncScope)

Merge copies another scope into this one.

func (*SyncScope) OrganizationSystemAccountsInScope added in v1.0.0 

func (s *SyncScope) OrganizationSystemAccountsInScope() bool

OrganizationSystemAccountsInScope reports whether organization.system-accounts was present.

func (*SyncScope) OrganizationUsersInScope added in v1.0.0 

func (s *SyncScope) OrganizationUsersInScope() bool

OrganizationUsersInScope reports whether organization.users was present.

func (*SyncScope) RootChildCollectionTypes added in v1.0.0 

func (s *SyncScope) RootChildCollectionTypes() []ResourceType

RootChildCollectionTypes returns root-level child collection types with no parent scope.

func (*SyncScope) RootInScope added in v1.0.0 

func (s *SyncScope) RootInScope(rt ResourceType) bool

RootInScope reports whether a top-level resource collection is in scope.

func (*SyncScope) RootTypes added in v1.0.0 

func (s *SyncScope) RootTypes() []ResourceType

RootTypes returns sorted root resource types.

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.