OpenAPI_ApplyingBdtPolicy

package
v0.0.0-...-e403a3c Latest Latest
Warning

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

 Go to latest Published: Dec 22, 2023 License: MIT Imports: 21 Imported by: 0

README

Go API client for OpenAPI_ApplyingBdtPolicy

API for applying BDT policy
© 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.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_ApplyingBdtPolicy "gitee.com/konglinglong/openapi/OpenAPI_ApplyingBdtPolicy"

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 OpenAPI_ApplyingBdtPolicy.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), OpenAPI_ApplyingBdtPolicy.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value OpenAPI_ApplyingBdtPolicy.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), OpenAPI_ApplyingBdtPolicy.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 OpenAPI_ApplyingBdtPolicy.ContextOperationServerIndices and OpenAPI_ApplyingBdtPolicy.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), OpenAPI_ApplyingBdtPolicy.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), OpenAPI_ApplyingBdtPolicy.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://example.com/3gpp-applying-bdt-policy/v1

Class Method HTTP request Description
AppliedBDTPolicySubscriptionAPI CreateNewSubscription Post /{afId}/subscriptions Creates a new subscription resource
AppliedBDTPolicySubscriptionAPI ReadAllSubscriptions Get /{afId}/subscriptions read all of the active subscriptions for the AF
IndividualAppliedBDTPolicySubscriptionAPI DeleteAnSubscription Delete /{afId}/subscriptions/{subscriptionId} Deletes an already existing subscription
IndividualAppliedBDTPolicySubscriptionAPI PartialUpdateAnSubscription Patch /{afId}/subscriptions/{subscriptionId} Partial updates/replaces an existing subscription resource
IndividualAppliedBDTPolicySubscriptionAPI ReadAnSubscription Get /{afId}/subscriptions/{subscriptionId} read an active subscriptions for the SCS/AS and the subscription Id

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

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

Example

auth := context.WithValue(context.Background(), OpenAPI_ApplyingBdtPolicy.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, OpenAPI_ApplyingBdtPolicy.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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// 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 {
	AppliedBDTPolicySubscriptionAPI *AppliedBDTPolicySubscriptionAPIService

	IndividualAppliedBDTPolicySubscriptionAPI *IndividualAppliedBDTPolicySubscriptionAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the 3gpp-applying-bdt-policy API v1.1.1 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 ApiCreateNewSubscriptionRequest 

type ApiCreateNewSubscriptionRequest struct {
	ApiService *AppliedBDTPolicySubscriptionAPIService
	// contains filtered or unexported fields
}

func (ApiCreateNewSubscriptionRequest) AppliedBdtPolicy 

func (r ApiCreateNewSubscriptionRequest) AppliedBdtPolicy(appliedBdtPolicy AppliedBdtPolicy) ApiCreateNewSubscriptionRequest

Request to create a new subscription resource

func (ApiCreateNewSubscriptionRequest) Execute 

func (r ApiCreateNewSubscriptionRequest) Execute() (*AppliedBdtPolicy, *http.Response, error)

type ApiDeleteAnSubscriptionRequest 

type ApiDeleteAnSubscriptionRequest struct {
	ApiService *IndividualAppliedBDTPolicySubscriptionAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteAnSubscriptionRequest) Execute 

func (r ApiDeleteAnSubscriptionRequest) Execute() (*http.Response, error)

type ApiPartialUpdateAnSubscriptionRequest 

type ApiPartialUpdateAnSubscriptionRequest struct {
	ApiService *IndividualAppliedBDTPolicySubscriptionAPIService
	// contains filtered or unexported fields
}

func (ApiPartialUpdateAnSubscriptionRequest) AppliedBdtPolicyPatch 

func (r ApiPartialUpdateAnSubscriptionRequest) AppliedBdtPolicyPatch(appliedBdtPolicyPatch AppliedBdtPolicyPatch) ApiPartialUpdateAnSubscriptionRequest

func (ApiPartialUpdateAnSubscriptionRequest) Execute 

func (r ApiPartialUpdateAnSubscriptionRequest) Execute() (*AppliedBdtPolicy, *http.Response, error)

type ApiReadAllSubscriptionsRequest 

type ApiReadAllSubscriptionsRequest struct {
	ApiService *AppliedBDTPolicySubscriptionAPIService
	// contains filtered or unexported fields
}

func (ApiReadAllSubscriptionsRequest) Execute 

func (r ApiReadAllSubscriptionsRequest) Execute() ([]AppliedBdtPolicy, *http.Response, error)

type ApiReadAnSubscriptionRequest 

type ApiReadAnSubscriptionRequest struct {
	ApiService *IndividualAppliedBDTPolicySubscriptionAPIService
	// contains filtered or unexported fields
}

func (ApiReadAnSubscriptionRequest) Execute 

func (r ApiReadAnSubscriptionRequest) Execute() (*AppliedBdtPolicy, *http.Response, error)

type AppliedBDTPolicySubscriptionAPIService 

type AppliedBDTPolicySubscriptionAPIService service

AppliedBDTPolicySubscriptionAPIService AppliedBDTPolicySubscriptionAPI service

func (*AppliedBDTPolicySubscriptionAPIService) CreateNewSubscription 

func (a *AppliedBDTPolicySubscriptionAPIService) CreateNewSubscription(ctx context.Context, afId string) ApiCreateNewSubscriptionRequest

CreateNewSubscription Creates a new subscription resource 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param afId Identifier of the AF
@return ApiCreateNewSubscriptionRequest

func (*AppliedBDTPolicySubscriptionAPIService) CreateNewSubscriptionExecute 

func (a *AppliedBDTPolicySubscriptionAPIService) CreateNewSubscriptionExecute(r ApiCreateNewSubscriptionRequest) (*AppliedBdtPolicy, *http.Response, error)

Execute executes the request 

@return AppliedBdtPolicy

func (*AppliedBDTPolicySubscriptionAPIService) ReadAllSubscriptions 

func (a *AppliedBDTPolicySubscriptionAPIService) ReadAllSubscriptions(ctx context.Context, afId string) ApiReadAllSubscriptionsRequest

ReadAllSubscriptions read all of the active subscriptions for the AF 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param afId Identifier of the AF
@return ApiReadAllSubscriptionsRequest

func (*AppliedBDTPolicySubscriptionAPIService) ReadAllSubscriptionsExecute 

func (a *AppliedBDTPolicySubscriptionAPIService) ReadAllSubscriptionsExecute(r ApiReadAllSubscriptionsRequest) ([]AppliedBdtPolicy, *http.Response, error)

Execute executes the request 

@return []AppliedBdtPolicy

type AppliedBdtPolicy 

type AppliedBdtPolicy struct {
	// string containing a local identifier followed by \"@\" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any \"@\" characters. See Clauses 4.6.2 and 4.6.3 of 3GPP TS 23.682 for more information.
	ExternalGroupId *string `json:"externalGroupId,omitempty"`
	// String identifying a Gpsi shall contain either an External Id or an MSISDN.  It shall be formatted as follows -External Identifier= \"extid-'extid', where 'extid'  shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an  External Identifier.
	Gpsi *string `json:"gpsi,omitempty"`
	// string identifying a BDT Reference ID as defined in clause 5.3.3 of 3GPP TS 29.154.
	BdtRefId string `json:"bdtRefId"`
	// A string used to indicate the features supported by an API that is used as defined in clause  6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in  hexadecimal representation Each character in the string shall take a value of \"0\" to \"9\",  \"a\" to \"f\" or \"A\" to \"F\" and shall represent the support of 4 features as described in  table 5.2.2-3. The most significant character representing the highest-numbered features shall  appear first in the string, and the character representing features 1 to 4 shall appear last  in the string. The list of features and their numbering (starting with 1) are defined  separately for each API. If the string contains a lower number of characters than there are  defined features for an API, all features that would be represented by characters that are not  present in the string are not supported.
	SuppFeat string `json:"suppFeat"`
	// string formatted according to IETF RFC 3986 identifying a referenced resource.
	Self *string `json:"self,omitempty"`
}

AppliedBdtPolicy Represents an applied BDT policy.

func NewAppliedBdtPolicy 

func NewAppliedBdtPolicy(bdtRefId string, suppFeat string) *AppliedBdtPolicy

NewAppliedBdtPolicy instantiates a new AppliedBdtPolicy 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 NewAppliedBdtPolicyWithDefaults 

func NewAppliedBdtPolicyWithDefaults() *AppliedBdtPolicy

NewAppliedBdtPolicyWithDefaults instantiates a new AppliedBdtPolicy 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 (*AppliedBdtPolicy) GetBdtRefId 

func (o *AppliedBdtPolicy) GetBdtRefId() string

GetBdtRefId returns the BdtRefId field value

func (*AppliedBdtPolicy) GetBdtRefIdOk 

func (o *AppliedBdtPolicy) GetBdtRefIdOk() (*string, bool)

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

func (*AppliedBdtPolicy) GetExternalGroupId 

func (o *AppliedBdtPolicy) GetExternalGroupId() string

GetExternalGroupId returns the ExternalGroupId field value if set, zero value otherwise.

func (*AppliedBdtPolicy) GetExternalGroupIdOk 

func (o *AppliedBdtPolicy) GetExternalGroupIdOk() (*string, bool)

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

func (*AppliedBdtPolicy) GetGpsi 

func (o *AppliedBdtPolicy) GetGpsi() string

GetGpsi returns the Gpsi field value if set, zero value otherwise.

func (*AppliedBdtPolicy) GetGpsiOk 

func (o *AppliedBdtPolicy) GetGpsiOk() (*string, bool)

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

func (*AppliedBdtPolicy) GetSelf 

func (o *AppliedBdtPolicy) GetSelf() string

GetSelf returns the Self field value if set, zero value otherwise.

func (*AppliedBdtPolicy) GetSelfOk 

func (o *AppliedBdtPolicy) GetSelfOk() (*string, bool)

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

func (*AppliedBdtPolicy) GetSuppFeat 

func (o *AppliedBdtPolicy) GetSuppFeat() string

GetSuppFeat returns the SuppFeat field value

func (*AppliedBdtPolicy) GetSuppFeatOk 

func (o *AppliedBdtPolicy) GetSuppFeatOk() (*string, bool)

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

func (*AppliedBdtPolicy) HasExternalGroupId 

func (o *AppliedBdtPolicy) HasExternalGroupId() bool

HasExternalGroupId returns a boolean if a field has been set.

func (*AppliedBdtPolicy) HasGpsi 

func (o *AppliedBdtPolicy) HasGpsi() bool

HasGpsi returns a boolean if a field has been set.

func (*AppliedBdtPolicy) HasSelf 

func (o *AppliedBdtPolicy) HasSelf() bool

HasSelf returns a boolean if a field has been set.

func (AppliedBdtPolicy) MarshalJSON 

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

func (*AppliedBdtPolicy) SetBdtRefId 

func (o *AppliedBdtPolicy) SetBdtRefId(v string)

SetBdtRefId sets field value

func (*AppliedBdtPolicy) SetExternalGroupId 

func (o *AppliedBdtPolicy) SetExternalGroupId(v string)

SetExternalGroupId gets a reference to the given string and assigns it to the ExternalGroupId field.

func (*AppliedBdtPolicy) SetGpsi 

func (o *AppliedBdtPolicy) SetGpsi(v string)

SetGpsi gets a reference to the given string and assigns it to the Gpsi field.

func (*AppliedBdtPolicy) SetSelf 

func (o *AppliedBdtPolicy) SetSelf(v string)

SetSelf gets a reference to the given string and assigns it to the Self field.

func (*AppliedBdtPolicy) SetSuppFeat 

func (o *AppliedBdtPolicy) SetSuppFeat(v string)

SetSuppFeat sets field value

func (AppliedBdtPolicy) ToMap 

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

func (*AppliedBdtPolicy) UnmarshalJSON 

func (o *AppliedBdtPolicy) UnmarshalJSON(bytes []byte) (err error)

type AppliedBdtPolicyPatch 

type AppliedBdtPolicyPatch struct {
	// string identifying a BDT Reference ID as defined in clause 5.3.3 of 3GPP TS 29.154.
	BdtRefId string `json:"bdtRefId"`
}

AppliedBdtPolicyPatch Represents the parameters to request the modification of a subscription to applied BDT policy.

func NewAppliedBdtPolicyPatch 

func NewAppliedBdtPolicyPatch(bdtRefId string) *AppliedBdtPolicyPatch

NewAppliedBdtPolicyPatch instantiates a new AppliedBdtPolicyPatch 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 NewAppliedBdtPolicyPatchWithDefaults 

func NewAppliedBdtPolicyPatchWithDefaults() *AppliedBdtPolicyPatch

NewAppliedBdtPolicyPatchWithDefaults instantiates a new AppliedBdtPolicyPatch 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 (*AppliedBdtPolicyPatch) GetBdtRefId 

func (o *AppliedBdtPolicyPatch) GetBdtRefId() string

GetBdtRefId returns the BdtRefId field value

func (*AppliedBdtPolicyPatch) GetBdtRefIdOk 

func (o *AppliedBdtPolicyPatch) GetBdtRefIdOk() (*string, bool)

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

func (AppliedBdtPolicyPatch) MarshalJSON 

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

func (*AppliedBdtPolicyPatch) SetBdtRefId 

func (o *AppliedBdtPolicyPatch) SetBdtRefId(v string)

SetBdtRefId sets field value

func (AppliedBdtPolicyPatch) ToMap 

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

func (*AppliedBdtPolicyPatch) UnmarshalJSON 

func (o *AppliedBdtPolicyPatch) UnmarshalJSON(bytes []byte) (err error)

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 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 IndividualAppliedBDTPolicySubscriptionAPIService 

type IndividualAppliedBDTPolicySubscriptionAPIService service

IndividualAppliedBDTPolicySubscriptionAPIService IndividualAppliedBDTPolicySubscriptionAPI service

func (*IndividualAppliedBDTPolicySubscriptionAPIService) DeleteAnSubscription 

func (a *IndividualAppliedBDTPolicySubscriptionAPIService) DeleteAnSubscription(ctx context.Context, afId string, subscriptionId string) ApiDeleteAnSubscriptionRequest

DeleteAnSubscription Deletes an already existing subscription 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param afId Identifier of the AF
@param subscriptionId Identifier of the subscription resource
@return ApiDeleteAnSubscriptionRequest

func (*IndividualAppliedBDTPolicySubscriptionAPIService) DeleteAnSubscriptionExecute 

func (a *IndividualAppliedBDTPolicySubscriptionAPIService) DeleteAnSubscriptionExecute(r ApiDeleteAnSubscriptionRequest) (*http.Response, error)

Execute executes the request

func (*IndividualAppliedBDTPolicySubscriptionAPIService) PartialUpdateAnSubscription 

func (a *IndividualAppliedBDTPolicySubscriptionAPIService) PartialUpdateAnSubscription(ctx context.Context, afId string, subscriptionId string) ApiPartialUpdateAnSubscriptionRequest

PartialUpdateAnSubscription Partial updates/replaces an existing subscription resource 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param afId Identifier of the AF
@param subscriptionId Identifier of the subscription resource
@return ApiPartialUpdateAnSubscriptionRequest

func (*IndividualAppliedBDTPolicySubscriptionAPIService) PartialUpdateAnSubscriptionExecute 

func (a *IndividualAppliedBDTPolicySubscriptionAPIService) PartialUpdateAnSubscriptionExecute(r ApiPartialUpdateAnSubscriptionRequest) (*AppliedBdtPolicy, *http.Response, error)

Execute executes the request 

@return AppliedBdtPolicy

func (*IndividualAppliedBDTPolicySubscriptionAPIService) ReadAnSubscription 

func (a *IndividualAppliedBDTPolicySubscriptionAPIService) ReadAnSubscription(ctx context.Context, afId string, subscriptionId string) ApiReadAnSubscriptionRequest

ReadAnSubscription read an active subscriptions for the SCS/AS and the subscription Id 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param afId Identifier of the AF
@param subscriptionId Identifier of the subscription resource
@return ApiReadAnSubscriptionRequest

func (*IndividualAppliedBDTPolicySubscriptionAPIService) ReadAnSubscriptionExecute 

func (a *IndividualAppliedBDTPolicySubscriptionAPIService) ReadAnSubscriptionExecute(r ApiReadAnSubscriptionRequest) (*AppliedBdtPolicy, *http.Response, error)

Execute executes the request 

@return AppliedBdtPolicy

type InvalidParam 

type InvalidParam struct {
	// Attribute's name encoded as a JSON Pointer, or header's name.
	Param string `json:"param"`
	// A human-readable reason, e.g. \"must be a positive integer\".
	Reason *string `json:"reason,omitempty"`
}

InvalidParam Represents the description of invalid parameters, for a request rejected due to invalid parameters.

func NewInvalidParam 

func NewInvalidParam(param string) *InvalidParam

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

func NewInvalidParamWithDefaults 

func NewInvalidParamWithDefaults() *InvalidParam

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

func (*InvalidParam) GetParam 

func (o *InvalidParam) GetParam() string

GetParam returns the Param field value

func (*InvalidParam) GetParamOk 

func (o *InvalidParam) GetParamOk() (*string, bool)

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

func (*InvalidParam) GetReason 

func (o *InvalidParam) GetReason() string

GetReason returns the Reason field value if set, zero value otherwise.

func (*InvalidParam) GetReasonOk 

func (o *InvalidParam) GetReasonOk() (*string, bool)

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

func (*InvalidParam) HasReason 

func (o *InvalidParam) HasReason() bool

HasReason returns a boolean if a field has been set.

func (InvalidParam) MarshalJSON 

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

func (*InvalidParam) SetParam 

func (o *InvalidParam) SetParam(v string)

SetParam sets field value

func (*InvalidParam) SetReason 

func (o *InvalidParam) SetReason(v string)

SetReason gets a reference to the given string and assigns it to the Reason field.

func (InvalidParam) ToMap 

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

func (*InvalidParam) UnmarshalJSON 

func (o *InvalidParam) UnmarshalJSON(bytes []byte) (err error)

type MappedNullable 

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

type NullableAppliedBdtPolicy 

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

func NewNullableAppliedBdtPolicy 

func NewNullableAppliedBdtPolicy(val *AppliedBdtPolicy) *NullableAppliedBdtPolicy

func (NullableAppliedBdtPolicy) Get 

func (v NullableAppliedBdtPolicy) Get() *AppliedBdtPolicy

func (NullableAppliedBdtPolicy) IsSet 

func (v NullableAppliedBdtPolicy) IsSet() bool

func (NullableAppliedBdtPolicy) MarshalJSON 

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

func (*NullableAppliedBdtPolicy) Set 

func (v *NullableAppliedBdtPolicy) Set(val *AppliedBdtPolicy)

func (*NullableAppliedBdtPolicy) UnmarshalJSON 

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

func (*NullableAppliedBdtPolicy) Unset 

func (v *NullableAppliedBdtPolicy) Unset()

type NullableAppliedBdtPolicyPatch 

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

func NewNullableAppliedBdtPolicyPatch 

func NewNullableAppliedBdtPolicyPatch(val *AppliedBdtPolicyPatch) *NullableAppliedBdtPolicyPatch

func (NullableAppliedBdtPolicyPatch) Get 

func (v NullableAppliedBdtPolicyPatch) Get() *AppliedBdtPolicyPatch

func (NullableAppliedBdtPolicyPatch) IsSet 

func (v NullableAppliedBdtPolicyPatch) IsSet() bool

func (NullableAppliedBdtPolicyPatch) MarshalJSON 

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

func (*NullableAppliedBdtPolicyPatch) Set 

func (v *NullableAppliedBdtPolicyPatch) Set(val *AppliedBdtPolicyPatch)

func (*NullableAppliedBdtPolicyPatch) UnmarshalJSON 

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

func (*NullableAppliedBdtPolicyPatch) Unset 

func (v *NullableAppliedBdtPolicyPatch) Unset()

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 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 NullableInvalidParam 

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

func NewNullableInvalidParam 

func NewNullableInvalidParam(val *InvalidParam) *NullableInvalidParam

func (NullableInvalidParam) Get 

func (v NullableInvalidParam) Get() *InvalidParam

func (NullableInvalidParam) IsSet 

func (v NullableInvalidParam) IsSet() bool

func (NullableInvalidParam) MarshalJSON 

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

func (*NullableInvalidParam) Set 

func (v *NullableInvalidParam) Set(val *InvalidParam)

func (*NullableInvalidParam) UnmarshalJSON 

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

func (*NullableInvalidParam) Unset 

func (v *NullableInvalidParam) Unset()

type NullableProblemDetails 

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

func NewNullableProblemDetails 

func NewNullableProblemDetails(val *ProblemDetails) *NullableProblemDetails

func (NullableProblemDetails) Get 

func (v NullableProblemDetails) Get() *ProblemDetails

func (NullableProblemDetails) IsSet 

func (v NullableProblemDetails) IsSet() bool

func (NullableProblemDetails) MarshalJSON 

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

func (*NullableProblemDetails) Set 

func (v *NullableProblemDetails) Set(val *ProblemDetails)

func (*NullableProblemDetails) UnmarshalJSON 

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

func (*NullableProblemDetails) Unset 

func (v *NullableProblemDetails) 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 ProblemDetails 

type ProblemDetails struct {
	// string providing an URI formatted according to IETF RFC 3986.
	Type *string `json:"type,omitempty"`
	// A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.
	Title *string `json:"title,omitempty"`
	// The HTTP status code for this occurrence of the problem.
	Status *int32 `json:"status,omitempty"`
	// A human-readable explanation specific to this occurrence of the problem.
	Detail *string `json:"detail,omitempty"`
	// string providing an URI formatted according to IETF RFC 3986.
	Instance *string `json:"instance,omitempty"`
	// A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.
	Cause *string `json:"cause,omitempty"`
	// Description of invalid parameters, for a request rejected due to invalid parameters.
	InvalidParams []InvalidParam `json:"invalidParams,omitempty"`
	// A string used to indicate the features supported by an API that is used as defined in clause  6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in  hexadecimal representation Each character in the string shall take a value of \"0\" to \"9\",  \"a\" to \"f\" or \"A\" to \"F\" and shall represent the support of 4 features as described in  table 5.2.2-3. The most significant character representing the highest-numbered features shall  appear first in the string, and the character representing features 1 to 4 shall appear last  in the string. The list of features and their numbering (starting with 1) are defined  separately for each API. If the string contains a lower number of characters than there are  defined features for an API, all features that would be represented by characters that are not  present in the string are not supported.
	SupportedFeatures *string `json:"supportedFeatures,omitempty"`
}

ProblemDetails Represents additional information and details on an error response.

func NewProblemDetails 

func NewProblemDetails() *ProblemDetails

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

func NewProblemDetailsWithDefaults 

func NewProblemDetailsWithDefaults() *ProblemDetails

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

func (*ProblemDetails) GetCause 

func (o *ProblemDetails) GetCause() string

GetCause returns the Cause field value if set, zero value otherwise.

func (*ProblemDetails) GetCauseOk 

func (o *ProblemDetails) GetCauseOk() (*string, bool)

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

func (*ProblemDetails) GetDetail 

func (o *ProblemDetails) GetDetail() string

GetDetail returns the Detail field value if set, zero value otherwise.

func (*ProblemDetails) GetDetailOk 

func (o *ProblemDetails) GetDetailOk() (*string, bool)

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

func (*ProblemDetails) GetInstance 

func (o *ProblemDetails) GetInstance() string

GetInstance returns the Instance field value if set, zero value otherwise.

func (*ProblemDetails) GetInstanceOk 

func (o *ProblemDetails) GetInstanceOk() (*string, bool)

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

func (*ProblemDetails) GetInvalidParams 

func (o *ProblemDetails) GetInvalidParams() []InvalidParam

GetInvalidParams returns the InvalidParams field value if set, zero value otherwise.

func (*ProblemDetails) GetInvalidParamsOk 

func (o *ProblemDetails) GetInvalidParamsOk() ([]InvalidParam, bool)

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

func (*ProblemDetails) GetStatus 

func (o *ProblemDetails) GetStatus() int32

GetStatus returns the Status field value if set, zero value otherwise.

func (*ProblemDetails) GetStatusOk 

func (o *ProblemDetails) GetStatusOk() (*int32, bool)

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

func (*ProblemDetails) GetSupportedFeatures 

func (o *ProblemDetails) GetSupportedFeatures() string

GetSupportedFeatures returns the SupportedFeatures field value if set, zero value otherwise.

func (*ProblemDetails) GetSupportedFeaturesOk 

func (o *ProblemDetails) GetSupportedFeaturesOk() (*string, bool)

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

func (*ProblemDetails) GetTitle 

func (o *ProblemDetails) GetTitle() string

GetTitle returns the Title field value if set, zero value otherwise.

func (*ProblemDetails) GetTitleOk 

func (o *ProblemDetails) GetTitleOk() (*string, bool)

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

func (*ProblemDetails) GetType 

func (o *ProblemDetails) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*ProblemDetails) GetTypeOk 

func (o *ProblemDetails) GetTypeOk() (*string, bool)

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

func (*ProblemDetails) HasCause 

func (o *ProblemDetails) HasCause() bool

HasCause returns a boolean if a field has been set.

func (*ProblemDetails) HasDetail 

func (o *ProblemDetails) HasDetail() bool

HasDetail returns a boolean if a field has been set.

func (*ProblemDetails) HasInstance 

func (o *ProblemDetails) HasInstance() bool

HasInstance returns a boolean if a field has been set.

func (*ProblemDetails) HasInvalidParams 

func (o *ProblemDetails) HasInvalidParams() bool

HasInvalidParams returns a boolean if a field has been set.

func (*ProblemDetails) HasStatus 

func (o *ProblemDetails) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*ProblemDetails) HasSupportedFeatures 

func (o *ProblemDetails) HasSupportedFeatures() bool

HasSupportedFeatures returns a boolean if a field has been set.

func (*ProblemDetails) HasTitle 

func (o *ProblemDetails) HasTitle() bool

HasTitle returns a boolean if a field has been set.

func (*ProblemDetails) HasType 

func (o *ProblemDetails) HasType() bool

HasType returns a boolean if a field has been set.

func (ProblemDetails) MarshalJSON 

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

func (*ProblemDetails) SetCause 

func (o *ProblemDetails) SetCause(v string)

SetCause gets a reference to the given string and assigns it to the Cause field.

func (*ProblemDetails) SetDetail 

func (o *ProblemDetails) SetDetail(v string)

SetDetail gets a reference to the given string and assigns it to the Detail field.

func (*ProblemDetails) SetInstance 

func (o *ProblemDetails) SetInstance(v string)

SetInstance gets a reference to the given string and assigns it to the Instance field.

func (*ProblemDetails) SetInvalidParams 

func (o *ProblemDetails) SetInvalidParams(v []InvalidParam)

SetInvalidParams gets a reference to the given []InvalidParam and assigns it to the InvalidParams field.

func (*ProblemDetails) SetStatus 

func (o *ProblemDetails) SetStatus(v int32)

SetStatus gets a reference to the given int32 and assigns it to the Status field.

func (*ProblemDetails) SetSupportedFeatures 

func (o *ProblemDetails) SetSupportedFeatures(v string)

SetSupportedFeatures gets a reference to the given string and assigns it to the SupportedFeatures field.

func (*ProblemDetails) SetTitle 

func (o *ProblemDetails) SetTitle(v string)

SetTitle gets a reference to the given string and assigns it to the Title field.

func (*ProblemDetails) SetType 

func (o *ProblemDetails) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (ProblemDetails) ToMap 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.