locationapi

package module
v3.0.0 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: MPL-2.0 Imports: 20 Imported by: 4

README

Go API client for locationapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.

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 locationapi "github.com/phoenixnap/go-sdk-bmc/locationapi"

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

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

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.phoenixnap.com/location-api/v1

Class Method HTTP request Description
LocationsAPI GetLocations Get /locations Get All Locations

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]

Documentation

Index

Constants

View Source 
const SdkVersion = "3.0.0"

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

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

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

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var AllowedLocationEnumEnumValues = []LocationEnum{
	"PHX",
	"ASH",
	"NLD",
	"SGP",
	"CHI",
	"SEA",
	"AUS",
}

All allowed values of LocationEnum enum

View Source 
var AllowedProductCategoryEnumEnumValues = []ProductCategoryEnum{
	"SERVER",
	"BANDWIDTH",
	"OPERATING_SYSTEM",
	"PUBLIC_IP",
	"STORAGE",
}

All allowed values of ProductCategoryEnum 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 {
	LocationsAPI LocationsAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the Locations API API v1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

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

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

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

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

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

type APIResponse 

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

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

type ApiGetLocationsRequest 

type ApiGetLocationsRequest struct {
	ApiService LocationsAPI
	// contains filtered or unexported fields
}

func (ApiGetLocationsRequest) Execute 

func (r ApiGetLocationsRequest) Execute() ([]Location, *http.Response, error)

func (ApiGetLocationsRequest) Location 

func (r ApiGetLocationsRequest) Location(location LocationEnum) ApiGetLocationsRequest

Location of interest

func (ApiGetLocationsRequest) ProductCategory 

func (r ApiGetLocationsRequest) ProductCategory(productCategory ProductCategoryEnum) ApiGetLocationsRequest

Product category of interest

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"`
	XPoweredBy       string            `json:"xPoweredBy,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 Error 

type Error struct {
	// The description detailing the cause of the error code.
	Message string `json:"message"`
	// Validation errors, if any.
	ValidationErrors     []string `json:"validationErrors,omitempty"`
	AdditionalProperties map[string]interface{}
}

Error struct for Error

func NewError 

func NewError(message string) *Error

NewError instantiates a new Error 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 NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error 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 (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

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

func (*Error) GetValidationErrors 

func (o *Error) GetValidationErrors() []string

GetValidationErrors returns the ValidationErrors field value if set, zero value otherwise.

func (*Error) GetValidationErrorsOk 

func (o *Error) GetValidationErrorsOk() ([]string, bool)

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

func (*Error) HasValidationErrors 

func (o *Error) HasValidationErrors() bool

HasValidationErrors returns a boolean if a field has been set.

func (Error) MarshalJSON 

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

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetValidationErrors 

func (o *Error) SetValidationErrors(v []string)

SetValidationErrors gets a reference to the given []string and assigns it to the ValidationErrors field.

func (Error) ToMap 

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

func (*Error) UnmarshalJSON 

func (o *Error) 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 Location 

type Location struct {
	Location             LocationEnum      `json:"location"`
	LocationDescription  *string           `json:"locationDescription,omitempty"`
	ProductCategories    []ProductCategory `json:"productCategories,omitempty"`
	AdditionalProperties map[string]interface{}
}

Location Location resource

func NewLocation 

func NewLocation(location LocationEnum) *Location

NewLocation instantiates a new Location 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 NewLocationWithDefaults 

func NewLocationWithDefaults() *Location

NewLocationWithDefaults instantiates a new Location 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 (*Location) GetLocation 

func (o *Location) GetLocation() LocationEnum

GetLocation returns the Location field value

func (*Location) GetLocationDescription 

func (o *Location) GetLocationDescription() string

GetLocationDescription returns the LocationDescription field value if set, zero value otherwise.

func (*Location) GetLocationDescriptionOk 

func (o *Location) GetLocationDescriptionOk() (*string, bool)

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

func (*Location) GetLocationOk 

func (o *Location) GetLocationOk() (*LocationEnum, bool)

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

func (*Location) GetProductCategories 

func (o *Location) GetProductCategories() []ProductCategory

GetProductCategories returns the ProductCategories field value if set, zero value otherwise.

func (*Location) GetProductCategoriesOk 

func (o *Location) GetProductCategoriesOk() ([]ProductCategory, bool)

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

func (*Location) HasLocationDescription 

func (o *Location) HasLocationDescription() bool

HasLocationDescription returns a boolean if a field has been set.

func (*Location) HasProductCategories 

func (o *Location) HasProductCategories() bool

HasProductCategories returns a boolean if a field has been set.

func (Location) MarshalJSON 

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

func (*Location) SetLocation 

func (o *Location) SetLocation(v LocationEnum)

SetLocation sets field value

func (*Location) SetLocationDescription 

func (o *Location) SetLocationDescription(v string)

SetLocationDescription gets a reference to the given string and assigns it to the LocationDescription field.

func (*Location) SetProductCategories 

func (o *Location) SetProductCategories(v []ProductCategory)

SetProductCategories gets a reference to the given []ProductCategory and assigns it to the ProductCategories field.

func (Location) ToMap 

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

func (*Location) UnmarshalJSON 

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

type LocationEnum 

type LocationEnum string

LocationEnum The location code. 

const (
	LOCATIONENUM_PHX LocationEnum = "PHX"
	LOCATIONENUM_ASH LocationEnum = "ASH"
	LOCATIONENUM_NLD LocationEnum = "NLD"
	LOCATIONENUM_SGP LocationEnum = "SGP"
	LOCATIONENUM_CHI LocationEnum = "CHI"
	LOCATIONENUM_SEA LocationEnum = "SEA"
	LOCATIONENUM_AUS LocationEnum = "AUS"
)

List of LocationEnum

func NewLocationEnumFromValue 

func NewLocationEnumFromValue(v string) (*LocationEnum, error)

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

func (LocationEnum) IsValid 

func (v LocationEnum) IsValid() bool

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

func (LocationEnum) Ptr 

func (v LocationEnum) Ptr() *LocationEnum

Ptr returns reference to LocationEnum value

func (*LocationEnum) UnmarshalJSON 

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

type LocationsAPI 

type LocationsAPI interface {

	/*
		GetLocations Get All Locations

		Retrieve the locations info.

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

	// GetLocationsExecute executes the request
	//  @return []Location
	GetLocationsExecute(r ApiGetLocationsRequest) ([]Location, *http.Response, error)
}

type LocationsAPIService 

type LocationsAPIService service

LocationsAPIService LocationsAPI service

func (*LocationsAPIService) GetLocations 

func (a *LocationsAPIService) GetLocations(ctx context.Context) ApiGetLocationsRequest

GetLocations Get All Locations

Retrieve the locations info. 

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

func (*LocationsAPIService) GetLocationsExecute 

func (a *LocationsAPIService) GetLocationsExecute(r ApiGetLocationsRequest) ([]Location, *http.Response, error)

Execute executes the request 

@return []Location

type MappedNullable 

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

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

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

func (*NullableBool) Set 

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

func (*NullableBool) UnmarshalJSON 

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

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

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

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

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

func (*NullableError) Unset 

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

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

func NewNullableLocation 

func NewNullableLocation(val *Location) *NullableLocation

func (NullableLocation) Get 

func (v NullableLocation) Get() *Location

func (NullableLocation) IsSet 

func (v NullableLocation) IsSet() bool

func (NullableLocation) MarshalJSON 

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

func (*NullableLocation) Set 

func (v *NullableLocation) Set(val *Location)

func (*NullableLocation) UnmarshalJSON 

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

func (*NullableLocation) Unset 

func (v *NullableLocation) Unset()

type NullableLocationEnum 

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

func NewNullableLocationEnum 

func NewNullableLocationEnum(val *LocationEnum) *NullableLocationEnum

func (NullableLocationEnum) Get 

func (v NullableLocationEnum) Get() *LocationEnum

func (NullableLocationEnum) IsSet 

func (v NullableLocationEnum) IsSet() bool

func (NullableLocationEnum) MarshalJSON 

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

func (*NullableLocationEnum) Set 

func (v *NullableLocationEnum) Set(val *LocationEnum)

func (*NullableLocationEnum) UnmarshalJSON 

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

func (*NullableLocationEnum) Unset 

func (v *NullableLocationEnum) Unset()

type NullableProductCategory 

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

func NewNullableProductCategory 

func NewNullableProductCategory(val *ProductCategory) *NullableProductCategory

func (NullableProductCategory) Get 

func (v NullableProductCategory) Get() *ProductCategory

func (NullableProductCategory) IsSet 

func (v NullableProductCategory) IsSet() bool

func (NullableProductCategory) MarshalJSON 

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

func (*NullableProductCategory) Set 

func (v *NullableProductCategory) Set(val *ProductCategory)

func (*NullableProductCategory) UnmarshalJSON 

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

func (*NullableProductCategory) Unset 

func (v *NullableProductCategory) Unset()

type NullableProductCategoryEnum 

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

func NewNullableProductCategoryEnum 

func NewNullableProductCategoryEnum(val *ProductCategoryEnum) *NullableProductCategoryEnum

func (NullableProductCategoryEnum) Get 

func (v NullableProductCategoryEnum) Get() *ProductCategoryEnum

func (NullableProductCategoryEnum) IsSet 

func (v NullableProductCategoryEnum) IsSet() bool

func (NullableProductCategoryEnum) MarshalJSON 

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

func (*NullableProductCategoryEnum) Set 

func (v *NullableProductCategoryEnum) Set(val *ProductCategoryEnum)

func (*NullableProductCategoryEnum) UnmarshalJSON 

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

func (*NullableProductCategoryEnum) Unset 

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

type ProductCategory struct {
	ProductCategory            ProductCategoryEnum `json:"productCategory"`
	ProductCategoryDescription *string             `json:"productCategoryDescription,omitempty"`
	AdditionalProperties       map[string]interface{}
}

ProductCategory struct for ProductCategory

func NewProductCategory 

func NewProductCategory(productCategory ProductCategoryEnum) *ProductCategory

NewProductCategory instantiates a new ProductCategory 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 NewProductCategoryWithDefaults 

func NewProductCategoryWithDefaults() *ProductCategory

NewProductCategoryWithDefaults instantiates a new ProductCategory 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 (*ProductCategory) GetProductCategory 

func (o *ProductCategory) GetProductCategory() ProductCategoryEnum

GetProductCategory returns the ProductCategory field value

func (*ProductCategory) GetProductCategoryDescription 

func (o *ProductCategory) GetProductCategoryDescription() string

GetProductCategoryDescription returns the ProductCategoryDescription field value if set, zero value otherwise.

func (*ProductCategory) GetProductCategoryDescriptionOk 

func (o *ProductCategory) GetProductCategoryDescriptionOk() (*string, bool)

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

func (*ProductCategory) GetProductCategoryOk 

func (o *ProductCategory) GetProductCategoryOk() (*ProductCategoryEnum, bool)

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

func (*ProductCategory) HasProductCategoryDescription 

func (o *ProductCategory) HasProductCategoryDescription() bool

HasProductCategoryDescription returns a boolean if a field has been set.

func (ProductCategory) MarshalJSON 

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

func (*ProductCategory) SetProductCategory 

func (o *ProductCategory) SetProductCategory(v ProductCategoryEnum)

SetProductCategory sets field value

func (*ProductCategory) SetProductCategoryDescription 

func (o *ProductCategory) SetProductCategoryDescription(v string)

SetProductCategoryDescription gets a reference to the given string and assigns it to the ProductCategoryDescription field.

func (ProductCategory) ToMap 

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

func (*ProductCategory) UnmarshalJSON 

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

type ProductCategoryEnum 

type ProductCategoryEnum string

ProductCategoryEnum The product category. 

const (
	PRODUCTCATEGORYENUM_SERVER           ProductCategoryEnum = "SERVER"
	PRODUCTCATEGORYENUM_BANDWIDTH        ProductCategoryEnum = "BANDWIDTH"
	PRODUCTCATEGORYENUM_OPERATING_SYSTEM ProductCategoryEnum = "OPERATING_SYSTEM"
	PRODUCTCATEGORYENUM_PUBLIC_IP        ProductCategoryEnum = "PUBLIC_IP"
	PRODUCTCATEGORYENUM_STORAGE          ProductCategoryEnum = "STORAGE"
)

List of ProductCategoryEnum

func NewProductCategoryEnumFromValue 

func NewProductCategoryEnumFromValue(v string) (*ProductCategoryEnum, error)

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

func (ProductCategoryEnum) IsValid 

func (v ProductCategoryEnum) IsValid() bool

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

func (ProductCategoryEnum) Ptr 

func (v ProductCategoryEnum) Ptr() *ProductCategoryEnum

Ptr returns reference to ProductCategoryEnum value

func (*ProductCategoryEnum) UnmarshalJSON 

func (v *ProductCategoryEnum) UnmarshalJSON(src []byte) 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.