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

# README

Go API client for openapi_Namf_Location

AMF Location Service.
© 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: 1.3.0-alpha.1
  • 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/oauth2
go get golang.org/x/net/context

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

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

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

Documentation for API Endpoints

All URIs are relative to https://example.com/namf-loc/v1

ClassMethodHTTP requestDescription
IndividualUEContextDocumentApiCancelLocationPost /{ueContextId}/cancel-pos-infoNamf_Location CancelLocation service operation
IndividualUEContextDocumentApiProvideLocationInfoPost /{ueContextId}/provide-loc-infoNamf_Location ProvideLocationInfo service Operation
IndividualUEContextDocumentApiProvidePositioningInfoPost /{ueContextId}/provide-pos-infoNamf_Location ProvidePositioningInfo service Operation

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • namf-loc: Access to the Namf_Location API

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

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

CacheExpires helper function to determine remaining time before repeating a request.
HorizontalVelocityAsVelocityEstimate is a convenience function that returns HorizontalVelocity wrapped in VelocityEstimate.
HorizontalVelocityWithUncertaintyAsVelocityEstimate is a convenience function that returns HorizontalVelocityWithUncertainty wrapped in VelocityEstimate.
HorizontalWithVerticalVelocityAndUncertaintyAsVelocityEstimate is a convenience function that returns HorizontalWithVerticalVelocityAndUncertainty wrapped in VelocityEstimate.
HorizontalWithVerticalVelocityAsVelocityEstimate is a convenience function that returns HorizontalWithVerticalVelocity wrapped in VelocityEstimate.
interface{}AsGeraLocation is a convenience function that returns interface{} wrapped in GeraLocation.
interface{}AsGlobalRanNodeId is a convenience function that returns interface{} wrapped in GlobalRanNodeId.
interface{}AsUtraLocation is a convenience function that returns interface{} wrapped in UtraLocation.
IsNil checks if an input is nil.
Local2dPointUncertaintyEllipseAsLocalArea is a convenience function that returns Local2dPointUncertaintyEllipse wrapped in LocalArea.
Local3dPointUncertaintyEllipsoidAsLocalArea is a convenience function that returns Local3dPointUncertaintyEllipsoid wrapped in LocalArea.
NewAccessTokenErr instantiates a new AccessTokenErr 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.
NewAccessTokenErrWithDefaults instantiates a new AccessTokenErr 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.
NewAccessTokenReq instantiates a new AccessTokenReq 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.
NewAccessTokenReqWithDefaults instantiates a new AccessTokenReq 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.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewAreaEventInfo instantiates a new AreaEventInfo 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.
NewAreaEventInfoWithDefaults instantiates a new AreaEventInfo 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.
NewCancelPosInfo instantiates a new CancelPosInfo 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.
NewCancelPosInfoWithDefaults instantiates a new CancelPosInfo 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.
NewCellGlobalId instantiates a new CellGlobalId 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.
NewCellGlobalIdWithDefaults instantiates a new CellGlobalId 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.
NewCivicAddress instantiates a new CivicAddress 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.
NewCivicAddressWithDefaults instantiates a new CivicAddress 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.
NewEcgi instantiates a new Ecgi 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.
NewEcgiWithDefaults instantiates a new Ecgi 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.
NewEllipsoidArc instantiates a new EllipsoidArc 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.
NewEllipsoidArcAllOf instantiates a new EllipsoidArcAllOf 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.
NewEllipsoidArcAllOfWithDefaults instantiates a new EllipsoidArcAllOf 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.
NewEllipsoidArcWithDefaults instantiates a new EllipsoidArc 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.
NewEutraLocation instantiates a new EutraLocation 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.
NewEutraLocationWithDefaults instantiates a new EutraLocation 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.
NewGADShape instantiates a new GADShape 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.
NewGADShapeWithDefaults instantiates a new GADShape 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.
NewGeographicalCoordinates instantiates a new GeographicalCoordinates 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.
NewGeographicalCoordinatesWithDefaults instantiates a new GeographicalCoordinates 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.
NewGNbId instantiates a new GNbId 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.
NewGNbIdWithDefaults instantiates a new GNbId 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.
NewGnssPositioningMethodAndUsage instantiates a new GnssPositioningMethodAndUsage 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.
NewGnssPositioningMethodAndUsageWithDefaults instantiates a new GnssPositioningMethodAndUsage 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.
NewGuami instantiates a new Guami 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.
NewGuamiWithDefaults instantiates a new Guami 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.
NewHfcNodeId instantiates a new HfcNodeId 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.
NewHfcNodeIdWithDefaults instantiates a new HfcNodeId 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.
NewHorizontalVelocity instantiates a new HorizontalVelocity 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.
NewHorizontalVelocityWithDefaults instantiates a new HorizontalVelocity 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.
NewHorizontalVelocityWithUncertainty instantiates a new HorizontalVelocityWithUncertainty 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.
NewHorizontalVelocityWithUncertaintyWithDefaults instantiates a new HorizontalVelocityWithUncertainty 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.
NewHorizontalWithVerticalVelocity instantiates a new HorizontalWithVerticalVelocity 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.
NewHorizontalWithVerticalVelocityAndUncertainty instantiates a new HorizontalWithVerticalVelocityAndUncertainty 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.
NewHorizontalWithVerticalVelocityAndUncertaintyWithDefaults instantiates a new HorizontalWithVerticalVelocityAndUncertainty 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.
NewHorizontalWithVerticalVelocityWithDefaults instantiates a new HorizontalWithVerticalVelocity 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.
NewInvalidParam instantiates a new InvalidParam 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.
NewInvalidParamWithDefaults instantiates a new InvalidParam 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.
NewIpv6Addr instantiates a new Ipv6Addr 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.
NewIpv6AddrWithDefaults instantiates a new Ipv6Addr 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.
NewLocal2dPointUncertaintyEllipse instantiates a new Local2dPointUncertaintyEllipse 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.
NewLocal2dPointUncertaintyEllipseAllOf instantiates a new Local2dPointUncertaintyEllipseAllOf 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.
NewLocal2dPointUncertaintyEllipseAllOfWithDefaults instantiates a new Local2dPointUncertaintyEllipseAllOf 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.
NewLocal2dPointUncertaintyEllipseWithDefaults instantiates a new Local2dPointUncertaintyEllipse 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.
NewLocal3dPointUncertaintyEllipsoid instantiates a new Local3dPointUncertaintyEllipsoid 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.
NewLocal3dPointUncertaintyEllipsoidAllOf instantiates a new Local3dPointUncertaintyEllipsoidAllOf 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.
NewLocal3dPointUncertaintyEllipsoidAllOfWithDefaults instantiates a new Local3dPointUncertaintyEllipsoidAllOf 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.
NewLocal3dPointUncertaintyEllipsoidWithDefaults instantiates a new Local3dPointUncertaintyEllipsoid 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.
NewLocalOrigin instantiates a new LocalOrigin 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.
NewLocalOriginWithDefaults instantiates a new LocalOrigin 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.
NewLocationAreaId instantiates a new LocationAreaId 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.
NewLocationAreaIdWithDefaults instantiates a new LocationAreaId 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.
NewLocationQoS instantiates a new LocationQoS 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.
NewLocationQoSWithDefaults instantiates a new LocationQoS 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.
NewMinorLocationQoS instantiates a new MinorLocationQoS 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.
NewMinorLocationQoSWithDefaults instantiates a new MinorLocationQoS 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.
NewMotionEventInfo instantiates a new MotionEventInfo 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.
NewMotionEventInfoWithDefaults instantiates a new MotionEventInfo 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.
NewN3gaLocation instantiates a new N3gaLocation 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.
NewN3gaLocationWithDefaults instantiates a new N3gaLocation 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.
NewNcgi instantiates a new Ncgi 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.
NewNcgiWithDefaults instantiates a new Ncgi 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.
NewNotifiedPosInfo instantiates a new NotifiedPosInfo 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.
NewNotifiedPosInfoWithDefaults instantiates a new NotifiedPosInfo 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.
NewNrLocation instantiates a new NrLocation 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.
NewNrLocationWithDefaults instantiates a new NrLocation 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
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
NewPeriodicEventInfo instantiates a new PeriodicEventInfo 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.
NewPeriodicEventInfoWithDefaults instantiates a new PeriodicEventInfo 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.
NewPlmnId instantiates a new PlmnId 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.
NewPlmnIdNid instantiates a new PlmnIdNid 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.
NewPlmnIdNidWithDefaults instantiates a new PlmnIdNid 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.
NewPlmnIdWithDefaults instantiates a new PlmnId 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.
NewPoint instantiates a new Point 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.
NewPointAllOf instantiates a new PointAllOf 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.
NewPointAllOfWithDefaults instantiates a new PointAllOf 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.
NewPointAltitude instantiates a new PointAltitude 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.
NewPointAltitudeAllOf instantiates a new PointAltitudeAllOf 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.
NewPointAltitudeAllOfWithDefaults instantiates a new PointAltitudeAllOf 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.
NewPointAltitudeUncertainty instantiates a new PointAltitudeUncertainty 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.
NewPointAltitudeUncertaintyAllOf instantiates a new PointAltitudeUncertaintyAllOf 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.
NewPointAltitudeUncertaintyAllOfWithDefaults instantiates a new PointAltitudeUncertaintyAllOf 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.
NewPointAltitudeUncertaintyWithDefaults instantiates a new PointAltitudeUncertainty 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.
NewPointAltitudeWithDefaults instantiates a new PointAltitude 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.
NewPointUncertaintyCircle instantiates a new PointUncertaintyCircle 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.
NewPointUncertaintyCircleAllOf instantiates a new PointUncertaintyCircleAllOf 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.
NewPointUncertaintyCircleAllOfWithDefaults instantiates a new PointUncertaintyCircleAllOf 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.
NewPointUncertaintyCircleWithDefaults instantiates a new PointUncertaintyCircle 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.
NewPointUncertaintyEllipse instantiates a new PointUncertaintyEllipse 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.
NewPointUncertaintyEllipseAllOf instantiates a new PointUncertaintyEllipseAllOf 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.
NewPointUncertaintyEllipseAllOfWithDefaults instantiates a new PointUncertaintyEllipseAllOf 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.
NewPointUncertaintyEllipseWithDefaults instantiates a new PointUncertaintyEllipse 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.
NewPointWithDefaults instantiates a new Point 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.
NewPolygon instantiates a new Polygon 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.
NewPolygonAllOf instantiates a new PolygonAllOf 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.
NewPolygonAllOfWithDefaults instantiates a new PolygonAllOf 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.
NewPolygonWithDefaults instantiates a new Polygon 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.
NewPositioningMethodAndUsage instantiates a new PositioningMethodAndUsage 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.
NewPositioningMethodAndUsageWithDefaults instantiates a new PositioningMethodAndUsage 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.
NewProblemDetails instantiates a new ProblemDetails 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.
NewProblemDetailsWithDefaults instantiates a new ProblemDetails 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.
NewProvideLocInfo instantiates a new ProvideLocInfo 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.
NewProvideLocInfoWithDefaults instantiates a new ProvideLocInfo 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.
NewProvidePosInfo instantiates a new ProvidePosInfo 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.
NewProvidePosInfoWithDefaults instantiates a new ProvidePosInfo 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.
NewRedirectResponse instantiates a new RedirectResponse 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.
NewRedirectResponseWithDefaults instantiates a new RedirectResponse 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.
NewRelativeCartesianLocation instantiates a new RelativeCartesianLocation 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.
NewRelativeCartesianLocationWithDefaults instantiates a new RelativeCartesianLocation 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.
NewReportingArea instantiates a new ReportingArea 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.
NewReportingAreaWithDefaults instantiates a new ReportingArea 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.
NewRequestLocInfo instantiates a new RequestLocInfo 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.
NewRequestLocInfoWithDefaults instantiates a new RequestLocInfo 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.
NewRequestPosInfo instantiates a new RequestPosInfo 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.
NewRequestPosInfoWithDefaults instantiates a new RequestPosInfo 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.
NewRoutingAreaId instantiates a new RoutingAreaId 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.
NewRoutingAreaIdWithDefaults instantiates a new RoutingAreaId 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.
NewServiceAreaId instantiates a new ServiceAreaId 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.
NewServiceAreaIdWithDefaults instantiates a new ServiceAreaId 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.
NewSnssai instantiates a new Snssai 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.
NewSnssaiWithDefaults instantiates a new Snssai 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.
NewTai instantiates a new Tai 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.
NewTaiWithDefaults instantiates a new Tai 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.
NewTnapId instantiates a new TnapId 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.
NewTnapIdWithDefaults instantiates a new TnapId 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.
NewTwapId instantiates a new TwapId 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.
NewTwapIdWithDefaults instantiates a new TwapId 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.
NewUePrivacyRequirements instantiates a new UePrivacyRequirements 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.
NewUePrivacyRequirementsWithDefaults instantiates a new UePrivacyRequirements 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.
NewUncertaintyEllipse instantiates a new UncertaintyEllipse 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.
NewUncertaintyEllipseWithDefaults instantiates a new UncertaintyEllipse 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.
NewUncertaintyEllipsoid instantiates a new UncertaintyEllipsoid 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.
NewUncertaintyEllipsoidWithDefaults instantiates a new UncertaintyEllipsoid 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.
NewUserLocation instantiates a new UserLocation 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.
NewUserLocationWithDefaults instantiates a new UserLocation 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.
NewVerticalDirectionFromValue returns a pointer to a valid VerticalDirection for the value passed as argument, or an error if the value passed is not allowed by the enum.
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 VerticalDirection.
List of VerticalDirection.

# Variables

All allowed values of VerticalDirection enum.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
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

AccessTokenErr Error returned in the access token response message.
AccessTokenReq Contains information related to the access token request.
AccuracyFulfilmentIndicator Indicates fulfilment of requested accuracy.
No description provided by the author
APIClient manages communication with the Namf_Location API v1.3.0-alpha.1 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
No description provided by the author
APIResponse stores the API response returned by the server.
AreaEventInfo Indicates the information of area based event reporting.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CancelPosInfo Data within a Cancel Location Request.
CellGlobalId Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
CivicAddress Indicates a Civic address.
Configuration stores the configuration of the API client.
Ecgi Contains the ECGI (E-UTRAN Cell Global Identity), as described in 3GPP 23.003.
EllipsoidArc Ellipsoid Arc.
EllipsoidArcAllOf struct for EllipsoidArcAllOf.
EutraLocation Contains the E-UTRA user location.
ExternalClientType Indicates types of External Clients.
GADShape Common base type for GAD shapes.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GeographicalCoordinates Geographical coordinates.
GeographicArea Geographic area specified by different shape.
GeraLocation - Exactly one of cgi, sai or lai shall be present.
GlobalRanNodeId - One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId shall be present.
GNbId Provides the G-NB identifier.
GnssId Global Navigation Satellite System (GNSS) ID.
GnssPositioningMethodAndUsage Indicates the usage of a Global Navigation Satellite System (GNSS) positioning method.
Guami Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.
HfcNodeId REpresents the HFC Node Identifer received over NGAP.
HorizontalVelocity Horizontal velocity.
HorizontalVelocityWithUncertainty Horizontal velocity with speed uncertainty.
HorizontalWithVerticalVelocity Horizontal and vertical velocity.
HorizontalWithVerticalVelocityAndUncertainty Horizontal and vertical velocity with speed uncertainty.
InvalidParam It contains an invalid parameter and a related description.
Ipv6Addr String identifying an IPv6 address formatted according to clause 4 of RFC5952.
LcsPriority Indicates priority of the LCS client.
LcsQosClass Specifies LCS QoS class.
LcsServiceAuth Possible values are: - \"LOCATION_ALLOWED_WITH_NOTIFICATION\": Location allowed with notification - \"LOCATION_ALLOWED_WITHOUT_NOTIFICATION\": Location allowed without notification - \"LOCATION_ALLOWED_WITHOUT_RESPONSE\": Location with notification and privacy verification; location allowed if no response - \"LOCATION_RESTRICTED_WITHOUT_RESPONSE\": Location with notification and privacy verification; location restricted if no response - \"NOTIFICATION_ONLY\": Notification only - \"NOTIFICATION_AND_VERIFICATION_ONLY\": Notification and privacy verification only.
LdrType Indicates LDR types.
LineType Possible values are: - DSL: Identifies a DSL line - PON: Identifies a PON line.
Local2dPointUncertaintyEllipse Local 2D point with uncertainty ellipse.
Local2dPointUncertaintyEllipseAllOf struct for Local2dPointUncertaintyEllipseAllOf.
Local3dPointUncertaintyEllipsoid Local 3D point with uncertainty ellipsoid.
Local3dPointUncertaintyEllipsoidAllOf struct for Local3dPointUncertaintyEllipsoidAllOf.
LocalArea - Local area specified by different shape.
LocalOrigin Indicates a Local origin in a reference system.
LocationAreaId Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
LocationEvent Type of events initiating location procedures.
LocationPrivacyVerResult The result of location privacy verification by UE.
LocationQoS QoS of Location request.
LocationType Type of location measurement requested.
MinorLocationQoS Contain Minor Location QoS.
MotionEventInfo Indicates the information of motion based event reporting.
N3gaLocation Contains the Non-3GPP access user location.
Ncgi Contains the NCGI (NR Cell Global Identity), as described in 3GPP 23.003.
NFType NF types known to NRF.
NotifiedPosInfo Data within EventNotify notification.
NrLocation Contains the NR user location.
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
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
OccurrenceInfo Specifies occurrence of event reporting.
PeriodicEventInfo Indicates the information of periodic event reporting.
PlmnId When PlmnId needs to be converted to string (e.g.
PlmnIdNid Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Point Ellipsoid Point.
PointAllOf struct for PointAllOf.
PointAltitude Ellipsoid point with altitude.
PointAltitudeAllOf struct for PointAltitudeAllOf.
PointAltitudeUncertainty Ellipsoid point with altitude and uncertainty ellipsoid.
PointAltitudeUncertaintyAllOf struct for PointAltitudeUncertaintyAllOf.
PointUncertaintyCircle Ellipsoid point with uncertainty circle.
PointUncertaintyCircleAllOf struct for PointUncertaintyCircleAllOf.
PointUncertaintyEllipse Ellipsoid point with uncertainty ellipse.
PointUncertaintyEllipseAllOf struct for PointUncertaintyEllipseAllOf.
Polygon Polygon.
PolygonAllOf struct for PolygonAllOf.
PositioningMethod Indicates supported positioning methods.
PositioningMethodAndUsage Indicates the usage of a positioning method.
PositioningMode Indicates supported modes used for positioning method.
ProblemDetails Provides additional information in an error response.
ProvideLocInfo Data within Provide Location Information Response.
ProvidePosInfo Data within Provide Positioning Information Response.
RatType Indicates the radio access used.
RedirectResponse The response shall include a Location header field containing a different URI (pointing to a different URI of an other service instance), or the same URI if a request is redirected to the same target resource via a different SCP.
RelativeCartesianLocation Relative Cartesian Location.
ReportingArea Indicates an area for event reporting.
ReportingAreaType Indicates type of event reporting area.
RequestLocInfo Data within Provide Location Information Request.
RequestPosInfo Data within Provide Positioning Information Request.
ResponseTime Indicates acceptable delay of location request.
RoutingAreaId Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ServiceAreaId Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
Snssai When Snssai needs to be converted to string (e.g.
SupportedGADShapes Indicates supported GAD shapes.
Tai Contains the tracking area identity as described in 3GPP 23.003.
TerminationCause Specifies causes of event reporting termination.
TnapId Contain the TNAP Identifier see clause5.6.2 of 3GPP TS 23.501.
TransportProtocol Possible values are: - UDP: User Datagram Protocol.
TwapId Contain the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
UePrivacyRequirements UE privacy requirements from (H)GMLC to the serving AMF or VGMLC(in the roaming case) for the target UE.
UncertaintyEllipse Ellipse with uncertainty.
UncertaintyEllipsoid Ellipsoid with uncertainty.
Usage Indicates usage made of the location measurement.
UserLocation At least one of eutraLocation, nrLocation and n3gaLocation shall be present.
UtraLocation - Exactly one of cgi, sai or lai shall be present.
VelocityEstimate - Velocity estimate.
VelocityRequested Indicates velocity requirement.

# Interfaces

No description provided by the author

# Type aliases

IndividualUEContextDocumentApiService IndividualUEContextDocumentApi service.
ServerConfigurations stores multiple ServerConfiguration items.
VerticalDirection Indicates direction of vertical speed.