aggregationPack

package module
v0.0.0-...-2fcb9e9 Latest Latest
Warning

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

 Go to latest Published: Nov 20, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

README

Go API client for aggregationPack

This documents the rest api aggregation packs provides.

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: v2
  • Package version: 1.0.0
  • Generator version: 7.4.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 aggregationPack "github.com/leaseweb/leaseweb-go-sdk/aggregationPack"

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

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

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.leaseweb.com/bareMetals/v2

Class Method HTTP request Description
AggregationPackAPI GetAggregationPack Get /aggregationPacks/{aggregationPackId} Get aggregation pack
AggregationPackAPI GetAggregationPackList Get /aggregationPacks List aggregation packs

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth
  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), aggregationPack.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
X-LSW-Auth
  • Type: API key
  • API key parameter name: X-LSW-Auth
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-LSW-Auth and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		aggregationPack.ContextAPIKeys,
		map[string]aggregationPack.APIKey{
			"X-LSW-Auth": {Key: "API_KEY_STRING"},
		},
	)
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 (
	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// 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")
)
View Source 
var AllowedAggregationTypeEnumValues = []AggregationType{
	"Hybrid",
}

All allowed values of AggregationType enum

View Source 
var AllowedDataTrafficCommitUnitEnumValues = []DataTrafficCommitUnit{
	"Gbps",
	"Mbps",
	"TB",
}

All allowed values of DataTrafficCommitUnit enum

View Source 
var AllowedNetworkPerformanceTypeEnumValues = []NetworkPerformanceType{
	"VOLUME",
	"PREMIUM",
}

All allowed values of NetworkPerformanceType enum

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 {
	AggregationPackAPI AggregationPackAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the Leaseweb API for aggregation packs API vv2 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 AggregationPack 

type AggregationPack struct {
	// Id of the aggregation pack
	Id                     string                 `json:"id"`
	CustomerId             string                 `json:"customerId"`
	SalesOrgId             string                 `json:"salesOrgId"`
	ContractStartDate      time.Time              `json:"contractStartDate"`
	BillingType            string                 `json:"billingType"`
	ConnectivityType       string                 `json:"connectivityType"`
	ContractTerm           int32                  `json:"contractTerm"`
	DataTrafficCommit      int32                  `json:"dataTrafficCommit"`
	DataTrafficCommitUnit  DataTrafficCommitUnit  `json:"dataTrafficCommitUnit"`
	NetworkPerformanceType NetworkPerformanceType `json:"networkPerformanceType"`
	AggregationType        AggregationType        `json:"aggregationType"`
	AdditionalProperties   map[string]interface{}
}

AggregationPack struct for AggregationPack

func NewAggregationPack 

func NewAggregationPack(id string, customerId string, salesOrgId string, contractStartDate time.Time, billingType string, connectivityType string, contractTerm int32, dataTrafficCommit int32, dataTrafficCommitUnit DataTrafficCommitUnit, networkPerformanceType NetworkPerformanceType, aggregationType AggregationType) *AggregationPack

NewAggregationPack instantiates a new AggregationPack 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 NewAggregationPackWithDefaults 

func NewAggregationPackWithDefaults() *AggregationPack

NewAggregationPackWithDefaults instantiates a new AggregationPack 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 (*AggregationPack) GetAggregationType 

func (o *AggregationPack) GetAggregationType() AggregationType

GetAggregationType returns the AggregationType field value

func (*AggregationPack) GetAggregationTypeOk 

func (o *AggregationPack) GetAggregationTypeOk() (*AggregationType, bool)

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

func (*AggregationPack) GetBillingType 

func (o *AggregationPack) GetBillingType() string

GetBillingType returns the BillingType field value

func (*AggregationPack) GetBillingTypeOk 

func (o *AggregationPack) GetBillingTypeOk() (*string, bool)

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

func (*AggregationPack) GetConnectivityType 

func (o *AggregationPack) GetConnectivityType() string

GetConnectivityType returns the ConnectivityType field value

func (*AggregationPack) GetConnectivityTypeOk 

func (o *AggregationPack) GetConnectivityTypeOk() (*string, bool)

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

func (*AggregationPack) GetContractStartDate 

func (o *AggregationPack) GetContractStartDate() time.Time

GetContractStartDate returns the ContractStartDate field value

func (*AggregationPack) GetContractStartDateOk 

func (o *AggregationPack) GetContractStartDateOk() (*time.Time, bool)

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

func (*AggregationPack) GetContractTerm 

func (o *AggregationPack) GetContractTerm() int32

GetContractTerm returns the ContractTerm field value

func (*AggregationPack) GetContractTermOk 

func (o *AggregationPack) GetContractTermOk() (*int32, bool)

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

func (*AggregationPack) GetCustomerId 

func (o *AggregationPack) GetCustomerId() string

GetCustomerId returns the CustomerId field value

func (*AggregationPack) GetCustomerIdOk 

func (o *AggregationPack) GetCustomerIdOk() (*string, bool)

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

func (*AggregationPack) GetDataTrafficCommit 

func (o *AggregationPack) GetDataTrafficCommit() int32

GetDataTrafficCommit returns the DataTrafficCommit field value

func (*AggregationPack) GetDataTrafficCommitOk 

func (o *AggregationPack) GetDataTrafficCommitOk() (*int32, bool)

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

func (*AggregationPack) GetDataTrafficCommitUnit 

func (o *AggregationPack) GetDataTrafficCommitUnit() DataTrafficCommitUnit

GetDataTrafficCommitUnit returns the DataTrafficCommitUnit field value

func (*AggregationPack) GetDataTrafficCommitUnitOk 

func (o *AggregationPack) GetDataTrafficCommitUnitOk() (*DataTrafficCommitUnit, bool)

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

func (*AggregationPack) GetId 

func (o *AggregationPack) GetId() string

GetId returns the Id field value

func (*AggregationPack) GetIdOk 

func (o *AggregationPack) GetIdOk() (*string, bool)

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

func (*AggregationPack) GetNetworkPerformanceType 

func (o *AggregationPack) GetNetworkPerformanceType() NetworkPerformanceType

GetNetworkPerformanceType returns the NetworkPerformanceType field value

func (*AggregationPack) GetNetworkPerformanceTypeOk 

func (o *AggregationPack) GetNetworkPerformanceTypeOk() (*NetworkPerformanceType, bool)

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

func (*AggregationPack) GetSalesOrgId 

func (o *AggregationPack) GetSalesOrgId() string

GetSalesOrgId returns the SalesOrgId field value

func (*AggregationPack) GetSalesOrgIdOk 

func (o *AggregationPack) GetSalesOrgIdOk() (*string, bool)

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

func (AggregationPack) MarshalJSON 

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

func (*AggregationPack) SetAggregationType 

func (o *AggregationPack) SetAggregationType(v AggregationType)

SetAggregationType sets field value

func (*AggregationPack) SetBillingType 

func (o *AggregationPack) SetBillingType(v string)

SetBillingType sets field value

func (*AggregationPack) SetConnectivityType 

func (o *AggregationPack) SetConnectivityType(v string)

SetConnectivityType sets field value

func (*AggregationPack) SetContractStartDate 

func (o *AggregationPack) SetContractStartDate(v time.Time)

SetContractStartDate sets field value

func (*AggregationPack) SetContractTerm 

func (o *AggregationPack) SetContractTerm(v int32)

SetContractTerm sets field value

func (*AggregationPack) SetCustomerId 

func (o *AggregationPack) SetCustomerId(v string)

SetCustomerId sets field value

func (*AggregationPack) SetDataTrafficCommit 

func (o *AggregationPack) SetDataTrafficCommit(v int32)

SetDataTrafficCommit sets field value

func (*AggregationPack) SetDataTrafficCommitUnit 

func (o *AggregationPack) SetDataTrafficCommitUnit(v DataTrafficCommitUnit)

SetDataTrafficCommitUnit sets field value

func (*AggregationPack) SetId 

func (o *AggregationPack) SetId(v string)

SetId sets field value

func (*AggregationPack) SetNetworkPerformanceType 

func (o *AggregationPack) SetNetworkPerformanceType(v NetworkPerformanceType)

SetNetworkPerformanceType sets field value

func (*AggregationPack) SetSalesOrgId 

func (o *AggregationPack) SetSalesOrgId(v string)

SetSalesOrgId sets field value

func (AggregationPack) ToMap 

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

func (*AggregationPack) UnmarshalJSON 

func (o *AggregationPack) UnmarshalJSON(data []byte) (err error)

type AggregationPackAPI 

type AggregationPackAPI interface {

	/*
		GetAggregationPack Get aggregation pack

		Use this API to get information about a single aggregation pack.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param aggregationPackId The ID of aggregation pack
		@return ApiGetAggregationPackRequest
	*/
	GetAggregationPack(ctx context.Context, aggregationPackId string) ApiGetAggregationPackRequest

	// GetAggregationPackExecute executes the request
	//  @return AggregationPack
	GetAggregationPackExecute(r ApiGetAggregationPackRequest) (*AggregationPack, *http.Response, error)

	/*
		GetAggregationPackList List aggregation packs

		List your Aggregation Packs. This api call supports pagination. Use the
	`limit` and `offset` query string parameters to paginate through all your
	aggregation packs.

	Every `aggregation pack` object in the json response lists a few properties of a aggregation pack.
	Use the single resource api call to get more details for a single aggregation pack.


		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiGetAggregationPackListRequest
	*/
	GetAggregationPackList(ctx context.Context) ApiGetAggregationPackListRequest

	// GetAggregationPackListExecute executes the request
	//  @return GetAggregationPackListResult
	GetAggregationPackListExecute(r ApiGetAggregationPackListRequest) (*GetAggregationPackListResult, *http.Response, error)
}

type AggregationPackAPIService 

type AggregationPackAPIService service

AggregationPackAPIService AggregationPackAPI service

func (*AggregationPackAPIService) GetAggregationPack 

func (a *AggregationPackAPIService) GetAggregationPack(ctx context.Context, aggregationPackId string) ApiGetAggregationPackRequest

GetAggregationPack Get aggregation pack

Use this API to get information about a single aggregation pack. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param aggregationPackId The ID of aggregation pack
@return ApiGetAggregationPackRequest

func (*AggregationPackAPIService) GetAggregationPackExecute 

func (a *AggregationPackAPIService) GetAggregationPackExecute(r ApiGetAggregationPackRequest) (*AggregationPack, *http.Response, error)

Execute executes the request 

@return AggregationPack

func (*AggregationPackAPIService) GetAggregationPackList 

func (a *AggregationPackAPIService) GetAggregationPackList(ctx context.Context) ApiGetAggregationPackListRequest

GetAggregationPackList List aggregation packs

List your Aggregation Packs. This api call supports pagination. Use the `limit` and `offset` query string parameters to paginate through all your aggregation packs.

Every `aggregation pack` object in the json response lists a few properties of a aggregation pack. Use the single resource api call to get more details for a single aggregation pack. 

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

func (*AggregationPackAPIService) GetAggregationPackListExecute 

func (a *AggregationPackAPIService) GetAggregationPackListExecute(r ApiGetAggregationPackListRequest) (*GetAggregationPackListResult, *http.Response, error)

Execute executes the request 

@return GetAggregationPackListResult

type AggregationType 

type AggregationType string

AggregationType the model 'AggregationType' 

const (
	AGGREGATIONTYPE_HYBRID AggregationType = "Hybrid"
)

List of aggregationType

func NewAggregationTypeFromValue 

func NewAggregationTypeFromValue(v string) (*AggregationType, error)

NewAggregationTypeFromValue returns a pointer to a valid AggregationType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (AggregationType) IsValid 

func (v AggregationType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (AggregationType) Ptr 

func (v AggregationType) Ptr() *AggregationType

Ptr returns reference to aggregationType value

func (*AggregationType) UnmarshalJSON 

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

type ApiGetAggregationPackListRequest 

type ApiGetAggregationPackListRequest struct {
	ApiService AggregationPackAPI
	// contains filtered or unexported fields
}

func (ApiGetAggregationPackListRequest) Execute 

func (r ApiGetAggregationPackListRequest) Execute() (*GetAggregationPackListResult, *http.Response, error)

func (ApiGetAggregationPackListRequest) Limit 

func (r ApiGetAggregationPackListRequest) Limit(limit int32) ApiGetAggregationPackListRequest

Limit the number of results returned.

func (ApiGetAggregationPackListRequest) Offset 

func (r ApiGetAggregationPackListRequest) Offset(offset int32) ApiGetAggregationPackListRequest

Return results starting from the given offset.

type ApiGetAggregationPackRequest 

type ApiGetAggregationPackRequest struct {
	ApiService AggregationPackAPI
	// contains filtered or unexported fields
}

func (ApiGetAggregationPackRequest) Execute 

func (r ApiGetAggregationPackRequest) Execute() (*AggregationPack, *http.Response, 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 DataTrafficCommitUnit 

type DataTrafficCommitUnit string

DataTrafficCommitUnit the model 'DataTrafficCommitUnit' 

const (
	DATATRAFFICCOMMITUNIT_GBPS DataTrafficCommitUnit = "Gbps"
	DATATRAFFICCOMMITUNIT_MBPS DataTrafficCommitUnit = "Mbps"
	DATATRAFFICCOMMITUNIT_TB   DataTrafficCommitUnit = "TB"
)

List of dataTrafficCommitUnit

func NewDataTrafficCommitUnitFromValue 

func NewDataTrafficCommitUnitFromValue(v string) (*DataTrafficCommitUnit, error)

NewDataTrafficCommitUnitFromValue returns a pointer to a valid DataTrafficCommitUnit for the value passed as argument, or an error if the value passed is not allowed by the enum

func (DataTrafficCommitUnit) IsValid 

func (v DataTrafficCommitUnit) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (DataTrafficCommitUnit) Ptr 

func (v DataTrafficCommitUnit) Ptr() *DataTrafficCommitUnit

Ptr returns reference to dataTrafficCommitUnit value

func (*DataTrafficCommitUnit) UnmarshalJSON 

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

type ErrorResult 

type ErrorResult struct {
	// The correlation ID of the current request.
	CorrelationId *string `json:"correlationId,omitempty"`
	// The error code.
	ErrorCode *string `json:"errorCode,omitempty"`
	// A human friendly description of the error.
	ErrorMessage         *string              `json:"errorMessage,omitempty"`
	ErrorDetails         *map[string][]string `json:"errorDetails,omitempty"`
	AdditionalProperties map[string]interface{}
}

ErrorResult struct for ErrorResult

func NewErrorResult 

func NewErrorResult() *ErrorResult

NewErrorResult instantiates a new ErrorResult 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 NewErrorResultWithDefaults 

func NewErrorResultWithDefaults() *ErrorResult

NewErrorResultWithDefaults instantiates a new ErrorResult 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 (*ErrorResult) GetCorrelationId 

func (o *ErrorResult) GetCorrelationId() string

GetCorrelationId returns the CorrelationId field value if set, zero value otherwise.

func (*ErrorResult) GetCorrelationIdOk 

func (o *ErrorResult) GetCorrelationIdOk() (*string, bool)

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

func (*ErrorResult) GetErrorCode 

func (o *ErrorResult) GetErrorCode() string

GetErrorCode returns the ErrorCode field value if set, zero value otherwise.

func (*ErrorResult) GetErrorCodeOk 

func (o *ErrorResult) GetErrorCodeOk() (*string, bool)

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

func (*ErrorResult) GetErrorDetails 

func (o *ErrorResult) GetErrorDetails() map[string][]string

GetErrorDetails returns the ErrorDetails field value if set, zero value otherwise.

func (*ErrorResult) GetErrorDetailsOk 

func (o *ErrorResult) GetErrorDetailsOk() (*map[string][]string, bool)

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

func (*ErrorResult) GetErrorMessage 

func (o *ErrorResult) GetErrorMessage() string

GetErrorMessage returns the ErrorMessage field value if set, zero value otherwise.

func (*ErrorResult) GetErrorMessageOk 

func (o *ErrorResult) GetErrorMessageOk() (*string, bool)

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

func (*ErrorResult) HasCorrelationId 

func (o *ErrorResult) HasCorrelationId() bool

HasCorrelationId returns a boolean if a field has been set.

func (*ErrorResult) HasErrorCode 

func (o *ErrorResult) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

func (*ErrorResult) HasErrorDetails 

func (o *ErrorResult) HasErrorDetails() bool

HasErrorDetails returns a boolean if a field has been set.

func (*ErrorResult) HasErrorMessage 

func (o *ErrorResult) HasErrorMessage() bool

HasErrorMessage returns a boolean if a field has been set.

func (ErrorResult) MarshalJSON 

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

func (*ErrorResult) SetCorrelationId 

func (o *ErrorResult) SetCorrelationId(v string)

SetCorrelationId gets a reference to the given string and assigns it to the CorrelationId field.

func (*ErrorResult) SetErrorCode 

func (o *ErrorResult) SetErrorCode(v string)

SetErrorCode gets a reference to the given string and assigns it to the ErrorCode field.

func (*ErrorResult) SetErrorDetails 

func (o *ErrorResult) SetErrorDetails(v map[string][]string)

SetErrorDetails gets a reference to the given map[string][]string and assigns it to the ErrorDetails field.

func (*ErrorResult) SetErrorMessage 

func (o *ErrorResult) SetErrorMessage(v string)

SetErrorMessage gets a reference to the given string and assigns it to the ErrorMessage field.

func (ErrorResult) ToMap 

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

func (*ErrorResult) UnmarshalJSON 

func (o *ErrorResult) UnmarshalJSON(data []byte) (err error)

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 GetAggregationPackListResult 

type GetAggregationPackListResult struct {
	Metadata *Metadata `json:"_metadata,omitempty"`
	// An array of aggregation packs
	ConnectContractItems []AggregationPack `json:"connectContractItems,omitempty"`
	AdditionalProperties map[string]interface{}
}

GetAggregationPackListResult struct for GetAggregationPackListResult

func NewGetAggregationPackListResult 

func NewGetAggregationPackListResult() *GetAggregationPackListResult

NewGetAggregationPackListResult instantiates a new GetAggregationPackListResult 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 NewGetAggregationPackListResultWithDefaults 

func NewGetAggregationPackListResultWithDefaults() *GetAggregationPackListResult

NewGetAggregationPackListResultWithDefaults instantiates a new GetAggregationPackListResult 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 (*GetAggregationPackListResult) GetConnectContractItems 

func (o *GetAggregationPackListResult) GetConnectContractItems() []AggregationPack

GetConnectContractItems returns the ConnectContractItems field value if set, zero value otherwise.

func (*GetAggregationPackListResult) GetConnectContractItemsOk 

func (o *GetAggregationPackListResult) GetConnectContractItemsOk() ([]AggregationPack, bool)

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

func (*GetAggregationPackListResult) GetMetadata 

func (o *GetAggregationPackListResult) GetMetadata() Metadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*GetAggregationPackListResult) GetMetadataOk 

func (o *GetAggregationPackListResult) GetMetadataOk() (*Metadata, bool)

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

func (*GetAggregationPackListResult) HasConnectContractItems 

func (o *GetAggregationPackListResult) HasConnectContractItems() bool

HasConnectContractItems returns a boolean if a field has been set.

func (*GetAggregationPackListResult) HasMetadata 

func (o *GetAggregationPackListResult) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (GetAggregationPackListResult) MarshalJSON 

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

func (*GetAggregationPackListResult) SetConnectContractItems 

func (o *GetAggregationPackListResult) SetConnectContractItems(v []AggregationPack)

SetConnectContractItems gets a reference to the given []AggregationPack and assigns it to the ConnectContractItems field.

func (*GetAggregationPackListResult) SetMetadata 

func (o *GetAggregationPackListResult) SetMetadata(v Metadata)

SetMetadata gets a reference to the given Metadata and assigns it to the Metadata field.

func (GetAggregationPackListResult) ToMap 

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

func (*GetAggregationPackListResult) UnmarshalJSON 

func (o *GetAggregationPackListResult) UnmarshalJSON(data []byte) (err error)

type MappedNullable 

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

type Metadata 

type Metadata struct {
	// Total amount of elements in this collection
	TotalCount int32 `json:"totalCount"`
	// The offset used to generate this response
	Offset int32 `json:"offset"`
	// The limit used to generate this response
	Limit                int32 `json:"limit"`
	AdditionalProperties map[string]interface{}
}

Metadata Metadata about the collection

func NewMetadata 

func NewMetadata(totalCount int32, offset int32, limit int32) *Metadata

NewMetadata instantiates a new Metadata 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 NewMetadataWithDefaults 

func NewMetadataWithDefaults() *Metadata

NewMetadataWithDefaults instantiates a new Metadata 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 (*Metadata) GetLimit 

func (o *Metadata) GetLimit() int32

GetLimit returns the Limit field value

func (*Metadata) GetLimitOk 

func (o *Metadata) GetLimitOk() (*int32, bool)

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

func (*Metadata) GetOffset 

func (o *Metadata) GetOffset() int32

GetOffset returns the Offset field value

func (*Metadata) GetOffsetOk 

func (o *Metadata) GetOffsetOk() (*int32, bool)

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

func (*Metadata) GetTotalCount 

func (o *Metadata) GetTotalCount() int32

GetTotalCount returns the TotalCount field value

func (*Metadata) GetTotalCountOk 

func (o *Metadata) GetTotalCountOk() (*int32, bool)

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

func (Metadata) MarshalJSON 

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

func (*Metadata) SetLimit 

func (o *Metadata) SetLimit(v int32)

SetLimit sets field value

func (*Metadata) SetOffset 

func (o *Metadata) SetOffset(v int32)

SetOffset sets field value

func (*Metadata) SetTotalCount 

func (o *Metadata) SetTotalCount(v int32)

SetTotalCount sets field value

func (Metadata) ToMap 

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

func (*Metadata) UnmarshalJSON 

func (o *Metadata) UnmarshalJSON(data []byte) (err error)

type NetworkPerformanceType 

type NetworkPerformanceType string

NetworkPerformanceType the model 'NetworkPerformanceType' 

const (
	NETWORKPERFORMANCETYPE_VOLUME  NetworkPerformanceType = "VOLUME"
	NETWORKPERFORMANCETYPE_PREMIUM NetworkPerformanceType = "PREMIUM"
)

List of networkPerformanceType

func NewNetworkPerformanceTypeFromValue 

func NewNetworkPerformanceTypeFromValue(v string) (*NetworkPerformanceType, error)

NewNetworkPerformanceTypeFromValue returns a pointer to a valid NetworkPerformanceType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (NetworkPerformanceType) IsValid 

func (v NetworkPerformanceType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (NetworkPerformanceType) Ptr 

func (v NetworkPerformanceType) Ptr() *NetworkPerformanceType

Ptr returns reference to networkPerformanceType value

func (*NetworkPerformanceType) UnmarshalJSON 

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

type NullableAggregationPack 

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

func NewNullableAggregationPack 

func NewNullableAggregationPack(val *AggregationPack) *NullableAggregationPack

func (NullableAggregationPack) Get 

func (v NullableAggregationPack) Get() *AggregationPack

func (NullableAggregationPack) IsSet 

func (v NullableAggregationPack) IsSet() bool

func (NullableAggregationPack) MarshalJSON 

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

func (*NullableAggregationPack) Set 

func (v *NullableAggregationPack) Set(val *AggregationPack)

func (*NullableAggregationPack) UnmarshalJSON 

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

func (*NullableAggregationPack) Unset 

func (v *NullableAggregationPack) Unset()

type NullableAggregationType 

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

func NewNullableAggregationType 

func NewNullableAggregationType(val *AggregationType) *NullableAggregationType

func (NullableAggregationType) Get 

func (v NullableAggregationType) Get() *AggregationType

func (NullableAggregationType) IsSet 

func (v NullableAggregationType) IsSet() bool

func (NullableAggregationType) MarshalJSON 

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

func (*NullableAggregationType) Set 

func (v *NullableAggregationType) Set(val *AggregationType)

func (*NullableAggregationType) UnmarshalJSON 

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

func (*NullableAggregationType) Unset 

func (v *NullableAggregationType) 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 NullableDataTrafficCommitUnit 

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

func NewNullableDataTrafficCommitUnit 

func NewNullableDataTrafficCommitUnit(val *DataTrafficCommitUnit) *NullableDataTrafficCommitUnit

func (NullableDataTrafficCommitUnit) Get 

func (v NullableDataTrafficCommitUnit) Get() *DataTrafficCommitUnit

func (NullableDataTrafficCommitUnit) IsSet 

func (v NullableDataTrafficCommitUnit) IsSet() bool

func (NullableDataTrafficCommitUnit) MarshalJSON 

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

func (*NullableDataTrafficCommitUnit) Set 

func (v *NullableDataTrafficCommitUnit) Set(val *DataTrafficCommitUnit)

func (*NullableDataTrafficCommitUnit) UnmarshalJSON 

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

func (*NullableDataTrafficCommitUnit) Unset 

func (v *NullableDataTrafficCommitUnit) Unset()

type NullableErrorResult 

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

func NewNullableErrorResult 

func NewNullableErrorResult(val *ErrorResult) *NullableErrorResult

func (NullableErrorResult) Get 

func (v NullableErrorResult) Get() *ErrorResult

func (NullableErrorResult) IsSet 

func (v NullableErrorResult) IsSet() bool

func (NullableErrorResult) MarshalJSON 

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

func (*NullableErrorResult) Set 

func (v *NullableErrorResult) Set(val *ErrorResult)

func (*NullableErrorResult) UnmarshalJSON 

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

func (*NullableErrorResult) Unset 

func (v *NullableErrorResult) 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 NullableGetAggregationPackListResult 

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

func NewNullableGetAggregationPackListResult 

func NewNullableGetAggregationPackListResult(val *GetAggregationPackListResult) *NullableGetAggregationPackListResult

func (NullableGetAggregationPackListResult) Get 

func (v NullableGetAggregationPackListResult) Get() *GetAggregationPackListResult

func (NullableGetAggregationPackListResult) IsSet 

func (v NullableGetAggregationPackListResult) IsSet() bool

func (NullableGetAggregationPackListResult) MarshalJSON 

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

func (*NullableGetAggregationPackListResult) Set 

func (v *NullableGetAggregationPackListResult) Set(val *GetAggregationPackListResult)

func (*NullableGetAggregationPackListResult) UnmarshalJSON 

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

func (*NullableGetAggregationPackListResult) Unset 

func (v *NullableGetAggregationPackListResult) 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 NullableMetadata 

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

func NewNullableMetadata 

func NewNullableMetadata(val *Metadata) *NullableMetadata

func (NullableMetadata) Get 

func (v NullableMetadata) Get() *Metadata

func (NullableMetadata) IsSet 

func (v NullableMetadata) IsSet() bool

func (NullableMetadata) MarshalJSON 

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

func (*NullableMetadata) Set 

func (v *NullableMetadata) Set(val *Metadata)

func (*NullableMetadata) UnmarshalJSON 

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

func (*NullableMetadata) Unset 

func (v *NullableMetadata) Unset()

type NullableNetworkPerformanceType 

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

func NewNullableNetworkPerformanceType 

func NewNullableNetworkPerformanceType(val *NetworkPerformanceType) *NullableNetworkPerformanceType

func (NullableNetworkPerformanceType) Get 

func (v NullableNetworkPerformanceType) Get() *NetworkPerformanceType

func (NullableNetworkPerformanceType) IsSet 

func (v NullableNetworkPerformanceType) IsSet() bool

func (NullableNetworkPerformanceType) MarshalJSON 

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

func (*NullableNetworkPerformanceType) Set 

func (v *NullableNetworkPerformanceType) Set(val *NetworkPerformanceType)

func (*NullableNetworkPerformanceType) UnmarshalJSON 

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

func (*NullableNetworkPerformanceType) Unset 

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

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.