openapi_M1_ContentProtocolsDiscovery

package
v1.18.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 9, 2023 License: Apache-2.0 Imports: 20 Imported by: 0

README

Go API client for openapi_M1_ContentProtocolsDiscovery

5GMS AF M1 Content Protocols Discovery 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.0.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_ContentProtocolsDiscovery "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_M1_ContentProtocolsDiscovery"

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

Class Method HTTP request Description
DefaultApi RetrieveContentProtocols Get /provisioning-sessions/{provisioningSessionId}/protocols Retrieve the set of Content Protocols supported by 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

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the M1_ContentProtocolsDiscovery API v2.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiRetrieveContentProtocolsRequest

type ApiRetrieveContentProtocolsRequest struct {
	ApiService *DefaultApiService
	// contains filtered or unexported fields
}

func (ApiRetrieveContentProtocolsRequest) Execute

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type ContentProtocolDescriptor

type ContentProtocolDescriptor struct {
	// String providing an URI formatted according to RFC 3986.
	TermIdentifier string `json:"termIdentifier"`
	// Uniform Resource Locator, comforming with the URI Generic Syntax specified in IETF RFC 3986.
	DescriptionLocator *string `json:"descriptionLocator,omitempty"`
}

ContentProtocolDescriptor A descriptor describing a content protocol.

func NewContentProtocolDescriptor

func NewContentProtocolDescriptor(termIdentifier string) *ContentProtocolDescriptor

NewContentProtocolDescriptor instantiates a new ContentProtocolDescriptor 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

func NewContentProtocolDescriptorWithDefaults

func NewContentProtocolDescriptorWithDefaults() *ContentProtocolDescriptor

NewContentProtocolDescriptorWithDefaults instantiates a new ContentProtocolDescriptor 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

func (*ContentProtocolDescriptor) GetDescriptionLocator

func (o *ContentProtocolDescriptor) GetDescriptionLocator() string

GetDescriptionLocator returns the DescriptionLocator field value if set, zero value otherwise.

func (*ContentProtocolDescriptor) GetDescriptionLocatorOk

func (o *ContentProtocolDescriptor) GetDescriptionLocatorOk() (*string, bool)

GetDescriptionLocatorOk returns a tuple with the DescriptionLocator field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentProtocolDescriptor) GetTermIdentifier

func (o *ContentProtocolDescriptor) GetTermIdentifier() string

GetTermIdentifier returns the TermIdentifier field value

func (*ContentProtocolDescriptor) GetTermIdentifierOk

func (o *ContentProtocolDescriptor) GetTermIdentifierOk() (*string, bool)

GetTermIdentifierOk returns a tuple with the TermIdentifier field value and a boolean to check if the value has been set.

func (*ContentProtocolDescriptor) HasDescriptionLocator

func (o *ContentProtocolDescriptor) HasDescriptionLocator() bool

HasDescriptionLocator returns a boolean if a field has been set.

func (ContentProtocolDescriptor) MarshalJSON

func (o ContentProtocolDescriptor) MarshalJSON() ([]byte, error)

func (*ContentProtocolDescriptor) SetDescriptionLocator

func (o *ContentProtocolDescriptor) SetDescriptionLocator(v string)

SetDescriptionLocator gets a reference to the given string and assigns it to the DescriptionLocator field.

func (*ContentProtocolDescriptor) SetTermIdentifier

func (o *ContentProtocolDescriptor) SetTermIdentifier(v string)

SetTermIdentifier sets field value

func (ContentProtocolDescriptor) ToMap

func (o ContentProtocolDescriptor) ToMap() (map[string]interface{}, error)

type ContentProtocols

type ContentProtocols struct {
	DownlinkIngestProtocols []ContentProtocolDescriptor `json:"downlinkIngestProtocols,omitempty"`
	UplinkEgestProtocols    []ContentProtocolDescriptor `json:"uplinkEgestProtocols,omitempty"`
	GeoFencingLocatorTypes  []string                    `json:"geoFencingLocatorTypes,omitempty"`
}

ContentProtocols A representation of the Content Protocols resource.

func NewContentProtocols

func NewContentProtocols() *ContentProtocols

NewContentProtocols instantiates a new ContentProtocols 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

func NewContentProtocolsWithDefaults

func NewContentProtocolsWithDefaults() *ContentProtocols

NewContentProtocolsWithDefaults instantiates a new ContentProtocols 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

func (*ContentProtocols) GetDownlinkIngestProtocols

func (o *ContentProtocols) GetDownlinkIngestProtocols() []ContentProtocolDescriptor

GetDownlinkIngestProtocols returns the DownlinkIngestProtocols field value if set, zero value otherwise.

func (*ContentProtocols) GetDownlinkIngestProtocolsOk

func (o *ContentProtocols) GetDownlinkIngestProtocolsOk() ([]ContentProtocolDescriptor, bool)

GetDownlinkIngestProtocolsOk returns a tuple with the DownlinkIngestProtocols field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentProtocols) GetGeoFencingLocatorTypes

func (o *ContentProtocols) GetGeoFencingLocatorTypes() []string

GetGeoFencingLocatorTypes returns the GeoFencingLocatorTypes field value if set, zero value otherwise.

func (*ContentProtocols) GetGeoFencingLocatorTypesOk

func (o *ContentProtocols) GetGeoFencingLocatorTypesOk() ([]string, bool)

GetGeoFencingLocatorTypesOk returns a tuple with the GeoFencingLocatorTypes field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentProtocols) GetUplinkEgestProtocols

func (o *ContentProtocols) GetUplinkEgestProtocols() []ContentProtocolDescriptor

GetUplinkEgestProtocols returns the UplinkEgestProtocols field value if set, zero value otherwise.

func (*ContentProtocols) GetUplinkEgestProtocolsOk

func (o *ContentProtocols) GetUplinkEgestProtocolsOk() ([]ContentProtocolDescriptor, bool)

GetUplinkEgestProtocolsOk returns a tuple with the UplinkEgestProtocols field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ContentProtocols) HasDownlinkIngestProtocols

func (o *ContentProtocols) HasDownlinkIngestProtocols() bool

HasDownlinkIngestProtocols returns a boolean if a field has been set.

func (*ContentProtocols) HasGeoFencingLocatorTypes

func (o *ContentProtocols) HasGeoFencingLocatorTypes() bool

HasGeoFencingLocatorTypes returns a boolean if a field has been set.

func (*ContentProtocols) HasUplinkEgestProtocols

func (o *ContentProtocols) HasUplinkEgestProtocols() bool

HasUplinkEgestProtocols returns a boolean if a field has been set.

func (ContentProtocols) MarshalJSON

func (o ContentProtocols) MarshalJSON() ([]byte, error)

func (*ContentProtocols) SetDownlinkIngestProtocols

func (o *ContentProtocols) SetDownlinkIngestProtocols(v []ContentProtocolDescriptor)

SetDownlinkIngestProtocols gets a reference to the given []ContentProtocolDescriptor and assigns it to the DownlinkIngestProtocols field.

func (*ContentProtocols) SetGeoFencingLocatorTypes

func (o *ContentProtocols) SetGeoFencingLocatorTypes(v []string)

SetGeoFencingLocatorTypes gets a reference to the given []string and assigns it to the GeoFencingLocatorTypes field.

func (*ContentProtocols) SetUplinkEgestProtocols

func (o *ContentProtocols) SetUplinkEgestProtocols(v []ContentProtocolDescriptor)

SetUplinkEgestProtocols gets a reference to the given []ContentProtocolDescriptor and assigns it to the UplinkEgestProtocols field.

func (ContentProtocols) ToMap

func (o ContentProtocols) ToMap() (map[string]interface{}, error)

type DefaultApiService

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) RetrieveContentProtocols

func (a *DefaultApiService) RetrieveContentProtocols(ctx context.Context, provisioningSessionId string) ApiRetrieveContentProtocolsRequest

RetrieveContentProtocols Retrieve the set of Content Protocols supported by the specified Provisioning Session

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param provisioningSessionId The resource identifier of an existing Provisioning Session.
@return ApiRetrieveContentProtocolsRequest

func (*DefaultApiService) RetrieveContentProtocolsExecute

func (a *DefaultApiService) RetrieveContentProtocolsExecute(r ApiRetrieveContentProtocolsRequest) (*ContentProtocols, *http.Response, error)

Execute executes the request

@return ContentProtocols

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type MappedNullable

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBool

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableContentProtocolDescriptor

type NullableContentProtocolDescriptor struct {
	// contains filtered or unexported fields
}

func (NullableContentProtocolDescriptor) Get

func (NullableContentProtocolDescriptor) IsSet

func (NullableContentProtocolDescriptor) MarshalJSON

func (v NullableContentProtocolDescriptor) MarshalJSON() ([]byte, error)

func (*NullableContentProtocolDescriptor) Set

func (*NullableContentProtocolDescriptor) UnmarshalJSON

func (v *NullableContentProtocolDescriptor) UnmarshalJSON(src []byte) error

func (*NullableContentProtocolDescriptor) Unset

type NullableContentProtocols

type NullableContentProtocols struct {
	// contains filtered or unexported fields
}

func NewNullableContentProtocols

func NewNullableContentProtocols(val *ContentProtocols) *NullableContentProtocols

func (NullableContentProtocols) Get

func (NullableContentProtocols) IsSet

func (v NullableContentProtocols) IsSet() bool

func (NullableContentProtocols) MarshalJSON

func (v NullableContentProtocols) MarshalJSON() ([]byte, error)

func (*NullableContentProtocols) Set

func (*NullableContentProtocols) UnmarshalJSON

func (v *NullableContentProtocols) UnmarshalJSON(src []byte) error

func (*NullableContentProtocols) Unset

func (v *NullableContentProtocols) Unset()

type NullableFloat32

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableInt

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableString

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL