sdk

Documentation

Index

• type CACertificatesSDK
• type CertificatesSDK
• type ConsumerGroupSDK
• type ConsumersSDK
• type ControlPlaneGroupSDK
• type ControlPlaneSDK
• type DataPlaneClientCertificatesSDK
• type KeySetsSDK
• type KeysSDK
• type KongCredentialACLSDK
• type KongCredentialAPIKeySDK
• type KongCredentialBasicAuthSDK
• type KongCredentialHMACSDK
• type KongCredentialJWTSDK
• type MeSDK
• type PluginSDK
• type RoutesSDK
• type SDKFactory
  • func NewSDKFactory() SDKFactory
• type SDKToken
• type SDKWrapper
• type SNIsSDK
• type ServicesSDK
• type TargetsSDK
• type UpstreamsSDK
• type VaultSDK

Types

type CACertificatesSDK

type CACertificatesSDK interface {
	CreateCaCertificate(ctx context.Context, controlPlaneID string, caCertificate sdkkonnectcomp.CACertificateInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateCaCertificateResponse, error)
	UpsertCaCertificate(ctx context.Context, request sdkkonnectops.UpsertCaCertificateRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertCaCertificateResponse, error)
	DeleteCaCertificate(ctx context.Context, controlPlaneID string, caCertificateID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteCaCertificateResponse, error)
	ListCaCertificate(ctx context.Context, request sdkkonnectops.ListCaCertificateRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListCaCertificateResponse, error)
}

CACertificatesSDK is the interface for the CACertificatesSDK.

type CertificatesSDK

type CertificatesSDK interface {
	CreateCertificate(ctx context.Context, controlPlaneID string, certificate sdkkonnectcomp.CertificateInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateCertificateResponse, error)
	UpsertCertificate(ctx context.Context, request sdkkonnectops.UpsertCertificateRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertCertificateResponse, error)
	DeleteCertificate(ctx context.Context, controlPlaneID string, certificateID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteCertificateResponse, error)
	ListCertificate(ctx context.Context, request sdkkonnectops.ListCertificateRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListCertificateResponse, error)
}

CertificatesSDK is the interface for the CertificatesSDK.

type ConsumerGroupSDK

type ConsumerGroupSDK interface {
	CreateConsumerGroup(ctx context.Context, controlPlaneID string, consumerInput sdkkonnectcomp.ConsumerGroupInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateConsumerGroupResponse, error)
	UpsertConsumerGroup(ctx context.Context, upsertConsumerRequest sdkkonnectops.UpsertConsumerGroupRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertConsumerGroupResponse, error)
	DeleteConsumerGroup(ctx context.Context, controlPlaneID string, consumerID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteConsumerGroupResponse, error)
	AddConsumerToGroup(ctx context.Context, request sdkkonnectops.AddConsumerToGroupRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.AddConsumerToGroupResponse, error)
	RemoveConsumerFromGroup(ctx context.Context, request sdkkonnectops.RemoveConsumerFromGroupRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.RemoveConsumerFromGroupResponse, error)
	ListConsumerGroupsForConsumer(ctx context.Context, request sdkkonnectops.ListConsumerGroupsForConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListConsumerGroupsForConsumerResponse, error)
	ListConsumerGroup(ctx context.Context, request sdkkonnectops.ListConsumerGroupRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListConsumerGroupResponse, error)
}

ConsumerGroupSDK is the interface for the Konnect ConsumerGroups SDK.

type ConsumersSDK

type ConsumersSDK interface {
	CreateConsumer(ctx context.Context, controlPlaneID string, consumerInput sdkkonnectcomp.ConsumerInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateConsumerResponse, error)
	UpsertConsumer(ctx context.Context, upsertConsumerRequest sdkkonnectops.UpsertConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertConsumerResponse, error)
	DeleteConsumer(ctx context.Context, controlPlaneID string, consumerID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteConsumerResponse, error)
	ListConsumer(ctx context.Context, request sdkkonnectops.ListConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListConsumerResponse, error)
}

ConsumersSDK is the interface for the Konnect Consumers SDK.

type ControlPlaneGroupSDK

type ControlPlaneGroupSDK interface {
	PutControlPlanesIDGroupMemberships(ctx context.Context, id string, groupMembership *sdkkonnectcomp.GroupMembership, opts ...sdkkonnectops.Option) (*sdkkonnectops.PutControlPlanesIDGroupMembershipsResponse, error)
}

ControlPlaneGroupSDK is the interface for the Konnect ControlPlaneGroupSDK SDK.

type ControlPlaneSDK

type ControlPlaneSDK interface {
	CreateControlPlane(ctx context.Context, req sdkkonnectcomp.CreateControlPlaneRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateControlPlaneResponse, error)
	DeleteControlPlane(ctx context.Context, id string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteControlPlaneResponse, error)
	UpdateControlPlane(ctx context.Context, id string, req sdkkonnectcomp.UpdateControlPlaneRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpdateControlPlaneResponse, error)
	ListControlPlanes(ctx context.Context, request sdkkonnectops.ListControlPlanesRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListControlPlanesResponse, error)
}

ControlPlaneSDK is the interface for the Konnect ControlPlane SDK.

type DataPlaneClientCertificatesSDK

type DataPlaneClientCertificatesSDK interface {
	CreateDataplaneCertificate(ctx context.Context, cpID string, dpReq *sdkkonnectcomp.DataPlaneClientCertificateRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateDataplaneCertificateResponse, error)
	DeleteDataplaneCertificate(ctx context.Context, controlPlaneID string, certificateID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteDataplaneCertificateResponse, error)
}

DataPlaneClientCertificatesSDK is the interface for the DataPlaneClientCertificatesSDK.

type KeySetsSDK

type KeySetsSDK interface {
	CreateKeySet(ctx context.Context, controlPlaneID string, keySet sdkkonnectcomp.KeySetInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateKeySetResponse, error)
	UpsertKeySet(ctx context.Context, request sdkkonnectops.UpsertKeySetRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertKeySetResponse, error)
	DeleteKeySet(ctx context.Context, controlPlaneID string, keySetID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteKeySetResponse, error)
	ListKeySet(ctx context.Context, request sdkkonnectops.ListKeySetRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListKeySetResponse, error)
}

KeySetsSDK is the interface for the KeySetsSDK.

type KeysSDK

type KeysSDK interface {
	CreateKey(ctx context.Context, controlPlaneID string, Key sdkkonnectcomp.KeyInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateKeyResponse, error)
	UpsertKey(ctx context.Context, request sdkkonnectops.UpsertKeyRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertKeyResponse, error)
	DeleteKey(ctx context.Context, controlPlaneID string, KeyID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteKeyResponse, error)
	ListKey(ctx context.Context, request sdkkonnectops.ListKeyRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListKeyResponse, error)
}

KeysSDK is the interface for the KeysSDK.

type KongCredentialACLSDK

type KongCredentialACLSDK interface {
	CreateACLWithConsumer(ctx context.Context, req sdkkonnectops.CreateACLWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateACLWithConsumerResponse, error)
	DeleteACLWithConsumer(ctx context.Context, request sdkkonnectops.DeleteACLWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteACLWithConsumerResponse, error)
	UpsertACLWithConsumer(ctx context.Context, request sdkkonnectops.UpsertACLWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertACLWithConsumerResponse, error)
	ListACL(ctx context.Context, request sdkkonnectops.ListACLRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListACLResponse, error)
}

KongCredentialACLSDK is the interface for the Konnect KongCredentialACLSDK.

type KongCredentialAPIKeySDK

type KongCredentialAPIKeySDK interface {
	CreateKeyAuthWithConsumer(ctx context.Context, req sdkkonnectops.CreateKeyAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateKeyAuthWithConsumerResponse, error)
	DeleteKeyAuthWithConsumer(ctx context.Context, request sdkkonnectops.DeleteKeyAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteKeyAuthWithConsumerResponse, error)
	UpsertKeyAuthWithConsumer(ctx context.Context, request sdkkonnectops.UpsertKeyAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertKeyAuthWithConsumerResponse, error)
	ListKeyAuth(ctx context.Context, request sdkkonnectops.ListKeyAuthRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListKeyAuthResponse, error)
}

KongCredentialAPIKeySDK is the interface for the Konnect KongCredentialAPIKeySDK.

type KongCredentialBasicAuthSDK

type KongCredentialBasicAuthSDK interface {
	CreateBasicAuthWithConsumer(ctx context.Context, req sdkkonnectops.CreateBasicAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateBasicAuthWithConsumerResponse, error)
	DeleteBasicAuthWithConsumer(ctx context.Context, request sdkkonnectops.DeleteBasicAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteBasicAuthWithConsumerResponse, error)
	UpsertBasicAuthWithConsumer(ctx context.Context, request sdkkonnectops.UpsertBasicAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertBasicAuthWithConsumerResponse, error)
	ListBasicAuth(ctx context.Context, request sdkkonnectops.ListBasicAuthRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListBasicAuthResponse, error)
}

KongCredentialBasicAuthSDK is the interface for the Konnect KongCredentialBasicAuthSDK.

type KongCredentialHMACSDK

type KongCredentialHMACSDK interface {
	CreateHmacAuthWithConsumer(ctx context.Context, req sdkkonnectops.CreateHmacAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateHmacAuthWithConsumerResponse, error)
	DeleteHmacAuthWithConsumer(ctx context.Context, request sdkkonnectops.DeleteHmacAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteHmacAuthWithConsumerResponse, error)
	UpsertHmacAuthWithConsumer(ctx context.Context, request sdkkonnectops.UpsertHmacAuthWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertHmacAuthWithConsumerResponse, error)
	ListHmacAuth(ctx context.Context, request sdkkonnectops.ListHmacAuthRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListHmacAuthResponse, error)
}

KongCredentialHMACSDK is the interface for the Konnect KongCredentialHMACSDK.

type KongCredentialJWTSDK

type KongCredentialJWTSDK interface {
	CreateJwtWithConsumer(ctx context.Context, req sdkkonnectops.CreateJwtWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateJwtWithConsumerResponse, error)
	DeleteJwtWithConsumer(ctx context.Context, request sdkkonnectops.DeleteJwtWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteJwtWithConsumerResponse, error)
	UpsertJwtWithConsumer(ctx context.Context, request sdkkonnectops.UpsertJwtWithConsumerRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertJwtWithConsumerResponse, error)
	ListJwt(ctx context.Context, request sdkkonnectops.ListJwtRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListJwtResponse, error)
}

KongCredentialJWTSDK is the interface for the Konnect KongCredentialJWTSDK.

type MeSDK

type MeSDK interface {
	GetOrganizationsMe(ctx context.Context, opts ...sdkkonnectops.Option) (*sdkkonnectops.GetOrganizationsMeResponse, error)
}

MeSDK is the interface for Konnect "Me" SDK to get current organization.

type PluginSDK

type PluginSDK interface {
	CreatePlugin(ctx context.Context, controlPlaneID string, plugin sdkkonnectcomp.PluginInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreatePluginResponse, error)
	UpsertPlugin(ctx context.Context, request sdkkonnectops.UpsertPluginRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertPluginResponse, error)
	DeletePlugin(ctx context.Context, controlPlaneID string, pluginID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeletePluginResponse, error)
	ListPlugin(ctx context.Context, request sdkkonnectops.ListPluginRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListPluginResponse, error)
}

PluginSDK is the interface for Konnect plugin SDK.

type RoutesSDK

type RoutesSDK interface {
	CreateRoute(ctx context.Context, controlPlaneID string, route sdkkonnectcomp.RouteInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateRouteResponse, error)
	UpsertRoute(ctx context.Context, req sdkkonnectops.UpsertRouteRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertRouteResponse, error)
	DeleteRoute(ctx context.Context, controlPlaneID, routeID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteRouteResponse, error)
	ListRoute(ctx context.Context, request sdkkonnectops.ListRouteRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListRouteResponse, error)
}

RoutesSDK is the interface for the Konnect Routes SDK.

type SDKFactory

type SDKFactory interface {
	NewKonnectSDK(serverURL string, token SDKToken) SDKWrapper
}

SDKFactory is a factory for creating Konnect SDKs.

func NewSDKFactory

func NewSDKFactory() SDKFactory

NewSDKFactory creates a new SDKFactory.

type SDKToken

type SDKToken string

SDKToken is a token used to authenticate with the Konnect SDK.

type SDKWrapper

type SDKWrapper interface {
	GetControlPlaneSDK() ControlPlaneSDK
	GetControlPlaneGroupSDK() ControlPlaneGroupSDK
	GetServicesSDK() ServicesSDK
	GetRoutesSDK() RoutesSDK
	GetConsumersSDK() ConsumersSDK
	GetConsumerGroupsSDK() ConsumerGroupSDK
	GetPluginSDK() PluginSDK
	GetUpstreamsSDK() UpstreamsSDK
	GetTargetsSDK() TargetsSDK
	GetVaultSDK() VaultSDK
	GetMeSDK() MeSDK
	GetBasicAuthCredentialsSDK() KongCredentialBasicAuthSDK
	GetAPIKeyCredentialsSDK() KongCredentialAPIKeySDK
	GetACLCredentialsSDK() KongCredentialACLSDK
	GetJWTCredentialsSDK() KongCredentialJWTSDK
	GetHMACCredentialsSDK() KongCredentialHMACSDK
	GetCACertificatesSDK() CACertificatesSDK
	GetCertificatesSDK() CertificatesSDK
	GetKeysSDK() KeysSDK
	GetKeySetsSDK() KeySetsSDK
	GetSNIsSDK() SNIsSDK
	GetDataPlaneCertificatesSDK() DataPlaneClientCertificatesSDK
}

SDKWrapper is a wrapper of Konnect SDK to allow using mock SDKs in tests.

type SNIsSDK

type SNIsSDK interface {
	CreateSniWithCertificate(context.Context, sdkkonnectops.CreateSniWithCertificateRequest, ...sdkkonnectops.Option) (*sdkkonnectops.CreateSniWithCertificateResponse, error)
	UpsertSniWithCertificate(ctx context.Context, request sdkkonnectops.UpsertSniWithCertificateRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertSniWithCertificateResponse, error)
	DeleteSniWithCertificate(ctx context.Context, request sdkkonnectops.DeleteSniWithCertificateRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteSniWithCertificateResponse, error)
	ListSni(ctx context.Context, request sdkkonnectops.ListSniRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListSniResponse, error)
}

SNIsSDK is the interface to operate Kong SNIs.

type ServicesSDK

type ServicesSDK interface {
	CreateService(ctx context.Context, controlPlaneID string, service sdkkonnectcomp.ServiceInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateServiceResponse, error)
	UpsertService(ctx context.Context, req sdkkonnectops.UpsertServiceRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertServiceResponse, error)
	DeleteService(ctx context.Context, controlPlaneID, serviceID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteServiceResponse, error)
	ListService(ctx context.Context, request sdkkonnectops.ListServiceRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListServiceResponse, error)
}

ServicesSDK is the interface for the Konnect Service SDK.

type TargetsSDK

type TargetsSDK interface {
	CreateTargetWithUpstream(ctx context.Context, req sdkkonnectops.CreateTargetWithUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateTargetWithUpstreamResponse, error)
	UpsertTargetWithUpstream(ctx context.Context, req sdkkonnectops.UpsertTargetWithUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertTargetWithUpstreamResponse, error)
	DeleteTargetWithUpstream(ctx context.Context, req sdkkonnectops.DeleteTargetWithUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteTargetWithUpstreamResponse, error)
	ListTargetWithUpstream(ctx context.Context, request sdkkonnectops.ListTargetWithUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListTargetWithUpstreamResponse, error)
}

TargetsSDK is the interface for the Konnect Taret SDK.

type UpstreamsSDK

type UpstreamsSDK interface {
	CreateUpstream(ctx context.Context, controlPlaneID string, upstream sdkkonnectcomp.UpstreamInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateUpstreamResponse, error)
	UpsertUpstream(ctx context.Context, req sdkkonnectops.UpsertUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertUpstreamResponse, error)
	DeleteUpstream(ctx context.Context, controlPlaneID, upstreamID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteUpstreamResponse, error)
	ListUpstream(ctx context.Context, request sdkkonnectops.ListUpstreamRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListUpstreamResponse, error)
}

UpstreamsSDK is the interface for the Konnect Upstream SDK.

type VaultSDK

type VaultSDK interface {
	CreateVault(ctx context.Context, controlPlaneID string, vault sdkkonnectcomp.VaultInput, opts ...sdkkonnectops.Option) (*sdkkonnectops.CreateVaultResponse, error)
	UpsertVault(ctx context.Context, request sdkkonnectops.UpsertVaultRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.UpsertVaultResponse, error)
	DeleteVault(ctx context.Context, controlPlaneID string, vaultID string, opts ...sdkkonnectops.Option) (*sdkkonnectops.DeleteVaultResponse, error)
	ListVault(ctx context.Context, request sdkkonnectops.ListVaultRequest, opts ...sdkkonnectops.Option) (*sdkkonnectops.ListVaultResponse, error)
}

VaultSDK is the interface for Konnect Vault SDK.