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

# README

Go API client for openapi_Namf_MBSBroadcast

AMF MBSBroadcast 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_Namf_MBSBroadcast "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Namf_MBSBroadcast"

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

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
BroadcastMBSSessionContextsCollectionCollectionApiContextCreatePost /mbs-contextsNamf_MBSBroadcast ContextCreate service Operation
IndividualBroadcastMBSSessionContextDocumentApiContextDeleteDelete /mbs-contexts/{mbsContextRef}Namf_MBSBroadcast ContextDelete service Operation
IndividualBroadcastMBSSessionContextDocumentApiContextUpdatePost /mbs-contexts/{mbsContextRef}/updateNamf_MBSBroadcast ContextUpdate service Operation

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • namf-mbs-bc: Access to the Namf_MBSBroadcast 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.
interface{}AsContextCreateReqData is a convenience function that returns interface{} wrapped in ContextCreateReqData.
interface{}AsGlobalRanNodeId is a convenience function that returns interface{} wrapped in GlobalRanNodeId.
interface{}AsIpAddr is a convenience function that returns interface{} wrapped in IpAddr.
IsNil checks if an input is nil.
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.
NewConfiguration returns a new Configuration object.
NewContextCreateRspData instantiates a new ContextCreateRspData 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.
NewContextCreateRspDataWithDefaults instantiates a new ContextCreateRspData 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.
NewContextStatusNotification instantiates a new ContextStatusNotification 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.
NewContextStatusNotificationWithDefaults instantiates a new ContextStatusNotification 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.
NewContextUpdate200Response instantiates a new ContextUpdate200Response 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.
NewContextUpdate200ResponseWithDefaults instantiates a new ContextUpdate200Response 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.
NewContextUpdateReqData instantiates a new ContextUpdateReqData 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.
NewContextUpdateReqDataWithDefaults instantiates a new ContextUpdateReqData 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.
NewContextUpdateRequest instantiates a new ContextUpdateRequest 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.
NewContextUpdateRequestWithDefaults instantiates a new ContextUpdateRequest 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.
NewContextUpdateRspData instantiates a new ContextUpdateRspData 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.
NewContextUpdateRspDataWithDefaults instantiates a new ContextUpdateRspData 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.
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.
NewIpv6Prefix instantiates a new Ipv6Prefix 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.
NewIpv6PrefixWithDefaults instantiates a new Ipv6Prefix 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.
NewMbsContextsPostRequest instantiates a new MbsContextsPostRequest 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.
NewMbsContextsPostRequestWithDefaults instantiates a new MbsContextsPostRequest 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.
NewMbsServiceAreaInfo instantiates a new MbsServiceAreaInfo 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.
NewMbsServiceAreaInfoWithDefaults instantiates a new MbsServiceAreaInfo 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.
NewN2MbsSmInfo instantiates a new N2MbsSmInfo 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.
NewN2MbsSmInfoWithDefaults instantiates a new N2MbsSmInfo 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.
NewNcgiTai instantiates a new NcgiTai 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.
NewNcgiTaiWithDefaults instantiates a new NcgiTai 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.
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.
NewNgranFailureEvent instantiates a new NgranFailureEvent 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.
NewNgranFailureEventWithDefaults instantiates a new NgranFailureEvent 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
NewOperationEvent instantiates a new OperationEvent 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.
NewOperationEventWithDefaults instantiates a new OperationEvent 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.
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.
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.
NewRefToBinaryData instantiates a new RefToBinaryData 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.
NewRefToBinaryDataWithDefaults instantiates a new RefToBinaryData 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.
NewSsm instantiates a new Ssm 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.
NewSsmWithDefaults instantiates a new Ssm 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.
NewTmgi instantiates a new Tmgi 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.
NewTmgiWithDefaults instantiates a new Tmgi 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

AccessTokenErr Error returned in the access token response message.
AccessTokenReq Contains information related to the access token request.
APIClient manages communication with the Namf_MBSBroadcast 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
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
ContextCreateReqData - Data within ContextCreate Request.
ContextCreateRspData Data within ContextCreate Response.
ContextStatusNotification Data within ContextStatusNotify Request.
ContextUpdate200Response struct for ContextUpdate200Response.
ContextUpdateReqData Data within ContextUpdate Request.
ContextUpdateRequest struct for ContextUpdateRequest.
ContextUpdateRspData Data within ContextUpdate Response.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GlobalRanNodeId - One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId shall be present.
GNbId Provides the G-NB identifier.
InvalidParam It contains an invalid parameter and a related description.
IpAddr - Contains an IP adresse.
Ipv6Addr String identifying an IPv6 address formatted according to clause 4 of RFC5952.
Ipv6Prefix String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952.
MbsContextsPostRequest struct for MbsContextsPostRequest.
MbsServiceArea MBS Service Area.
MbsServiceAreaInfo MBS Service Area Information for location dependent MBS session.
MbsSessionId MBS Session Identifier.
N2MbsSmInfo N2 MBS Session Management information.
Ncgi Contains the NCGI (NR Cell Global Identity), as described in 3GPP 23.003.
NcgiTai List of NR cell ids, with their pertaining TAIs.
NFType NF types known to NRF.
NgapIeType NGAP Information Element Type.
NgranFailureEvent NG-RAN failure event for a NG-RAN.
NgranFailureIndication Indicates a NG-RAN failure event.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OperationEvent Operation Event for a Broadcast MBS Session.
OperationStatus Status of a Broadcast MBS session start or update operation.
OpEventType Operation Event Type.
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.
ProblemDetails Provides additional information in an error response.
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.
RefToBinaryData This parameter provides information about the referenced binary body data.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Snssai When Snssai needs to be converted to string (e.g.
Ssm Source specific IP multicast address.
Tai Contains the tracking area identity as described in 3GPP 23.003.
Tmgi Temporary Mobile Group Identity.

# Interfaces

No description provided by the author

# Type aliases

BroadcastMBSSessionContextsCollectionCollectionApiService BroadcastMBSSessionContextsCollectionCollectionApi service.
IndividualBroadcastMBSSessionContextDocumentApiService IndividualBroadcastMBSSessionContextDocumentApi service.
ServerConfigurations stores multiple ServerConfiguration items.