client

package module
v0.0.0-...-8f6edbe Latest Latest
Warning

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

Go to latest
Published: May 30, 2023 License: Apache-2.0 Imports: 20 Imported by: 2

README

Go API client for client

MEC Application Support Service is AdvantEDGE's implementation of ETSI MEC ISG MEC011 Application Enablement API

Copyright (c) ETSI 2017

Micro-service
meep-app-enablement

Type & Usage
Edge Service used by edge applications that want to get information about applications in the network

Note
AdvantEDGE supports a selected subset of Application Support API endpoints (see below).

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.2.1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./client"

Documentation for API Endpoints

All URIs are relative to https://localhost/sandboxname/mec_app_support/v1

Class Method HTTP request Description
MecAppSupportApi ApplicationsConfirmReadyPOST Post /applications/{appInstanceId}/confirm_ready
MecAppSupportApi ApplicationsConfirmTerminationPOST Post /applications/{appInstanceId}/confirm_termination
MecAppSupportApi ApplicationsSubscriptionDELETE Delete /applications/{appInstanceId}/subscriptions/{subscriptionId}
MecAppSupportApi ApplicationsSubscriptionGET Get /applications/{appInstanceId}/subscriptions/{subscriptionId}
MecAppSupportApi ApplicationsSubscriptionsGET Get /applications/{appInstanceId}/subscriptions
MecAppSupportApi ApplicationsSubscriptionsPOST Post /applications/{appInstanceId}/subscriptions
MecAppSupportApi TimingCapsGET Get /timing/timing_caps
MecAppSupportApi TimingCurrentTimeGET Get /timing/current_time
UnsupportedApi ApplicationsDnsRuleGET Get /applications/{appInstanceId}/dns_rules/{dnsRuleId}
UnsupportedApi ApplicationsDnsRulePUT Put /applications/{appInstanceId}/dns_rules/{dnsRuleId}
UnsupportedApi ApplicationsDnsRulesGET Get /applications/{appInstanceId}/dns_rules
UnsupportedApi ApplicationsTrafficRuleGET Get /applications/{appInstanceId}/traffic_rules/{trafficRuleId}
UnsupportedApi ApplicationsTrafficRulePUT Put /applications/{appInstanceId}/traffic_rules/{trafficRuleId}
UnsupportedApi ApplicationsTrafficRulesGET Get /applications/{appInstanceId}/traffic_rules

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

AdvantEDGE@InterDigital.com

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	MecAppSupportApi *MecAppSupportApiService

	UnsupportedApi *UnsupportedApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the AdvantEDGE MEC Application Support API API v2.2.1 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.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AppReadyConfirmation

type AppReadyConfirmation struct {
	// Indication about the MEC application instance.
	Indication string `json:"indication"`
}

This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running.

type AppTerminationConfirmation

type AppTerminationConfirmation struct {
	OperationAction *OperationActionType `json:"operationAction"`
}

This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop.

type AppTerminationNotification

type AppTerminationNotification struct {
	// Shall be set to AppTerminationNotification.
	NotificationType string               `json:"notificationType"`
	OperationAction  *OperationActionType `json:"operationAction"`
	// Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
	MaxGracefulTimeout int32                            `json:"maxGracefulTimeout"`
	Links              *AppTerminationNotificationLinks `json:"_links"`
}

This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.

type AppTerminationNotificationLinks struct {
	Subscription       *LinkType                   `json:"subscription"`
	ConfirmTermination *LinkTypeConfirmTermination `json:"confirmTermination,omitempty"`
}

Object containing hyperlinks related to the resource.

type AppTerminationNotificationSubscription

type AppTerminationNotificationSubscription struct {
	// Shall be set to AppTerminationNotificationSubscription.
	SubscriptionType string `json:"subscriptionType"`
	// URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response.
	CallbackReference string `json:"callbackReference"`
	Links             *Self  `json:"_links"`
	// It is used as the filtering criterion for the subscribed events.
	AppInstanceId string `json:"appInstanceId"`
}

This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

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

type CurrentTime

type CurrentTime struct {
	// The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
	Seconds int32 `json:"seconds"`
	// The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
	NanoSeconds      int32             `json:"nanoSeconds"`
	TimeSourceStatus *TimeSourceStatus `json:"timeSourceStatus"`
}

This type represents the information provided by the MEC platform in response to the Get Platform Time Request message.

type DestinationInterface

type DestinationInterface struct {
	InterfaceType *DestinationInterfaceInterfaceType `json:"interfaceType"`
	TunnelInfo    *TunnelInfo                        `json:"tunnelInfo,omitempty"`
	// Source address identifies the MAC address of the interface
	SrcMacAddress string `json:"srcMacAddress,omitempty"`
	// Source address identifies the MAC address of the interface
	DstMacAddress string `json:"dstMacAddress,omitempty"`
	// IP address of the remote destination
	DstIpAddress string `json:"dstIpAddress,omitempty"`
}

This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided.

type DestinationInterfaceInterfaceType

type DestinationInterfaceInterfaceType string

DestinationInterfaceInterfaceType : Type of the interface

const (
	TUNNEL_DestinationInterfaceInterfaceType DestinationInterfaceInterfaceType = "TUNNEL"
	MAC_DestinationInterfaceInterfaceType    DestinationInterfaceInterfaceType = "MAC"
	IP_DestinationInterfaceInterfaceType     DestinationInterfaceInterfaceType = "IP"
)

List of DestinationInterfaceInterfaceType

type DnsRule

type DnsRule struct {
	// Identifies the DNS Rule
	DnsRuleId string `json:"dnsRuleId"`
	// FQDN resolved by the DNS rule
	DomainName    string                `json:"domainName"`
	IpAddressType *DnsRuleIpAddressType `json:"ipAddressType"`
	// IP address associated with the FQDN resolved by the DNS rule
	IpAddress string `json:"ipAddress"`
	// Time to live value
	Ttl   int32         `json:"ttl,omitempty"`
	State *DnsRuleState `json:"state"`
}

This type represents the general information of a DNS rule.

type DnsRuleIpAddressType

type DnsRuleIpAddressType string

DnsRuleIpAddressType : IP address type

const (
	V6_DnsRuleIpAddressType DnsRuleIpAddressType = "IP_V6"
	V4_DnsRuleIpAddressType DnsRuleIpAddressType = "IP_V4"
)

List of DnsRuleIpAddressType

type DnsRuleState

type DnsRuleState string

DnsRuleState : DNS rule state. This attribute may be updated using HTTP PUT method

const (
	ACTIVE_DnsRuleState   DnsRuleState = "ACTIVE"
	INACTIVE_DnsRuleState DnsRuleState = "INACTIVE"
)

List of DnsRuleState

type GenericSwaggerError

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type LinkType

type LinkType struct {
	// URI referring to a resource
	Href string `json:"href,omitempty"`
}

This type represents a type of link and may be referenced from data structures

type LinkTypeConfirmTermination

type LinkTypeConfirmTermination struct {
	// URI referring to a resource
	Href string `json:"href,omitempty"`
}

Link to the task resource where to confirm termination in case the application is ready to be terminated before expiry of the timeout.

type MecAppSupportApiService

type MecAppSupportApiService service

func (*MecAppSupportApiService) ApplicationsConfirmReadyPOST

func (a *MecAppSupportApiService) ApplicationsConfirmReadyPOST(ctx context.Context, body AppReadyConfirmation, appInstanceId string) (*http.Response, error)

MecAppSupportApiService This method may be used by the MEC application instance to notify the MEC platform that it is up and running.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.

func (*MecAppSupportApiService) ApplicationsConfirmTerminationPOST

func (a *MecAppSupportApiService) ApplicationsConfirmTerminationPOST(ctx context.Context, body AppTerminationConfirmation, appInstanceId string) (*http.Response, error)

MecAppSupportApiService This method is used to confirm the application level termination of an application instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.

func (*MecAppSupportApiService) ApplicationsSubscriptionDELETE

func (a *MecAppSupportApiService) ApplicationsSubscriptionDELETE(ctx context.Context, appInstanceId string, subscriptionId string) (*http.Response, error)

MecAppSupportApiService This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
  • @param subscriptionId Represents a subscription to the notifications from the MEC platform.

func (*MecAppSupportApiService) ApplicationsSubscriptionGET

func (a *MecAppSupportApiService) ApplicationsSubscriptionGET(ctx context.Context, appInstanceId string, subscriptionId string) (AppTerminationNotificationSubscription, *http.Response, error)

MecAppSupportApiService The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
  • @param subscriptionId Represents a subscription to the notifications from the MEC platform.

@return AppTerminationNotificationSubscription

func (*MecAppSupportApiService) ApplicationsSubscriptionsGET

func (a *MecAppSupportApiService) ApplicationsSubscriptionsGET(ctx context.Context, appInstanceId string) (MecAppSuptApiSubscriptionLinkList, *http.Response, error)

MecAppSupportApiService The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.

@return MecAppSuptApiSubscriptionLinkList

func (*MecAppSupportApiService) ApplicationsSubscriptionsPOST

MecAppSupportApiService The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.

@return AppTerminationNotificationSubscription

func (*MecAppSupportApiService) TimingCapsGET

MecAppSupportApiService This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return TimingCaps

func (*MecAppSupportApiService) TimingCurrentTimeGET

func (a *MecAppSupportApiService) TimingCurrentTimeGET(ctx context.Context) (CurrentTime, *http.Response, error)

MecAppSupportApiService This method retrieves the information of the platform's current time which corresponds to the get platform time procedure

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CurrentTime

type MecAppSuptApiSubscriptionLinkList struct {
	Links *MecAppSuptApiSubscriptionLinkListLinks `json:"_links"`
}

This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions.

type MecAppSuptApiSubscriptionLinkListLinks struct {
	Self *LinkType `json:"self"`
	// The MEC application instance's subscriptions
	Subscriptions []MecAppSuptApiSubscriptionLinkListSubscription `json:"subscriptions,omitempty"`
}

Self-referring URI.

type MecAppSuptApiSubscriptionLinkListSubscription

type MecAppSuptApiSubscriptionLinkListSubscription struct {
	// URI referring to a resource
	Href string `json:"href"`
	// The values shall be set to AppTerminationNotificationSubscription.
	Rel string `json:"rel"`
}

A link to a subscription.

type OperationActionType

type OperationActionType string

OperationActionType : Operation that is being performed on the MEC application instance.

const (
	STOPPING_OperationActionType    OperationActionType = "STOPPING"
	TERMINATING_OperationActionType OperationActionType = "TERMINATING"
)

List of OperationActionType

type ProblemDetails

type ProblemDetails struct {
	// A URI reference according to IETF RFC 3986 that identifies the problem type
	Type_ string `json:"type,omitempty"`
	// A short, human-readable summary of the problem type
	Title string `json:"title,omitempty"`
	// The HTTP status code for this occurrence of the problem
	Status int32 `json:"status,omitempty"`
	// A human-readable explanation specific to this occurrence of the problem
	Detail string `json:"detail,omitempty"`
	// A URI reference that identifies the specific occurrence of the problem
	Instance string `json:"instance,omitempty"`
}

type Self

type Self struct {
	Self *LinkType `json:"self"`
}

Self-referring URI.

type TimeSourceStatus

type TimeSourceStatus string

TimeSourceStatus : Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source

const (
	TRACEABLE_TimeSourceStatus    TimeSourceStatus = "TRACEABLE"
	NONTRACEABLE_TimeSourceStatus TimeSourceStatus = "NONTRACEABLE"
)

List of TimeSourceStatus

type TimingCaps

type TimingCaps struct {
	TimeStamp *TimingCapsTimeStamp `json:"timeStamp,omitempty"`
	// Available NTP servers
	NtpServers []TimingCapsNtpServers `json:"ntpServers,omitempty"`
	// Number of available PTP Servers (referred to as \"masters\" in IEEE 1588-2019)
	PtpMasters []TimingCapsPtpMasters `json:"ptpMasters,omitempty"`
}

This type represents the information provided by the MEC platform in response to the Timing capabilities Query message.

type TimingCapsNtpServers

type TimingCapsNtpServers struct {
	NtpServerAddrType *TimingCapsNtpServersNtpServerAddrType `json:"ntpServerAddrType"`
	// NTP server address
	NtpServerAddr string `json:"ntpServerAddr"`
	// Minimum poll interval for NTP messages, in seconds as a power of two. Range 3 to 17
	MinPollingInterval int32 `json:"minPollingInterval"`
	// Maximum poll interval for NTP messages, in seconds as a power of two. Range 3 to 17
	MaxPollingInterval int32 `json:"maxPollingInterval"`
	// NTP server local priority
	LocalPriority        int32                                     `json:"localPriority"`
	AuthenticationOption *TimingCapsNtpServersAuthenticationOption `json:"authenticationOption"`
	// Authentication key number
	AuthenticationKeyNum int32 `json:"authenticationKeyNum"`
}

NTP server detail.

type TimingCapsNtpServersAuthenticationOption

type TimingCapsNtpServersAuthenticationOption string

TimingCapsNtpServersAuthenticationOption : NTP authentication option

const (
	NONE_TimingCapsNtpServersAuthenticationOption          TimingCapsNtpServersAuthenticationOption = "NONE"
	SYMMETRIC_KEY_TimingCapsNtpServersAuthenticationOption TimingCapsNtpServersAuthenticationOption = "SYMMETRIC_KEY"
	AUTO_KEY_TimingCapsNtpServersAuthenticationOption      TimingCapsNtpServersAuthenticationOption = "AUTO_KEY"
)

List of TimingCapsNtpServersAuthenticationOption

type TimingCapsNtpServersNtpServerAddrType

type TimingCapsNtpServersNtpServerAddrType string

TimingCapsNtpServersNtpServerAddrType : Address type of NTP server

const (
	IP_ADDRESS_TimingCapsNtpServersNtpServerAddrType TimingCapsNtpServersNtpServerAddrType = "IP_ADDRESS"
	DNS_NAME_TimingCapsNtpServersNtpServerAddrType   TimingCapsNtpServersNtpServerAddrType = "DNS_NAME"
)

List of TimingCapsNtpServersNtpServerAddrType

type TimingCapsPtpMasters

type TimingCapsPtpMasters struct {
	// PTP Server (referred to as \"master\" in IEEE 1588-2019) IP Address
	PtpMasterIpAddress string `json:"ptpMasterIpAddress"`
	// PTP Server (referred to as \"master\" in IEEE 1588-2019 ) local priority
	PtpMasterLocalPriority int32 `json:"ptpMasterLocalPriority"`
	// Acceptable maximum rate of the Delay_Req messages in packets per second
	DelayReqMaxRate int32 `json:"delayReqMaxRate"`
}

NTP server detail.

type TimingCapsTimeStamp

type TimingCapsTimeStamp struct {
	// The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
	Seconds int32 `json:"seconds"`
	// The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
	NanoSeconds int32 `json:"nanoSeconds"`
}

time

type TrafficFilter

type TrafficFilter struct {
	// An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.
	SrcAddress []string `json:"srcAddress,omitempty"`
	// An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.
	DstAddress []string `json:"dstAddress,omitempty"`
	// A port or a range of ports
	SrcPort []string `json:"srcPort,omitempty"`
	// A port or a range of ports
	DstPort []string `json:"dstPort,omitempty"`
	// Specify the protocol of the traffic filter
	Protocol []string `json:"protocol,omitempty"`
	// Used for token based traffic rule
	Token []string `json:"token,omitempty"`
	// Used for GTP tunnel based traffic rule
	SrcTunnelAddress []string `json:"srcTunnelAddress,omitempty"`
	// Used for GTP tunnel based traffic rule
	TgtTunnelAddress []string `json:"tgtTunnelAddress,omitempty"`
	// Used for GTP tunnel based traffic rule
	SrcTunnelPort []string `json:"srcTunnelPort,omitempty"`
	// Used for GTP tunnel based traffic rule
	DstTunnelPort []string `json:"dstTunnelPort,omitempty"`
	// Used to match all packets that have the same Quality Class Indicator (QCI).
	QCI int32 `json:"qCI,omitempty"`
	// Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP)
	DSCP int32 `json:"dSCP,omitempty"`
	// Used to match all IPv6 packets that have the same Traffic Class.
	TC int32 `json:"tC,omitempty"`
}

This type represents the traffic filter.

type TrafficRule

type TrafficRule struct {
	// Identify the traffic rule.
	TrafficRuleId string                 `json:"trafficRuleId"`
	FilterType    *TrafficRuleFilterType `json:"filterType"`
	// Priority of this traffic rule within the range 0 to 255. If traffic rules conflict, the one with higher priority take precedence. Value indicates the priority in descending order, i.e. with 0 as the highest priority and 255 as the lowest priority.
	Priority      int32                  `json:"priority"`
	TrafficFilter []TrafficFilter        `json:"trafficFilter"`
	Action        *TrafficRuleAction     `json:"action"`
	DstInterface  []DestinationInterface `json:"dstInterface,omitempty"`
	State         *TrafficRuleState      `json:"state"`
}

This type represents the general information of a traffic rule.

type TrafficRuleAction

type TrafficRuleAction string

TrafficRuleAction : The action of the MEC host data plane when a packet matches the trafficFilter

const (
	DROP_TrafficRuleAction                   TrafficRuleAction = "DROP"
	FORWARD_DECAPSULATED_TrafficRuleAction   TrafficRuleAction = "FORWARD_DECAPSULATED"
	FORWARD_ENCAPSULATED_TrafficRuleAction   TrafficRuleAction = "FORWARD_ENCAPSULATED"
	PASSTHROUGH_TrafficRuleAction            TrafficRuleAction = "PASSTHROUGH"
	DUPLICATE_DECAPSULATED_TrafficRuleAction TrafficRuleAction = "DUPLICATE_DECAPSULATED"
	DUPLICATE_ENCAPSULATED_TrafficRuleAction TrafficRuleAction = "DUPLICATE_ENCAPSULATED"
)

List of TrafficRuleAction

type TrafficRuleFilterType

type TrafficRuleFilterType string

TrafficRuleFilterType : Definition of filter per FLOW or PACKET. If flow the filter match UE->EPC packet and the reverse packet is handled in the same context

const (
	FLOW_TrafficRuleFilterType   TrafficRuleFilterType = "FLOW"
	PACKET_TrafficRuleFilterType TrafficRuleFilterType = "PACKET"
)

List of TrafficRuleFilterType

type TrafficRuleState

type TrafficRuleState string

TrafficRuleState : Contains the traffic rule state. This attribute may be updated using HTTP PUT method

const (
	ACTIVE_TrafficRuleState   TrafficRuleState = "ACTIVE"
	INACTIVE_TrafficRuleState TrafficRuleState = "INACTIVE"
)

List of TrafficRuleState

type TunnelInfo

type TunnelInfo struct {
	TunnelType *TunnelInfoTunnelType `json:"tunnelType"`
	// Destination address of the tunnel
	TunnelDstAddress string `json:"tunnelDstAddress,omitempty"`
	// Source address of the tunnel
	TunnelSrcAddress string `json:"tunnelSrcAddress,omitempty"`
}

This type represents the tunnel information.

type TunnelInfoTunnelType

type TunnelInfoTunnelType string

TunnelInfoTunnelType : This type represents the tunnel information.

const (
	GTP_U_TunnelInfoTunnelType TunnelInfoTunnelType = "GTP_U"
	GRE_TunnelInfoTunnelType   TunnelInfoTunnelType = "GRE"
)

List of TunnelInfoTunnelType

type UnsupportedApiService

type UnsupportedApiService service

func (*UnsupportedApiService) ApplicationsDnsRuleGET

func (a *UnsupportedApiService) ApplicationsDnsRuleGET(ctx context.Context, appInstanceId string, dnsRuleId string) (DnsRule, *http.Response, error)

UnsupportedApiService This method retrieves information about a DNS rule associated with a MEC application instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
  • @param dnsRuleId Represents a DNS rule.

@return DnsRule

func (*UnsupportedApiService) ApplicationsDnsRulePUT

func (a *UnsupportedApiService) ApplicationsDnsRulePUT(ctx context.Context, body DnsRule, appInstanceId string, dnsRuleId string) (DnsRule, *http.Response, error)

UnsupportedApiService This method activates, de-activates or updates a traffic rule.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The updated state is included in the entity body of the request.
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
  • @param dnsRuleId Represents a DNS rule.

@return DnsRule

func (*UnsupportedApiService) ApplicationsDnsRulesGET

func (a *UnsupportedApiService) ApplicationsDnsRulesGET(ctx context.Context, appInstanceId string) ([]DnsRule, *http.Response, error)

UnsupportedApiService This method retrieves information about all the DNS rules associated with a MEC application instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.

@return []DnsRule

func (*UnsupportedApiService) ApplicationsTrafficRuleGET

func (a *UnsupportedApiService) ApplicationsTrafficRuleGET(ctx context.Context, appInstanceId string, trafficRuleId string) (TrafficRule, *http.Response, error)

UnsupportedApiService This method retrieves information about all the traffic rules associated with a MEC application instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
  • @param trafficRuleId Represents a traffic rule.

@return TrafficRule

func (*UnsupportedApiService) ApplicationsTrafficRulePUT

func (a *UnsupportedApiService) ApplicationsTrafficRulePUT(ctx context.Context, body TrafficRule, appInstanceId string, trafficRuleId string) (TrafficRule, *http.Response, error)

UnsupportedApiService This method retrieves information about all the traffic rules associated with a MEC application instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body One or more updated attributes that are allowed to be changed
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
  • @param trafficRuleId Represents a traffic rule.

@return TrafficRule

func (*UnsupportedApiService) ApplicationsTrafficRulesGET

func (a *UnsupportedApiService) ApplicationsTrafficRulesGET(ctx context.Context, appInstanceId string) ([]TrafficRule, *http.Response, error)

UnsupportedApiService This method retrieves information about all the traffic rules associated with a MEC application instance.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param appInstanceId Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.

@return []TrafficRule

Jump to

Keyboard shortcuts

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