Nnrf_NFManagement

Documentation

Index

• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
  • func (c *Configuration) BasePath() string
  • func (c *Configuration) DefaultHeader() map[string]string
  • func (c *Configuration) HTTPClient() *http.Client
  • func (c *Configuration) Host() string
  • func (c *Configuration) SetBasePath(apiRoot string)
  • func (c *Configuration) SetBasePathNoGroup(basePath string)
  • func (c *Configuration) SetHost(host string)
  • func (c *Configuration) SetUserAgent(userAgent string)
  • func (c *Configuration) UserAgent() string
• type GetNFInstancesParamOpts
• type NFInstanceIDDocumentApiService
  • func (a *NFInstanceIDDocumentApiService) DeregisterNFInstance(ctx context.Context, nfInstanceID string) (*http.Response, error)
  • func (a *NFInstanceIDDocumentApiService) GetNFInstance(ctx context.Context, nfInstanceID string) (models.NfProfile, *http.Response, error)
  • func (a *NFInstanceIDDocumentApiService) RegisterNFInstance(ctx context.Context, nfInstanceID string, nfProfile models.NfProfile) (models.NfProfile, *http.Response, error)
  • func (a *NFInstanceIDDocumentApiService) UpdateNFInstance(ctx context.Context, nfInstanceID string, patchItem []models.PatchItem) (models.NfProfile, *http.Response, error)
• type NFInstancesStoreApiService
  • func (a *NFInstancesStoreApiService) GetNFInstances(ctx context.Context, localVarOptionals *GetNFInstancesParamOpts) (map[string]interface{}, *http.Response, error)
• type NotificationApiService
  • func (a *NotificationApiService) NotificationPost(ctx context.Context, nrfNotificationData NotificationData) (*http.Response, error)
• type SubscriptionIDDocumentApiService
  • func (a *SubscriptionIDDocumentApiService) RemoveSubscription(ctx context.Context, subscriptionID string) (*http.Response, error)
  • func (a *SubscriptionIDDocumentApiService) UpdateSubscription(ctx context.Context, subscriptionID string, patchItem []models.PatchItem) (models.NrfSubscriptionData, *http.Response, error)
• type SubscriptionsCollectionApiService
  • func (a *SubscriptionsCollectionApiService) CreateSubscription(ctx context.Context, subscriptionData models.NrfSubscriptionData) (models.NrfSubscriptionData, *http.Response, error)

Types

type APIClient

type APIClient struct {

	// API Services
	NFInstanceIDDocumentApi    *NFInstanceIDDocumentApiService
	NFInstancesStoreApi        *NFInstancesStoreApiService
	SubscriptionIDDocumentApi  *SubscriptionIDDocumentApiService
	SubscriptionsCollectionApi *SubscriptionsCollectionApiService
	NotificationApi            *NotificationApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the NRF NFManagement Service API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

type Configuration

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

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

func (*Configuration) BasePath

func (c *Configuration) BasePath() string

func (*Configuration) DefaultHeader

func (c *Configuration) DefaultHeader() map[string]string

func (*Configuration) HTTPClient

func (c *Configuration) HTTPClient() *http.Client

func (*Configuration) Host

func (c *Configuration) Host() string

func (*Configuration) SetBasePath

func (c *Configuration) SetBasePath(apiRoot string)

func (*Configuration) SetBasePathNoGroup

func (c *Configuration) SetBasePathNoGroup(basePath string)

func (*Configuration) SetHost

func (c *Configuration) SetHost(host string)

func (*Configuration) SetUserAgent

func (c *Configuration) SetUserAgent(userAgent string)

func (*Configuration) UserAgent

func (c *Configuration) UserAgent() string

type GetNFInstancesParamOpts

type GetNFInstancesParamOpts struct {
	NfType optional.Interface
	Limit  optional.Int32
}

type NFInstanceIDDocumentApiService

type NFInstanceIDDocumentApiService service

func (*NFInstanceIDDocumentApiService) DeregisterNFInstance

func (a *NFInstanceIDDocumentApiService) DeregisterNFInstance(ctx context.Context, nfInstanceID string) (*http.Response, error)

func (*NFInstanceIDDocumentApiService) GetNFInstance

func (a *NFInstanceIDDocumentApiService) GetNFInstance(ctx context.Context, nfInstanceID string) (models.NfProfile, *http.Response, error)

func (*NFInstanceIDDocumentApiService) RegisterNFInstance

func (a *NFInstanceIDDocumentApiService) RegisterNFInstance(ctx context.Context, nfInstanceID string, nfProfile models.NfProfile) (models.NfProfile, *http.Response, error)

func (*NFInstanceIDDocumentApiService) UpdateNFInstance

func (a *NFInstanceIDDocumentApiService) UpdateNFInstance(ctx context.Context, nfInstanceID string, patchItem []models.PatchItem) (models.NfProfile, *http.Response, error)

type NFInstancesStoreApiService

type NFInstancesStoreApiService service

func (*NFInstancesStoreApiService) GetNFInstances

func (a *NFInstancesStoreApiService) GetNFInstances(ctx context.Context, localVarOptionals *GetNFInstancesParamOpts) (map[string]interface{}, *http.Response, error)

type NotificationApiService

type NotificationApiService service

func (*NotificationApiService) NotificationPost

func (a *NotificationApiService) NotificationPost(ctx context.Context, nrfNotificationData NotificationData) (*http.Response, error)

type SubscriptionIDDocumentApiService

type SubscriptionIDDocumentApiService service

func (*SubscriptionIDDocumentApiService) RemoveSubscription

func (a *SubscriptionIDDocumentApiService) RemoveSubscription(ctx context.Context, subscriptionID string) (*http.Response, error)

func (*SubscriptionIDDocumentApiService) UpdateSubscription

func (a *SubscriptionIDDocumentApiService) UpdateSubscription(ctx context.Context, subscriptionID string, patchItem []models.PatchItem) (models.NrfSubscriptionData, *http.Response, error)

type SubscriptionsCollectionApiService

type SubscriptionsCollectionApiService service

func (*SubscriptionsCollectionApiService) CreateSubscription

func (a *SubscriptionsCollectionApiService) CreateSubscription(ctx context.Context, subscriptionData models.NrfSubscriptionData) (models.NrfSubscriptionData, *http.Response, error)