package
1.18.2
Repository: https://github.com/5gcorenet/openapi.git
Documentation: pkg.go.dev

# README

Go API client for openapi_PerfMnS

OAS 3.0.1 definition of the Performance Threshold Monitoring MnS © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.

Overview

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

  • API version: 17.1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import openapi_PerfMnS "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_PerfMnS"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi_PerfMnS.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi_PerfMnS.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi_PerfMnS.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi_PerfMnS.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://example.com/3GPPManagement

ClassMethodHTTP requestDescription
DefaultApiNotificationSinkPostPost /notificationSinkSend notifications about performance threshold crossing

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

# Functions

AlarmNotificationTypesAsNotificationType is a convenience function that returns AlarmNotificationTypes wrapped in NotificationType.
CacheExpires helper function to determine remaining time before repeating a request.
CmNotificationTypesAsNotificationType is a convenience function that returns CmNotificationTypes wrapped in NotificationType.
FileNotificationTypesAsNotificationType is a convenience function that returns FileNotificationTypes wrapped in NotificationType.
float32AsPerfMetricValue is a convenience function that returns float32 wrapped in PerfMetricValue.
HeartbeatNotificationTypesAsNotificationType is a convenience function that returns HeartbeatNotificationTypes wrapped in NotificationType.
int32AsPerfMetricValue is a convenience function that returns int32 wrapped in PerfMetricValue.
IsNil checks if an input is nil.
NewAlarmNotificationTypesFromValue returns a pointer to a valid AlarmNotificationTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewCmNotificationTypesFromValue returns a pointer to a valid CmNotificationTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewConfiguration returns a new Configuration object.
NewErrorResponse instantiates a new ErrorResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorResponseError instantiates a new ErrorResponseError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorResponseErrorWithDefaults instantiates a new ErrorResponseError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorResponseWithDefaults instantiates a new ErrorResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFileNotificationTypesFromValue returns a pointer to a valid FileNotificationTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewHeartbeatNotificationTypesFromValue returns a pointer to a valid HeartbeatNotificationTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewNotificationHeader instantiates a new NotificationHeader object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotificationHeaderWithDefaults instantiates a new NotificationHeader object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotifyThresholdCrossing instantiates a new NotifyThresholdCrossing object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotifyThresholdCrossingAllOf instantiates a new NotifyThresholdCrossingAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNotifyThresholdCrossingAllOfWithDefaults instantiates a new NotifyThresholdCrossingAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNotifyThresholdCrossingWithDefaults instantiates a new NotifyThresholdCrossing object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPerfMetricDirectionFromValue returns a pointer to a valid PerfMetricDirection for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewPerfNotificationTypesFromValue returns a pointer to a valid PerfNotificationTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
PerfNotificationTypesAsNotificationType is a convenience function that returns PerfNotificationTypes wrapped in NotificationType.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Constants

List of PerfMetricDirection.
List of AlarmNotificationTypes.
List of AlarmNotificationTypes.
List of AlarmNotificationTypes.
List of AlarmNotificationTypes.
List of AlarmNotificationTypes.
List of AlarmNotificationTypes.
List of AlarmNotificationTypes.
List of FileNotificationTypes.
List of FileNotificationTypes.
List of HeartbeatNotificationTypes.
List of CmNotificationTypes.
List of CmNotificationTypes.
List of CmNotificationTypes.
List of CmNotificationTypes.
List of AlarmNotificationTypes.
List of AlarmNotificationTypes.
List of PerfNotificationTypes.
List of PerfMetricDirection.

# Variables

All allowed values of AlarmNotificationTypes enum.
All allowed values of CmNotificationTypes enum.
All allowed values of FileNotificationTypes enum.
All allowed values of HeartbeatNotificationTypes enum.
All allowed values of PerfMetricDirection enum.
All allowed values of PerfNotificationTypes enum.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the TS 28.532 Performance Threshold Monitoring MnS API v17.1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
ErrorResponse Default schema for the response message body in case the request is not successful.
ErrorResponseError struct for ErrorResponseError.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
NotificationHeader struct for NotificationHeader.
NotificationType - struct for NotificationType.
NotifyThresholdCrossing struct for NotifyThresholdCrossing.
NotifyThresholdCrossingAllOf struct for NotifyThresholdCrossingAllOf.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PerfMetricValue - struct for PerfMetricValue.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.

# Interfaces

No description provided by the author

# Type aliases

AlarmNotificationTypes the model 'AlarmNotificationTypes'.
CmNotificationTypes the model 'CmNotificationTypes'.
DefaultApiService DefaultApi service.
FileNotificationTypes the model 'FileNotificationTypes'.
HeartbeatNotificationTypes the model 'HeartbeatNotificationTypes'.
PerfMetricDirection the model 'PerfMetricDirection'.
PerfNotificationTypes the model 'PerfNotificationTypes'.
ServerConfigurations stores multiple ServerConfiguration items.