client

package module
v0.0.0-...-8f6edbe Latest Latest
Warning

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

 Go to latest Published: May 30, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

README

Go API client for client

V2X Information Service is AdvantEDGE's implementation of ETSI MEC ISG MEC030 V2XI API

Copyright (c) ETSI 2017

Micro-service
meep-vis

Type & Usage
Edge Service used by edge applications that want to get information about radio conditions in the network

Note
AdvantEDGE supports a selected subset of RNI API endpoints (see below) and a subset of subscription types.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.2.1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

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

import "./client"

Documentation for API Endpoints

All URIs are relative to https://localhost/sandboxname/vis/v2

Class Method HTTP request Description
UnsupportedApi IndividualSubscriptionDELETE Delete /subscriptions/{subscriptionId} Used to cancel the existing subscription.
UnsupportedApi IndividualSubscriptionGET Get /subscriptions/{subscriptionId} Retrieve information about this subscription.
UnsupportedApi IndividualSubscriptionPUT Put /subscriptions/{subscriptionId} Used to update the existing subscription.
UnsupportedApi ProvInfoGET Get /queries/pc5_provisioning_info Query provisioning information for V2X communication over PC5.
UnsupportedApi ProvInfoUuMbmsGET Get /queries/uu_mbms_provisioning_info retrieve information required for V2X communication over Uu MBMS.
UnsupportedApi ProvInfoUuUnicastGET Get /queries/uu_unicast_provisioning_info Used to query provisioning information for V2X communication over Uu unicast.
UnsupportedApi SubGET Get /subscriptions Request information about the subscriptions for this requestor.
UnsupportedApi SubPOST Post /subscriptions create a new subscription to VIS notifications.
UnsupportedApi V2xMessagePOST Post /publish_v2x_message Used to publish a V2X message.
V2xiApi Mec011AppTerminationPOST Post /notifications/mec011/appTermination MEC011 Application Termination notification for self termination
V2xiApi PredictedQosPOST Post /provide_predicted_qos Request the predicted QoS correspondent to potential routes of a vehicular UE.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

AdvantEDGE@InterDigital.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

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

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

Types

type APIClient 

type APIClient struct {
	UnsupportedApi *UnsupportedApiService

	V2xiApi *V2xiApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the AdvantEDGE V2X Information Service REST API API v2.2.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) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

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 swagger 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:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AppTerminationNotification 

type AppTerminationNotification struct {
	// Shall be set to AppTerminationNotification.
	NotificationType string               `json:"notificationType"`
	OperationAction  *OperationActionType `json:"operationAction"`
	// Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
	MaxGracefulTimeout int32                            `json:"maxGracefulTimeout"`
	Links              *AppTerminationNotificationLinks `json:"_links"`
}

This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop. 

type AppTerminationNotificationLinks struct {
	Subscription       *LinkType `json:"subscription"`
	ConfirmTermination *LinkType `json:"confirmTermination,omitempty"`
}

Object containing hyperlinks related to the resource.

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 CellId 

type CellId struct {
	// E-UTRAN Cell Identity as a bit string (size (28)).
	CellId string `json:"cellId"`
}

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

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

type Earfcn 

type Earfcn struct {
	// E-UTRA Absolute Radio Frequency Channel Number, range (0... 65535)
	Earfcn int32 `json:"earfcn"`
}

type Ecgi 

type Ecgi struct {
	CellId *CellId `json:"cellId"`
	Plmn   *Plmn   `json:"plmn"`
}

type FddInfo 

type FddInfo struct {
	DlEarfcn                *Earfcn                `json:"dlEarfcn"`
	DlTransmissionBandwidth *TransmissionBandwidth `json:"dlTransmissionBandwidth"`
	UlEarfcn                *Earfcn                `json:"ulEarfcn"`
	UlTransmissionBandwidth *TransmissionBandwidth `json:"ulTransmissionBandwidth"`
}

type GenericSwaggerError 

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

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

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

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

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type LinkType 

type LinkType struct {
	// URI referring to a resource
	Href string `json:"href"`
}
type Links struct {
	Self *LinkType `json:"self"`
}

Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.

type LocationInfo 

type LocationInfo struct {
	Ecgi    *Ecgi                `json:"ecgi,omitempty"`
	GeoArea *LocationInfoGeoArea `json:"geoArea,omitempty"`
}

type LocationInfoGeoArea 

type LocationInfoGeoArea struct {
	// Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd
	Latitude float32 `json:"latitude"`
	// Longitude (DATUM = WGS84) -180 to 180 in decimal degree format DDD.ddd
	Longitude float32 `json:"longitude"`
}

Information of a geographical area.

type MsgType 

type MsgType int32

MsgType : Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3, − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2, − poi(3): Point of Interest message as specified in ETSI TS 101 556-1, − spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301, − mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301, − ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321, − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3, − tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2, − srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301, − ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301. − evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1, − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1, − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301, 

const (
	DENM              MsgType = 1
	CAM               MsgType = 2
	POI               MsgType = 3
	SPATEM            MsgType = 4
	MAPEM             MsgType = 5
	IVIM              MsgType = 6
	EV_RSR            MsgType = 7
	TISTPGTRANSACTION MsgType = 8
	SREM              MsgType = 9
	SSEM              MsgType = 10
	EVCSN             MsgType = 11
	SAEM              MsgType = 12
	RTCMEM            MsgType = 13
)

List of MsgType

type OneOfsubscriptionsBody 

type OneOfsubscriptionsBody struct {
}

type OneOfsubscriptionsSubscriptionIdBody 

type OneOfsubscriptionsSubscriptionIdBody struct {
}

type OperationActionType 

type OperationActionType string

OperationActionType : Operation that is being performed on the MEC application instance. 

const (
	STOPPING_OperationActionType    OperationActionType = "STOPPING"
	TERMINATING_OperationActionType OperationActionType = "TERMINATING"
)

List of OperationActionType

type Pc5NeighbourCellInfo 

type Pc5NeighbourCellInfo struct {
	Ecgi        *Ecgi                         `json:"ecgi"`
	Plmn        *Plmn                         `json:"plmn"`
	SiV2xConfig *SystemInformationBlockType21 `json:"siV2xConfig"`
}

type Pc5ProvisioningInfo 

type Pc5ProvisioningInfo struct {
	ProInfoPc5 []Pc5ProvisioningInfoProInfoPc5 `json:"proInfoPc5"`
	TimeStamp  *TimeStamp                      `json:"timeStamp,omitempty"`
}

type Pc5ProvisioningInfoProInfoPc5 

type Pc5ProvisioningInfoProInfoPc5 struct {
	// For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12]. PLMN operators coordinate to make sure Destination Layer2 ID(s) for different V2X services are configured in a consistent manner.
	DstLayer2Id  string        `json:"dstLayer2Id"`
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.
	NeighbourCellInfo []Pc5NeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
}

The provisioning information per location as defined below.

type Plmn 

type Plmn struct {
	// The Mobile Country Code part of PLMN Identity.
	Mcc string `json:"mcc"`
	// The Mobile Network Code part of PLMN Identity.
	Mnc string `json:"mnc"`
}

type PredictedQos 

type PredictedQos struct {
	// Granularity of visited location. Measured in meters.
	LocationGranularity string `json:"locationGranularity"`
	// Information relating to the potential routes of a vehicular UE.
	Routes          []PredictedQosRoutes `json:"routes"`
	TimeGranularity *TimeStamp           `json:"timeGranularity,omitempty"`
}

type PredictedQosRoutes 

type PredictedQosRoutes struct {
	// Information relating to a specific route. The first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided.
	RouteInfo []PredictedQosRoutesRouteInfo `json:"routeInfo,omitempty"`
}

type PredictedQosRoutesRouteInfo 

type PredictedQosRoutesRouteInfo struct {
	Location *LocationInfo `json:"location,omitempty"`
	// Reference Signal Received Power as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response.
	Rsrp int32 `json:"rsrp,omitempty"`
	// Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response.
	Rsrq int32      `json:"rsrq,omitempty"`
	Time *TimeStamp `json:"time,omitempty"`
}

type ProblemDetails 

type ProblemDetails struct {
	// A human-readable explanation specific to this occurrence of the problem
	Detail string `json:"detail,omitempty"`
	// A URI reference that identifies the specific occurrence of the problem
	Instance string `json:"instance,omitempty"`
	// The HTTP status code for this occurrence of the problem
	Status int32 `json:"status,omitempty"`
	// A short, human-readable summary of the problem type
	Title string `json:"title,omitempty"`
	// A URI reference according to IETF RFC 3986 that identifies the problem type
	Type_ string `json:"type,omitempty"`
}

type ProvChgPc5Notification 

type ProvChgPc5Notification struct {
	// For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].
	DstLayer2Id  string        `json:"dstLayer2Id,omitempty"`
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.
	NeighbourCellInfo []Pc5NeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
	// Shall be set to \"ProvChgPc5Notification\".
	NotificationType string     `json:"notificationType"`
	TimeStamp        *TimeStamp `json:"timeStamp,omitempty"`
}

type ProvChgPc5Subscription 

type ProvChgPc5Subscription struct {
	Links *Links `json:"_links,omitempty"`
	// URI exposed by the client on which to receive notifications via HTTP. See note.
	CallbackReference string                                `json:"callbackReference,omitempty"`
	ExpiryDeadline    *TimeStamp                            `json:"expiryDeadline,omitempty"`
	FilterCriteria    *ProvChgPc5SubscriptionFilterCriteria `json:"filterCriteria"`
	// Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a. Default: FALSE.
	RequestTestNotification bool `json:"requestTestNotification,omitempty"`
	// Shall be set to \"ProvChgPc5Subscription\".
	SubscriptionType   string              `json:"subscriptionType"`
	WebsockNotifConfig *WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
}

type ProvChgPc5SubscriptionFilterCriteria 

type ProvChgPc5SubscriptionFilterCriteria struct {
	// For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].
	DstLayer2Id  string        `json:"dstLayer2Id"`
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.
	NeighbourCellInfo []Pc5NeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
}

List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.

type ProvChgUuMbmsNotification 

type ProvChgUuMbmsNotification struct {
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.
	NeighbourCellInfo []UuMbmsNeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
	// Shall be set to \"ProvChgUuMbmsNotification\".
	NotificationType string        `json:"notificationType"`
	TimeStamp        *TimeStamp    `json:"timeStamp,omitempty"`
	V2xServerUsd     *V2xServerUsd `json:"v2xServerUsd,omitempty"`
}

type ProvChgUuMbmsSubscription 

type ProvChgUuMbmsSubscription struct {
	Links *Links `json:"_links,omitempty"`
	// URI exposed by the client on which to receive notifications via HTTP. See note.
	CallbackReference string                                   `json:"callbackReference,omitempty"`
	ExpiryDeadline    *TimeStamp                               `json:"expiryDeadline,omitempty"`
	FilterCriteria    *ProvChgUuMbmsSubscriptionFilterCriteria `json:"filterCriteria"`
	// Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a. Default: FALSE.
	RequestTestNotification bool `json:"requestTestNotification,omitempty"`
	// Shall be set to \"ProvChgUuMbmsSubscription\".
	SubscriptionType   string              `json:"subscriptionType"`
	WebsockNotifConfig *WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
}

type ProvChgUuMbmsSubscriptionFilterCriteria 

type ProvChgUuMbmsSubscriptionFilterCriteria struct {
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.
	NeighbourCellInfo []UuMbmsNeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
	V2xServerUsd      *V2xServerUsd             `json:"v2xServerUsd"`
}

List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.

type ProvChgUuUniNotification 

type ProvChgUuUniNotification struct {
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.
	NeighbourCellInfo []UuUniNeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
	// Shall be set to \"ProvChgUuUniNotification\".
	NotificationType     string                `json:"notificationType"`
	TimeStamp            *TimeStamp            `json:"timeStamp,omitempty"`
	V2xApplicationServer *V2xApplicationServer `json:"v2xApplicationServer,omitempty"`
}

type ProvChgUuUniSubscription 

type ProvChgUuUniSubscription struct {
	Links *Links `json:"_links,omitempty"`
	// URI exposed by the client on which to receive notifications via HTTP. See note.
	CallbackReference string                                  `json:"callbackReference,omitempty"`
	ExpiryDeadline    *TimeStamp                              `json:"expiryDeadline,omitempty"`
	FilterCriteria    *ProvChgUuUniSubscriptionFilterCriteria `json:"filterCriteria"`
	// Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a. Default: FALSE.
	RequestTestNotification bool `json:"requestTestNotification,omitempty"`
	// Shall be set to \"ProvChgUuUniSubscription\".
	SubscriptionType   string              `json:"subscriptionType"`
	WebsockNotifConfig *WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
}

type ProvChgUuUniSubscriptionFilterCriteria 

type ProvChgUuUniSubscriptionFilterCriteria struct {
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.
	NeighbourCellInfo    []UuUniNeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
	V2xApplicationServer *V2xApplicationServer    `json:"v2xApplicationServer"`
}

List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.

type SubGETOpts 

type SubGETOpts struct {
	SubscriptionType optional.String
}
type SubscriptionLinkList struct {
	Links *SubscriptionLinkListLinks `json:"_links"`
}
type SubscriptionLinkListLinks struct {
	Self          *LinkType                                `json:"self"`
	Subscriptions []SubscriptionLinkListLinksSubscriptions `json:"subscriptions,omitempty"`
}

List of hyperlinks related to the resource.

type SubscriptionLinkListLinksSubscriptions 

type SubscriptionLinkListLinksSubscriptions struct {
	// The URI referring to the subscription.
	Href string `json:"href"`
	// Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different V2X information event subscription data type.
	SubscriptionType string `json:"subscriptionType"`
}

The service consumer's subscriptions.

type SubscriptionsBody 

type SubscriptionsBody struct {
}

type SubscriptionsSubscriptionIdBody 

type SubscriptionsSubscriptionIdBody struct {
}

type SystemInformationBlockType21 

type SystemInformationBlockType21 struct {
}

type TddInfo 

type TddInfo struct {
	Earfcn *Earfcn `json:"earfcn"`
	// Uplink-downlink subframe configuration information.
	SubframeAssignment    string                 `json:"subframeAssignment"`
	TransmissionBandwidth *TransmissionBandwidth `json:"transmissionBandwidth"`
}

type TestNotification 

type TestNotification struct {
	Links *TestNotificationLinks `json:"_links"`
	// Shall be set to \"TestNotification\".
	NotificationType string `json:"notificationType"`
}
type TestNotificationLinks struct {
	Subscription *LinkType `json:"subscription"`
}

Hyperlink related to the resource.

type TimeStamp 

type TimeStamp struct {
	// The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
	NanoSeconds int32 `json:"nanoSeconds"`
	// The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
	Seconds int32 `json:"seconds"`
}

type TransmissionBandwidth 

type TransmissionBandwidth struct {
	TransmissionBandwidth *TransmissionBandwidthTransmissionBandwidth `json:"transmissionBandwidth"`
}

type TransmissionBandwidthTransmissionBandwidth 

type TransmissionBandwidthTransmissionBandwidth int32

TransmissionBandwidthTransmissionBandwidth : 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows: 1 = bw6 (6 resource blocks) 2 = bw15 (15 resource blocks) 3 = bw25 (25 resource blocks) 4 = bw50 (50 resource blocks) 5 = bw75 (75 resource blocks) 6 = bw100 (100 resource blocks)' 

const (
	BW6   TransmissionBandwidthTransmissionBandwidth = 1
	BW15  TransmissionBandwidthTransmissionBandwidth = 2
	BW25  TransmissionBandwidthTransmissionBandwidth = 3
	BW50  TransmissionBandwidthTransmissionBandwidth = 4
	BW75  TransmissionBandwidthTransmissionBandwidth = 5
	BW100 TransmissionBandwidthTransmissionBandwidth = 6
)

List of TransmissionBandwidth.transmissionBandwidth

type UnsupportedApiService 

type UnsupportedApiService service

func (*UnsupportedApiService) IndividualSubscriptionDELETE 

func (a *UnsupportedApiService) IndividualSubscriptionDELETE(ctx context.Context, subscriptionId string) (*http.Response, error)

UnsupportedApiService Used to cancel the existing subscription. Used to cancel the existing subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Refers to created subscription, where the VIS API allocates a unique resource name for this subscription

func (*UnsupportedApiService) IndividualSubscriptionGET 

func (a *UnsupportedApiService) IndividualSubscriptionGET(ctx context.Context, subscriptionId string) (SubscriptionsBody, *http.Response, error)

UnsupportedApiService Retrieve information about this subscription. Retrieve information about this subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Refers to created subscription, where the VIS API allocates a unique resource name for this subscription

@return SubscriptionsBody

func (*UnsupportedApiService) IndividualSubscriptionPUT 

func (a *UnsupportedApiService) IndividualSubscriptionPUT(ctx context.Context, body SubscriptionsSubscriptionIdBody, subscriptionId string) (SubscriptionsSubscriptionIdBody, *http.Response, error)

UnsupportedApiService Used to update the existing subscription. Used to update the existing subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param subscriptionId Refers to created subscription, where the VIS API allocates a unique resource name for this subscription

@return SubscriptionsSubscriptionIdBody

func (*UnsupportedApiService) ProvInfoGET 

func (a *UnsupportedApiService) ProvInfoGET(ctx context.Context, locationInfo string) (Pc5ProvisioningInfo, *http.Response, error)

UnsupportedApiService Query provisioning information for V2X communication over PC5. Query provisioning information for V2X communication over PC5.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param locationInfo Comma separated list of locations to identify a cell of a base station or a particular geographical area

@return Pc5ProvisioningInfo

func (*UnsupportedApiService) ProvInfoUuMbmsGET 

func (a *UnsupportedApiService) ProvInfoUuMbmsGET(ctx context.Context, locationInfo string) (UuMbmsProvisioningInfo, *http.Response, error)

UnsupportedApiService retrieve information required for V2X communication over Uu MBMS. retrieve information required for V2X communication over Uu MBMS.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param locationInfo omma separated list of locations to identify a cell of a base station or a particular geographical area

@return UuMbmsProvisioningInfo

func (*UnsupportedApiService) ProvInfoUuUnicastGET 

func (a *UnsupportedApiService) ProvInfoUuUnicastGET(ctx context.Context, locationInfo string) (UuUnicastProvisioningInfo, *http.Response, error)

UnsupportedApiService Used to query provisioning information for V2X communication over Uu unicast. Used to query provisioning information for V2X communication over Uu unicast.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param locationInfo Comma separated list of locations to identify a cell of a base station or a particular geographical area

@return UuUnicastProvisioningInfo

func (*UnsupportedApiService) SubGET 

func (a *UnsupportedApiService) SubGET(ctx context.Context, localVarOptionals *SubGETOpts) (SubscriptionLinkList, *http.Response, error)

func (*UnsupportedApiService) SubPOST 

func (a *UnsupportedApiService) SubPOST(ctx context.Context, body SubscriptionsBody) (SubscriptionsBody, *http.Response, error)

UnsupportedApiService create a new subscription to VIS notifications. 

create a new subscription to VIS notifications.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body

@return SubscriptionsBody

func (*UnsupportedApiService) V2xMessagePOST 

func (a *UnsupportedApiService) V2xMessagePOST(ctx context.Context, body V2xMsgPublication) (*http.Response, error)

UnsupportedApiService Used to publish a V2X message. Used to publish a V2X message.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

type UuMbmsNeighbourCellInfo 

type UuMbmsNeighbourCellInfo struct {
	Ecgi    *Ecgi    `json:"ecgi"`
	FddInfo *FddInfo `json:"fddInfo"`
	// Supported MBMS Service Area Identities in the cell.
	MbmsServiceAreaIdentity []string `json:"mbmsServiceAreaIdentity"`
	// Physical Cell Identifier.
	Pci     int32    `json:"pci"`
	Plmn    *Plmn    `json:"plmn"`
	TddInfo *TddInfo `json:"tddInfo"`
}

type UuMbmsProvisioningInfo 

type UuMbmsProvisioningInfo struct {
	ProInfoUuMbms []UuMbmsProvisioningInfoProInfoUuMbms `json:"proInfoUuMbms"`
	TimeStamp     *TimeStamp                            `json:"timeStamp,omitempty"`
}

type UuMbmsProvisioningInfoProInfoUuMbms 

type UuMbmsProvisioningInfoProInfoUuMbms struct {
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.
	NeighbourCellInfo []UuMbmsNeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
	V2xServerUsd      *V2xServerUsd             `json:"v2xServerUsd"`
}

The provisioning information per location as defined below.

type UuUniNeighbourCellInfo 

type UuUniNeighbourCellInfo struct {
	Ecgi    *Ecgi    `json:"ecgi"`
	FddInfo *FddInfo `json:"fddInfo"`
	// Physical Cell Identifier.
	Pci     int32    `json:"pci"`
	Plmn    *Plmn    `json:"plmn"`
	TddInfo *TddInfo `json:"tddInfo"`
}

type UuUnicastProvisioningInfo 

type UuUnicastProvisioningInfo struct {
	ProInfoUuUnicast []UuUnicastProvisioningInfoProInfoUuUnicast `json:"proInfoUuUnicast"`
	TimeStamp        *TimeStamp                                  `json:"timeStamp,omitempty"`
}

type UuUnicastProvisioningInfoProInfoUuUnicast 

type UuUnicastProvisioningInfoProInfoUuUnicast struct {
	LocationInfo *LocationInfo `json:"locationInfo"`
	// The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.
	NeighbourCellInfo    []UuUniNeighbourCellInfo `json:"neighbourCellInfo,omitempty"`
	V2xApplicationServer *V2xApplicationServer    `json:"v2xApplicationServer"`
}

The provisioning information per location as defined below.

type V2xApplicationServer 

type V2xApplicationServer struct {
	IpAddress string `json:"ipAddress"`
	UdpPort   string `json:"udpPort"`
}

type V2xMsgNotification 

type V2xMsgNotification struct {
	Links *V2xMsgNotificationLinks `json:"_links"`
	// Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.
	MsgContent string `json:"msgContent"`
	// The encode format of the V2X message, for example base64.
	MsgEncodeFormat string   `json:"msgEncodeFormat"`
	MsgType         *MsgType `json:"msgType"`
	// Shall be set to \"V2xMsgNotification\".
	NotificationType string `json:"notificationType"`
	// Standardization organization which defines the published V2X message type:  ETSI: European Telecommunications Standards Institute. See note 1.
	StdOrganization string     `json:"stdOrganization"`
	TimeStamp       *TimeStamp `json:"timeStamp"`
}
type V2xMsgNotificationLinks struct {
	Subscription *LinkType `json:"subscription"`
}

links to resources related to this notification.

type V2xMsgPublication 

type V2xMsgPublication struct {
	// Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization.
	MsgContent string `json:"msgContent"`
	// The encode format of the V2X message, for example base64.
	MsgEncodeFormat string   `json:"msgEncodeFormat"`
	MsgType         *MsgType `json:"msgType"`
	// Standardization organization which defines the published V2X message type: ETSI: European Telecommunications Standards Institute.  See note 1.
	StdOrganization string `json:"stdOrganization"`
}

type V2xMsgSubscription 

type V2xMsgSubscription struct {
	Links *Links `json:"_links,omitempty"`
	// URI exposed by the client on which to receive notifications via HTTP. See note 1.
	CallbackReference string                            `json:"callbackReference,omitempty"`
	ExpiryDeadline    *TimeStamp                        `json:"expiryDeadline,omitempty"`
	FilterCriteria    *V2xMsgSubscriptionFilterCriteria `json:"filterCriteria"`
	// Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a. Default: FALSE.
	RequestTestNotification bool `json:"requestTestNotification,omitempty"`
	// Shall be set to \"V2xMsgSubscription\".
	SubscriptionType   string              `json:"subscriptionType"`
	WebsockNotifConfig *WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
}

type V2xMsgSubscriptionFilterCriteria 

type V2xMsgSubscriptionFilterCriteria struct {
	// Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 3.
	MsgType []string `json:"msgType,omitempty"`
	// Standardization organization which defines the subscribed V2X message type:  ETSI: European Telecommunications Standards Institute.  See note 2.
	StdOrganization string `json:"stdOrganization"`
}

List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.

type V2xServerUsd 

type V2xServerUsd struct {
	SdpInfo *V2xServerUsdSdpInfo `json:"sdpInfo"`
	// A list of service area identifier for the applicable MBMS broadcast area.
	ServiceAreaIdentifier []string          `json:"serviceAreaIdentifier"`
	Tmgi                  *V2xServerUsdTmgi `json:"tmgi"`
}

type V2xServerUsdSdpInfo 

type V2xServerUsdSdpInfo struct {
	IpMulticastAddress string `json:"ipMulticastAddress"`
	PortNumber         string `json:"portNumber"`
}

SDP with IP multicast address and port number used for V2X communication via MBMS.

type V2xServerUsdTmgi 

type V2xServerUsdTmgi struct {
	// MBMS Service ID consisting of three octets.
	MbmsServiceId string `json:"mbmsServiceId"`
	// The Mobile Country Code part of PLMN Identity.
	Mcc string `json:"mcc"`
	// The Mobile Network Code part of PLMN Identity.
	Mnc string `json:"mnc"`
}

Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.

type V2xiApiService 

type V2xiApiService service

func (*V2xiApiService) Mec011AppTerminationPOST 

func (a *V2xiApiService) Mec011AppTerminationPOST(ctx context.Context, body AppTerminationNotification) (*http.Response, error)

V2xiApiService MEC011 Application Termination notification for self termination Terminates itself.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Termination notification details

func (*V2xiApiService) PredictedQosPOST 

func (a *V2xiApiService) PredictedQosPOST(ctx context.Context, body PredictedQos) (PredictedQos, *http.Response, error)

V2xiApiService Request the predicted QoS correspondent to potential routes of a vehicular UE. Request the predicted QoS correspondent to potential routes of a vehicular UE.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return PredictedQos

type WebsockNotifConfig 

type WebsockNotifConfig struct {
	// Set to TRUE by the service consumer to indicate that Websocket delivery is requested.
	RequestWebsocketUri bool `json:"requestWebsocketUri,omitempty"`
	// Set by VIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
	WebsocketUri string `json:"websocketUri,omitempty"`
}

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.