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: 0

README

Go API client for client

Mobility Group Service allows to form groups formed multiple edge application instances and share user states automatically withing the group

Micro-service
meep-mg-manager

Type & Usage
Edge Service used by edge applications to share user state between the Mobility Group members

Details
API details available at your-AdvantEDGE-ip-address/api

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: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.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/mgm/v1

Class Method HTTP request Description
MembershipApi CreateMobilityGroup Post /mg/{mgName} Add new Mobility Group
MembershipApi CreateMobilityGroupApp Post /mg/{mgName}/app/{appId} Add new Mobility Group App
MembershipApi CreateMobilityGroupUe Post /mg/{mgName}/app/{appId}/ue Add UE to group tracking list
MembershipApi DeleteMobilityGroup Delete /mg/{mgName} Delete Mobility Group
MembershipApi DeleteMobilityGroupApp Delete /mg/{mgName}/app/{appId} Delete Mobility Group App
MembershipApi GetMobilityGroup Get /mg/{mgName} Retrieve Mobility Groups with provided name
MembershipApi GetMobilityGroupApp Get /mg/{mgName}/app/{appId} Retrieve App information using provided Mobility Group Name & App ID
MembershipApi GetMobilityGroupAppList Get /mg/{mgName}/app Retrieve list of Apps in provided Mobility Group
MembershipApi GetMobilityGroupList Get /mg Retrieve list of Mobility Groups
MembershipApi SetMobilityGroup Put /mg/{mgName} Update Mobility Group
MembershipApi SetMobilityGroupApp Put /mg/{mgName}/app/{appId} Update Mobility GroupApp
StateTransferApi TransferAppState Post /mg/{mgName}/app/{appId}/state Send state to transfer to peers

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 {
	MembershipApi *MembershipApiService

	StateTransferApi *StateTransferApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the AdvantEDGE Mobility Group Service REST API 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.

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 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 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 MembershipApiService 

type MembershipApiService service

func (*MembershipApiService) CreateMobilityGroup 

func (a *MembershipApiService) CreateMobilityGroup(ctx context.Context, mgName string, mobilityGroup MobilityGroup) (*http.Response, error)

MembershipApiService Add new Mobility Group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param mobilityGroup Mobility Group to create/update

func (*MembershipApiService) CreateMobilityGroupApp 

func (a *MembershipApiService) CreateMobilityGroupApp(ctx context.Context, mgName string, appId string, mgApp MobilityGroupApp) (*http.Response, error)

MembershipApiService Add new Mobility Group App

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param appId Mobility Group App Id
  • @param mgApp Mobility Group App to create/update

func (*MembershipApiService) CreateMobilityGroupUe 

func (a *MembershipApiService) CreateMobilityGroupUe(ctx context.Context, mgName string, appId string, mgUe MobilityGroupUe) (*http.Response, error)

MembershipApiService Add UE to group tracking list

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param appId Mobility Group App Id
  • @param mgUe Mobility Group UE to create/update

func (*MembershipApiService) DeleteMobilityGroup 

func (a *MembershipApiService) DeleteMobilityGroup(ctx context.Context, mgName string) (*http.Response, error)

MembershipApiService Delete Mobility Group

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

func (*MembershipApiService) DeleteMobilityGroupApp 

func (a *MembershipApiService) DeleteMobilityGroupApp(ctx context.Context, mgName string, appId string) (*http.Response, error)

MembershipApiService Delete Mobility Group App

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param appId Mobility Group App Id

func (*MembershipApiService) GetMobilityGroup 

func (a *MembershipApiService) GetMobilityGroup(ctx context.Context, mgName string) (MobilityGroup, *http.Response, error)

MembershipApiService Retrieve Mobility Groups with provided name

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

@return MobilityGroup

func (*MembershipApiService) GetMobilityGroupApp 

func (a *MembershipApiService) GetMobilityGroupApp(ctx context.Context, mgName string, appId string) (MobilityGroupApp, *http.Response, error)

MembershipApiService Retrieve App information using provided Mobility Group Name & App ID

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param appId Mobility Group App Id

@return MobilityGroupApp

func (*MembershipApiService) GetMobilityGroupAppList 

func (a *MembershipApiService) GetMobilityGroupAppList(ctx context.Context, mgName string) ([]MobilityGroupApp, *http.Response, error)

MembershipApiService Retrieve list of Apps in provided Mobility Group

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

@return []MobilityGroupApp

func (*MembershipApiService) GetMobilityGroupList 

func (a *MembershipApiService) GetMobilityGroupList(ctx context.Context) ([]MobilityGroup, *http.Response, error)

MembershipApiService Retrieve list of Mobility Groups

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

@return []MobilityGroup

func (*MembershipApiService) SetMobilityGroup 

func (a *MembershipApiService) SetMobilityGroup(ctx context.Context, mgName string, mobilityGroup MobilityGroup) (*http.Response, error)

MembershipApiService Update Mobility Group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param mobilityGroup Mobility Group to create/update

func (*MembershipApiService) SetMobilityGroupApp 

func (a *MembershipApiService) SetMobilityGroupApp(ctx context.Context, mgName string, appId string, mgApp MobilityGroupApp) (*http.Response, error)

MembershipApiService Update Mobility GroupApp

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param appId Mobility Group App Id
  • @param mgApp Mobility Group App to create/update

type MobilityGroup 

type MobilityGroup struct {
	// Mobility Group name
	Name string `json:"name,omitempty"`
	// State Transfer mode
	StateTransferMode string `json:"stateTransferMode,omitempty"`
	// State Transfer trigger
	StateTransferTrigger string `json:"stateTransferTrigger,omitempty"`
	// Session Transfer mode
	SessionTransferMode string `json:"sessionTransferMode,omitempty"`
	// Load Balancing Algorithm
	LoadBalancingAlgorithm string `json:"loadBalancingAlgorithm,omitempty"`
}

Mobility Group

type MobilityGroupApp 

type MobilityGroupApp struct {
	// Mobility Group Application Identifier
	Id string `json:"id,omitempty"`
	// Event handler url
	Url string `json:"url,omitempty"`
}

Mobility Group Application instance

type MobilityGroupAppState 

type MobilityGroupAppState struct {
	// Mobility Group UE Identifier
	UeId string `json:"ueId,omitempty"`
	// Mobility Group Application State for provided UE
	UeState string `json:"ueState,omitempty"`
}

Mobility Group Application State

type MobilityGroupUe 

type MobilityGroupUe struct {
	// Mobility Group UE Identifier
	Id string `json:"id,omitempty"`
}

Mobility Group UE instance

type StateTransferApiService 

type StateTransferApiService service

func (*StateTransferApiService) TransferAppState 

func (a *StateTransferApiService) TransferAppState(ctx context.Context, mgName string, appId string, appState MobilityGroupAppState) (*http.Response, error)

StateTransferApiService Send state to transfer to peers

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param mgName Mobility Group name
  • @param appId Mobility Group App Id
  • @param appState Mobility Group App State to transfer

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.