Categorygithub.com/5GCoreNet/openapiopenapi_FaultMnS
package
1.18.2
Repository: https://github.com/5gcorenet/openapi.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
20
Dependents
0
Files
11.7k SLOC

# README

Go API client for openapi_FaultMnS

OAS 3.0.1 definition of the Fault Supervision MnS © 2022, 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.2.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_FaultMnS "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_FaultMnS"

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_FaultMnS.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_FaultMnS.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_FaultMnS.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi_FaultMnS.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
DefaultApiAlarmsAlarmCountGetGet /alarms/alarmCountGet the alarm count per perceived severity
DefaultApiAlarmsAlarmIdCommentsPostPost /alarms/{alarmId}/commentsAdd a comment to a single alarm
DefaultApiAlarmsAlarmIdPatchPatch /alarms/{alarmId}Clear, acknowledge or unacknowledge a single alarm
DefaultApiAlarmsGetGet /alarmsRetrieve multiple alarms
DefaultApiAlarmsPatchPatch /alarmsClear, acknowledge or unacknowledge multiple alarms
DefaultApiSubscriptionsPostPost /subscriptionsCreate a subscription
DefaultApiSubscriptionsSubscriptionIdDeleteDelete /subscriptions/{subscriptionId}Delete a subscription

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.
float32AsThresholdHysteresisHigh is a convenience function that returns float32 wrapped in ThresholdHysteresisHigh.
HeartbeatNotificationTypesAsNotificationType is a convenience function that returns HeartbeatNotificationTypes wrapped in NotificationType.
int32AsProbableCause is a convenience function that returns int32 wrapped in ProbableCause.
int32AsSpecificProblem is a convenience function that returns int32 wrapped in SpecificProblem.
int32AsThresholdHysteresisHigh is a convenience function that returns int32 wrapped in ThresholdHysteresisHigh.
IsNil checks if an input is nil.
map[string]MergePatchAcknowledgeAlarmAsAlarmsPatchRequest is a convenience function that returns map[string]MergePatchAcknowledgeAlarm wrapped in AlarmsPatchRequest.
map[string]MergePatchClearAlarmAsAlarmsPatchRequest is a convenience function that returns map[string]MergePatchClearAlarm wrapped in AlarmsPatchRequest.
MergePatchAcknowledgeAlarmAsAlarmsAlarmIdPatchRequest is a convenience function that returns MergePatchAcknowledgeAlarm wrapped in AlarmsAlarmIdPatchRequest.
MergePatchClearAlarmAsAlarmsAlarmIdPatchRequest is a convenience function that returns MergePatchClearAlarm wrapped in AlarmsAlarmIdPatchRequest.
NewAckStateFromValue returns a pointer to a valid AckState for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAlarmAckStateFromValue returns a pointer to a valid AlarmAckState for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAlarmCount instantiates a new AlarmCount 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.
NewAlarmCountWithDefaults instantiates a new AlarmCount 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.
NewAlarmListAlignmentRequirementFromValue returns a pointer to a valid AlarmListAlignmentRequirement for the value passed as argument, or an error if the value passed is not allowed by the enum.
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.
NewAlarmRecord instantiates a new AlarmRecord 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.
NewAlarmRecordWithDefaults instantiates a new AlarmRecord 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.
NewAlarmsGet200ResponseValue instantiates a new AlarmsGet200ResponseValue 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.
NewAlarmsGet200ResponseValueAllOf instantiates a new AlarmsGet200ResponseValueAllOf 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.
NewAlarmsGet200ResponseValueAllOf1 instantiates a new AlarmsGet200ResponseValueAllOf1 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.
NewAlarmsGet200ResponseValueAllOf1WithDefaults instantiates a new AlarmsGet200ResponseValueAllOf1 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.
NewAlarmsGet200ResponseValueAllOfWithDefaults instantiates a new AlarmsGet200ResponseValueAllOf 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.
NewAlarmsGet200ResponseValueWithDefaults instantiates a new AlarmsGet200ResponseValue 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.
NewAlarmTypeFromValue returns a pointer to a valid AlarmType 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.
NewComment instantiates a new Comment 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.
NewCommentWithDefaults instantiates a new Comment 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.
NewConfiguration returns a new Configuration object.
NewCorrelatedNotification instantiates a new CorrelatedNotification 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.
NewCorrelatedNotificationWithDefaults instantiates a new CorrelatedNotification 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.
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.
NewFailedAlarm instantiates a new FailedAlarm 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.
NewFailedAlarmWithDefaults instantiates a new FailedAlarm 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.
NewMergePatchAcknowledgeAlarm instantiates a new MergePatchAcknowledgeAlarm 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.
NewMergePatchAcknowledgeAlarmWithDefaults instantiates a new MergePatchAcknowledgeAlarm 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.
NewMergePatchClearAlarm instantiates a new MergePatchClearAlarm 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.
NewMergePatchClearAlarmWithDefaults instantiates a new MergePatchClearAlarm 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.
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.
NewNotifyAckStateChanged instantiates a new NotifyAckStateChanged 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.
NewNotifyAckStateChangedAllOf instantiates a new NotifyAckStateChangedAllOf 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.
NewNotifyAckStateChangedAllOfWithDefaults instantiates a new NotifyAckStateChangedAllOf 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.
NewNotifyAckStateChangedWithDefaults instantiates a new NotifyAckStateChanged 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.
NewNotifyAlarmListRebuilt instantiates a new NotifyAlarmListRebuilt 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.
NewNotifyAlarmListRebuiltAllOf instantiates a new NotifyAlarmListRebuiltAllOf 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.
NewNotifyAlarmListRebuiltAllOfWithDefaults instantiates a new NotifyAlarmListRebuiltAllOf 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.
NewNotifyAlarmListRebuiltWithDefaults instantiates a new NotifyAlarmListRebuilt 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.
NewNotifyChangedAlarm instantiates a new NotifyChangedAlarm 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.
NewNotifyChangedAlarmAllOf instantiates a new NotifyChangedAlarmAllOf 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.
NewNotifyChangedAlarmAllOfWithDefaults instantiates a new NotifyChangedAlarmAllOf 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.
NewNotifyChangedAlarmGeneral instantiates a new NotifyChangedAlarmGeneral 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.
NewNotifyChangedAlarmGeneralAllOf instantiates a new NotifyChangedAlarmGeneralAllOf 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.
NewNotifyChangedAlarmGeneralAllOfWithDefaults instantiates a new NotifyChangedAlarmGeneralAllOf 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.
NewNotifyChangedAlarmGeneralWithDefaults instantiates a new NotifyChangedAlarmGeneral 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.
NewNotifyChangedAlarmWithDefaults instantiates a new NotifyChangedAlarm 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.
NewNotifyChangedSecAlarmGeneral instantiates a new NotifyChangedSecAlarmGeneral 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.
NewNotifyChangedSecAlarmGeneralAllOf instantiates a new NotifyChangedSecAlarmGeneralAllOf 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.
NewNotifyChangedSecAlarmGeneralAllOfWithDefaults instantiates a new NotifyChangedSecAlarmGeneralAllOf 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.
NewNotifyChangedSecAlarmGeneralWithDefaults instantiates a new NotifyChangedSecAlarmGeneral 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.
NewNotifyClearedAlarm instantiates a new NotifyClearedAlarm 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.
NewNotifyClearedAlarmAllOf instantiates a new NotifyClearedAlarmAllOf 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.
NewNotifyClearedAlarmAllOfWithDefaults instantiates a new NotifyClearedAlarmAllOf 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.
NewNotifyClearedAlarmWithDefaults instantiates a new NotifyClearedAlarm 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.
NewNotifyComments instantiates a new NotifyComments 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.
NewNotifyCommentsAllOf instantiates a new NotifyCommentsAllOf 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.
NewNotifyCommentsAllOfWithDefaults instantiates a new NotifyCommentsAllOf 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.
NewNotifyCommentsWithDefaults instantiates a new NotifyComments 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.
NewNotifyCorrelatedNotificationChanged instantiates a new NotifyCorrelatedNotificationChanged 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.
NewNotifyCorrelatedNotificationChangedAllOf instantiates a new NotifyCorrelatedNotificationChangedAllOf 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.
NewNotifyCorrelatedNotificationChangedAllOfWithDefaults instantiates a new NotifyCorrelatedNotificationChangedAllOf 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.
NewNotifyCorrelatedNotificationChangedWithDefaults instantiates a new NotifyCorrelatedNotificationChanged 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.
NewNotifyNewAlarm instantiates a new NotifyNewAlarm 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.
NewNotifyNewAlarmAllOf instantiates a new NotifyNewAlarmAllOf 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.
NewNotifyNewAlarmAllOfWithDefaults instantiates a new NotifyNewAlarmAllOf 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.
NewNotifyNewAlarmWithDefaults instantiates a new NotifyNewAlarm 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.
NewNotifyNewSecAlarm instantiates a new NotifyNewSecAlarm 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.
NewNotifyNewSecAlarmAllOf instantiates a new NotifyNewSecAlarmAllOf 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.
NewNotifyNewSecAlarmAllOfWithDefaults instantiates a new NotifyNewSecAlarmAllOf 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.
NewNotifyNewSecAlarmWithDefaults instantiates a new NotifyNewSecAlarm 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.
NewNotifyPotentialFaultyAlarmList instantiates a new NotifyPotentialFaultyAlarmList 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.
NewNotifyPotentialFaultyAlarmListAllOf instantiates a new NotifyPotentialFaultyAlarmListAllOf 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.
NewNotifyPotentialFaultyAlarmListAllOfWithDefaults instantiates a new NotifyPotentialFaultyAlarmListAllOf 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.
NewNotifyPotentialFaultyAlarmListWithDefaults instantiates a new NotifyPotentialFaultyAlarmList 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
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
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPerceivedSeverityFromValue returns a pointer to a valid PerceivedSeverity 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.
NewSubscription instantiates a new Subscription 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.
NewSubscriptionWithDefaults instantiates a new Subscription 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.
NewThresholdHysteresis instantiates a new ThresholdHysteresis 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.
NewThresholdHysteresisWithDefaults instantiates a new ThresholdHysteresis 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.
NewThresholdInfo instantiates a new ThresholdInfo 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.
NewThresholdInfoWithDefaults instantiates a new ThresholdInfo 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.
NewThresholdLevelIndOneOf instantiates a new ThresholdLevelIndOneOf 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.
NewThresholdLevelIndOneOf1 instantiates a new ThresholdLevelIndOneOf1 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.
NewThresholdLevelIndOneOf1WithDefaults instantiates a new ThresholdLevelIndOneOf1 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.
NewThresholdLevelIndOneOfWithDefaults instantiates a new ThresholdLevelIndOneOf 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.
NewTrendIndicationFromValue returns a pointer to a valid TrendIndication 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.
ProbableCauseOneOfAsProbableCause is a convenience function that returns ProbableCauseOneOf wrapped in ProbableCause.
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.
stringAsSpecificProblem is a convenience function that returns string wrapped in SpecificProblem.
ThresholdLevelIndOneOf1AsThresholdLevelInd is a convenience function that returns ThresholdLevelIndOneOf1 wrapped in ThresholdLevelInd.
ThresholdLevelIndOneOfAsThresholdLevelInd is a convenience function that returns ThresholdLevelIndOneOf wrapped in ThresholdLevelInd.

# Constants

List of AckState.
List of AlarmAckState.
List of AlarmAckState.
List of AlarmAckState.
List of AlarmAckState.
List of PerceivedSeverity.
List of AlarmAckState.
List of AlarmType.
List of PerceivedSeverity.
List of AlarmType.
List of AlarmType.
List of PerceivedSeverity.
List of AlarmType.
List of TrendIndication.
List of PerceivedSeverity.
List of PerceivedSeverity.
List of TrendIndication.
List of TrendIndication.
List of AlarmListAlignmentRequirement.
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 AlarmType.
List of AlarmType.
List of AlarmType.
List of AlarmType.
List of AlarmListAlignmentRequirement.
List of AlarmType.
List of AlarmType.
List of AckState.
List of AlarmAckState.
List of PerceivedSeverity.

# Variables

All allowed values of AckState enum.
All allowed values of AlarmAckState enum.
All allowed values of AlarmListAlignmentRequirement enum.
All allowed values of AlarmNotificationTypes enum.
All allowed values of AlarmType enum.
All allowed values of CmNotificationTypes enum.
All allowed values of FileNotificationTypes enum.
All allowed values of HeartbeatNotificationTypes enum.
All allowed values of PerceivedSeverity enum.
All allowed values of PerfNotificationTypes enum.
All allowed values of TrendIndication 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

AlarmCount struct for AlarmCount.
AlarmRecord The alarmId is not a property of an alarm record.
AlarmsAlarmIdPatchRequest - struct for AlarmsAlarmIdPatchRequest.
AlarmsGet200ResponseValue struct for AlarmsGet200ResponseValue.
AlarmsGet200ResponseValueAllOf struct for AlarmsGet200ResponseValueAllOf.
AlarmsGet200ResponseValueAllOf1 struct for AlarmsGet200ResponseValueAllOf1.
AlarmsPatchRequest - struct for AlarmsPatchRequest.
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
APIClient manages communication with the Fault Supervision MnS API v17.2.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.
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Comment struct for Comment.
Configuration stores the configuration of the API client.
CorrelatedNotification struct for CorrelatedNotification.
ErrorResponse Default schema for the response message body in case the request is not successful.
ErrorResponseError struct for ErrorResponseError.
FailedAlarm struct for FailedAlarm.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
MergePatchAcknowledgeAlarm Patch document acknowledging or unacknowledging a single alarm.
MergePatchClearAlarm Patch document for clearing a single alarm.
NotificationHeader struct for NotificationHeader.
NotificationType - struct for NotificationType.
NotifyAckStateChanged struct for NotifyAckStateChanged.
NotifyAckStateChangedAllOf struct for NotifyAckStateChangedAllOf.
NotifyAlarmListRebuilt struct for NotifyAlarmListRebuilt.
NotifyAlarmListRebuiltAllOf struct for NotifyAlarmListRebuiltAllOf.
NotifyChangedAlarm struct for NotifyChangedAlarm.
NotifyChangedAlarmAllOf struct for NotifyChangedAlarmAllOf.
NotifyChangedAlarmGeneral struct for NotifyChangedAlarmGeneral.
NotifyChangedAlarmGeneralAllOf struct for NotifyChangedAlarmGeneralAllOf.
NotifyChangedSecAlarmGeneral struct for NotifyChangedSecAlarmGeneral.
NotifyChangedSecAlarmGeneralAllOf struct for NotifyChangedSecAlarmGeneralAllOf.
NotifyClearedAlarm struct for NotifyClearedAlarm.
NotifyClearedAlarmAllOf struct for NotifyClearedAlarmAllOf.
NotifyComments struct for NotifyComments.
NotifyCommentsAllOf struct for NotifyCommentsAllOf.
NotifyCorrelatedNotificationChanged struct for NotifyCorrelatedNotificationChanged.
NotifyCorrelatedNotificationChangedAllOf struct for NotifyCorrelatedNotificationChangedAllOf.
NotifyNewAlarm struct for NotifyNewAlarm.
NotifyNewAlarmAllOf struct for NotifyNewAlarmAllOf.
NotifyNewSecAlarm struct for NotifyNewSecAlarm.
NotifyNewSecAlarmAllOf struct for NotifyNewSecAlarmAllOf.
NotifyPotentialFaultyAlarmList struct for NotifyPotentialFaultyAlarmList.
NotifyPotentialFaultyAlarmListAllOf struct for NotifyPotentialFaultyAlarmListAllOf.
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
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
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProbableCause - The value of the probable cause may be a specific standardized string, or any vendor provided string.
ProbableCauseOneOf struct for ProbableCauseOneOf.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SpecificProblem - struct for SpecificProblem.
Subscription struct for Subscription.
ThresholdHysteresis struct for ThresholdHysteresis.
ThresholdHysteresisHigh - struct for ThresholdHysteresisHigh.
ThresholdInfo struct for ThresholdInfo.
ThresholdLevelInd - struct for ThresholdLevelInd.
ThresholdLevelIndOneOf struct for ThresholdLevelIndOneOf.
ThresholdLevelIndOneOf1 struct for ThresholdLevelIndOneOf1.

# Interfaces

No description provided by the author

# Type aliases

AckState the model 'AckState'.
AlarmAckState the model 'AlarmAckState'.
AlarmListAlignmentRequirement the model 'AlarmListAlignmentRequirement'.
AlarmNotificationTypes the model 'AlarmNotificationTypes'.
AlarmType the model 'AlarmType'.
CmNotificationTypes the model 'CmNotificationTypes'.
DefaultApiService DefaultApi service.
FileNotificationTypes the model 'FileNotificationTypes'.
HeartbeatNotificationTypes the model 'HeartbeatNotificationTypes'.
PerceivedSeverity the model 'PerceivedSeverity'.
PerfNotificationTypes the model 'PerfNotificationTypes'.
ServerConfigurations stores multiple ServerConfiguration items.
TrendIndication the model 'TrendIndication'.