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

# README

Go API client for openapi_M1_ContentHostingProvisioning

5GMS AF M1 Content Hosting Provisioning API © 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: 2.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_M1_ContentHostingProvisioning "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_M1_ContentHostingProvisioning"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/3gpp-m1/v2

ClassMethodHTTP requestDescription
DefaultApiCreateContentHostingConfigurationPost /provisioning-sessions/{provisioningSessionId}/content-hosting-configurationCreate (and optionally upload) the Content Hosting Configuration for the specified Provisioning Session
DefaultApiDestroyContentHostingConfigurationDelete /provisioning-sessions/{provisioningSessionId}/content-hosting-configurationDestroy the current Content Hosting Configuration of the specified Provisioning Session
DefaultApiPatchContentHostingConfigurationPatch /provisioning-sessions/{provisioningSessionId}/content-hosting-configurationPatch the Content Hosting Configuration for the specified Provisioning Session
DefaultApiPurgeContentHostingCachePost /provisioning-sessions/{provisioningSessionId}/content-hosting-configuration/purgePurge the content of the cache for the Content Hosting Configuration of the specified Provisioning Session
DefaultApiRetrieveContentHostingConfigurationGet /provisioning-sessions/{provisioningSessionId}/content-hosting-configurationRetrieve the Content Hosting Configuration of the specified Provisioning Session
DefaultApiUpdateContentHostingConfigurationPut /provisioning-sessions/{provisioningSessionId}/content-hosting-configurationUpdate the Content Hosting Configuration for the specified Provisioning Session

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.
NewCachingConfiguration instantiates a new CachingConfiguration 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.
NewCachingConfigurationCachingDirectives instantiates a new CachingConfigurationCachingDirectives 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.
NewCachingConfigurationCachingDirectivesWithDefaults instantiates a new CachingConfigurationCachingDirectives 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.
NewCachingConfigurationWithDefaults instantiates a new CachingConfiguration 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.
NewContentHostingConfiguration instantiates a new ContentHostingConfiguration 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.
NewContentHostingConfigurationWithDefaults instantiates a new ContentHostingConfiguration 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.
NewDistributionConfiguration instantiates a new DistributionConfiguration 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.
NewDistributionConfigurationGeoFencing instantiates a new DistributionConfigurationGeoFencing 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.
NewDistributionConfigurationGeoFencingWithDefaults instantiates a new DistributionConfigurationGeoFencing 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.
NewDistributionConfigurationSupplementaryDistributionNetworksInner instantiates a new DistributionConfigurationSupplementaryDistributionNetworksInner 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.
NewDistributionConfigurationSupplementaryDistributionNetworksInnerWithDefaults instantiates a new DistributionConfigurationSupplementaryDistributionNetworksInner 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.
NewDistributionConfigurationUrlSignature instantiates a new DistributionConfigurationUrlSignature 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.
NewDistributionConfigurationUrlSignatureWithDefaults instantiates a new DistributionConfigurationUrlSignature 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.
NewDistributionConfigurationWithDefaults instantiates a new DistributionConfiguration 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.
NewIngestConfiguration instantiates a new IngestConfiguration 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.
NewIngestConfigurationWithDefaults instantiates a new IngestConfiguration 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
NewPathRewriteRule instantiates a new PathRewriteRule 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.
NewPathRewriteRuleWithDefaults instantiates a new PathRewriteRule 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 M1_ContentHostingProvisioning API v2.1.0 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
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CachingConfiguration A content caching configuration.
CachingConfigurationCachingDirectives struct for CachingConfigurationCachingDirectives.
Configuration stores the configuration of the API client.
ContentHostingConfiguration A representation of a Content Hosting Configuration resource.
DistributionConfiguration A content distribution configuration.
DistributionConfigurationGeoFencing struct for DistributionConfigurationGeoFencing.
DistributionConfigurationSupplementaryDistributionNetworksInner A duple tying a type of supplementary distribution network to its distribution mode.
DistributionConfigurationUrlSignature struct for DistributionConfigurationUrlSignature.
DistributionMode Mode of content distribution.
DistributionNetworkType Type of distribution network.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
IngestConfiguration A configuration for content ingest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PathRewriteRule A rule to manipulate URL paths.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.

# Interfaces

No description provided by the author

# Type aliases

DefaultApiService DefaultApi service.
ServerConfigurations stores multiple ServerConfiguration items.