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

# README

Go API client for openapi_VAE_HDMapDynamicInfo

API for VAE HDMapDynamicInfo 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.1.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_VAE_HDMapDynamicInfo "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_VAE_HDMapDynamicInfo"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/vae-hdmap-dynamic-info/v1

ClassMethodHTTP requestDescription
HdmapDynamicinfoSubscriptionsCollectionDocumentApiCreatePost /subscriptionsVAE_HDMapDynamicInfo resource create service Operation
IndividualHdMapDynamicInfoSubscriptionDocumentApiReadHdMapDynamicInfoSubscriptionGet /subscriptions/{subscriptionId}VAE HdMap DynamicInfo Subscription resource read service Operation
IndividualHdmapDynamicinfoSubscriptionDocumentApiDeleteHdMapDynamicInfoSubscriptionDelete /subscriptions/{subscriptionId}VAE HdMap DynamicInfo Subscription resource delete service Operation

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

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.
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.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
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.
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.
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.
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.
NewHdMapDynamicInfoData instantiates a new HdMapDynamicInfoData 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.
NewHdMapDynamicInfoDataWithDefaults instantiates a new HdMapDynamicInfoData 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.
NewHdMapDynamicInfoNotification instantiates a new HdMapDynamicInfoNotification 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.
NewHdMapDynamicInfoNotificationWithDefaults instantiates a new HdMapDynamicInfoNotification 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.
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.
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.
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.
NewNearbyUeInfo instantiates a new NearbyUeInfo 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.
NewNearbyUeInfoWithDefaults instantiates a new NearbyUeInfo 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
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.
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.
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.
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.
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.
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.
NewWebsockNotifConfig instantiates a new WebsockNotifConfig 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.
NewWebsockNotifConfigWithDefaults instantiates a new WebsockNotifConfig 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.
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.

# Variables

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

APIClient manages communication with the VAE_HDMapDynamicInfo API v1.1.0-alpha.1 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CellGlobalId Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
Configuration stores the configuration of the API client.
Ecgi Contains the ECGI (E-UTRAN Cell Global Identity), as described in 3GPP 23.003.
EutraLocation Contains the E-UTRA user location.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
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.
HdMapDynamicInfoData Represents an individual HdMap DynamicInfo Subscription resource for a V2X UE ID.
HdMapDynamicInfoNotification Represents a notificaton of HD map dynamic info corresponding to the subscription.
HfcNodeId REpresents the HFC Node Identifer received over NGAP.
InvalidParam Represents the description of invalid parameters, for a request rejected due to invalid parameters.
Ipv6Addr String identifying an IPv6 address formatted according to clause 4 of RFC5952.
LineType Possible values are: - DSL: Identifies a DSL line - PON: Identifies a PON line.
LocationAreaId Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
N3gaLocation Contains the Non-3GPP access user location.
Ncgi Contains the NCGI (NR Cell Global Identity), as described in 3GPP 23.003.
NearbyUeInfo Represents the informaiotn of nearby UEs.
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
PlmnId When PlmnId needs to be converted to string (e.g.
ProblemDetails Represents additional information and details on an error response.
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.
Tai Contains the tracking area identity as described in 3GPP 23.003.
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.
UserLocation At least one of eutraLocation, nrLocation and n3gaLocation shall be present.
UtraLocation - Exactly one of cgi, sai or lai shall be present.
WebsockNotifConfig Represents the configuration information for the delivery of notifications over Websockets.

# Interfaces

No description provided by the author

# Type aliases

HdmapDynamicinfoSubscriptionsCollectionDocumentApiService HdmapDynamicinfoSubscriptionsCollectionDocumentApi service.
IndividualHdmapDynamicinfoSubscriptionDocumentApiService IndividualHdmapDynamicinfoSubscriptionDocumentApi service.
IndividualHdMapDynamicInfoSubscriptionDocumentApiService IndividualHdMapDynamicInfoSubscriptionDocumentApi service.
ServerConfigurations stores multiple ServerConfiguration items.