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

# README

Go API client for openapi_MBSUserServiceAnnouncement

MBS User Service Announcement Element units. © 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
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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

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

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

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

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

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
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.
NewApplicationService instantiates a new ApplicationService 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.
NewApplicationServiceWithDefaults instantiates a new ApplicationService 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.
NewAppServiceDescription instantiates a new AppServiceDescription 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.
NewAppServiceDescriptionIdenticalContentsInner instantiates a new AppServiceDescriptionIdenticalContentsInner 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.
NewAppServiceDescriptionIdenticalContentsInnerWithDefaults instantiates a new AppServiceDescriptionIdenticalContentsInner 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.
NewAppServiceDescriptionWithDefaults instantiates a new AppServiceDescription 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.
NewAssociatedProcedureDescription instantiates a new AssociatedProcedureDescription 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.
NewAssociatedProcedureDescriptionWithDefaults instantiates a new AssociatedProcedureDescription 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.
NewAvailabilityInformationBinding instantiates a new AvailabilityInformationBinding 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.
NewAvailabilityInformationBindingWithDefaults instantiates a new AvailabilityInformationBinding 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.
NewDistributionSessionDescription instantiates a new DistributionSessionDescription 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.
NewDistributionSessionDescriptionUnicastAppServicesInner instantiates a new DistributionSessionDescriptionUnicastAppServicesInner 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.
NewDistributionSessionDescriptionUnicastAppServicesInnerWithDefaults instantiates a new DistributionSessionDescriptionUnicastAppServicesInner 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.
NewDistributionSessionDescriptionWithDefaults instantiates a new DistributionSessionDescription 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.
NewMbsObjectRepair instantiates a new MbsObjectRepair 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.
NewMbsObjectRepairWithDefaults instantiates a new MbsObjectRepair 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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewObjectScheduleInner instantiates a new ObjectScheduleInner 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.
NewObjectScheduleInnerDeliveryInfoInner instantiates a new ObjectScheduleInnerDeliveryInfoInner 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.
NewObjectScheduleInnerDeliveryInfoInnerWithDefaults instantiates a new ObjectScheduleInnerDeliveryInfoInner 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.
NewObjectScheduleInnerWithDefaults instantiates a new ObjectScheduleInner 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.
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.
NewPostObjectRepair instantiates a new PostObjectRepair 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.
NewPostObjectRepairWithDefaults instantiates a new PostObjectRepair 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.
NewServiceSchedule instantiates a new ServiceSchedule 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.
NewServiceScheduleWithDefaults instantiates a new ServiceSchedule 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.
NewSessionScheduleInner instantiates a new SessionScheduleInner 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.
NewSessionScheduleInnerWithDefaults instantiates a new SessionScheduleInner 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.
NewSessionScheduleOverrideInner instantiates a new SessionScheduleOverrideInner 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.
NewSessionScheduleOverrideInnerWithDefaults instantiates a new SessionScheduleOverrideInner 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.
NewUserServiceDescription instantiates a new UserServiceDescription 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.
NewUserServiceDescriptionWithDefaults instantiates a new UserServiceDescription 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

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 MBS User Service Announcement Element units’ definition API v1.1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
ApplicationService struct for ApplicationService.
AppServiceDescription struct for AppServiceDescription.
AppServiceDescriptionIdenticalContentsInner struct for AppServiceDescriptionIdenticalContentsInner.
AssociatedProcedureDescription struct for AssociatedProcedureDescription.
AvailabilityInformationBinding struct for AvailabilityInformationBinding.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
DistributionSessionDescription struct for DistributionSessionDescription.
DistributionSessionDescriptionUnicastAppServicesInner struct for DistributionSessionDescriptionUnicastAppServicesInner.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
MbsObjectRepair struct for MbsObjectRepair.
MbsServiceArea MBS Service Area.
Ncgi Contains the NCGI (NR Cell Global Identity), as described in 3GPP 23.003.
NcgiTai List of NR cell ids, with their pertaining TAIs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ObjectScheduleInner struct for ObjectScheduleInner.
ObjectScheduleInnerDeliveryInfoInner struct for ObjectScheduleInnerDeliveryInfoInner.
PlmnId When PlmnId needs to be converted to string (e.g.
PostObjectRepair struct for PostObjectRepair.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ServiceSchedule struct for ServiceSchedule.
SessionScheduleInner struct for SessionScheduleInner.
SessionScheduleOverrideInner struct for SessionScheduleOverrideInner.
Tai Contains the tracking area identity as described in 3GPP 23.003.
UserServiceDescription struct for UserServiceDescription.

# Interfaces

No description provided by the author

# Type aliases

ServerConfigurations stores multiple ServerConfiguration items.