# README
Go API client for ionoscloud
API Gateway is an application that acts as a "front door" for backend services and APIs, handling client requests and routing them to the appropriate backend.
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: 0.0.1
- Package version: 1.1.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 ionoscloud "github.com/ionos-cloud/sdk-go-api-gateway"
To use a proxy, set the environment variable HTTP_PROXY:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.
ctx := context.WithValue(context.Background(), ionoscloud.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.
ctx := context.WithValue(context.Background(), ionoscloud.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
Documentation for API Endpoints
All URIs are relative to https://apigateway.de-txl.ionos.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| APIGatewaysApi | ApigatewaysDelete | Delete /gateways/{apigatewayId} | Delete Gateway |
| APIGatewaysApi | ApigatewaysFindById | Get /gateways/{apigatewayId} | Retrieve Gateway |
| APIGatewaysApi | ApigatewaysGet | Get /gateways | Retrieve all Apigateways |
| APIGatewaysApi | ApigatewaysPost | Post /gateways | Create Gateway |
| APIGatewaysApi | ApigatewaysPut | Put /gateways/{apigatewayId} | Ensure Gateway |
| RoutesApi | ApigatewaysRoutesDelete | Delete /gateways/{apigatewayId}/routes/{routeId} | Delete Route |
| RoutesApi | ApigatewaysRoutesFindById | Get /gateways/{apigatewayId}/routes/{routeId} | Retrieve Route |
| RoutesApi | ApigatewaysRoutesGet | Get /gateways/{apigatewayId}/routes | Retrieve all Routes |
| RoutesApi | ApigatewaysRoutesPost | Post /gateways/{apigatewayId}/routes | Create Route |
| RoutesApi | ApigatewaysRoutesPut | Put /gateways/{apigatewayId}/routes/{routeId} | Ensure Route |
Documentation For Models
- Error
- ErrorMessages
- Gateway
- GatewayCreate
- GatewayCustomDomains
- GatewayEnsure
- GatewayRead
- GatewayReadList
- GatewayReadListAllOf
- Links
- Metadata
- MetadataWithEndpoint
- MetadataWithEndpointAllOf
- MetadataWithStatus
- MetadataWithStatusAllOf
- Pagination
- Route
- RouteCreate
- RouteEnsure
- RouteRead
- RouteReadList
- RouteReadListAllOf
- RouteUpstreams
Documentation For Authorization
Authentication schemes defined for the API:
tokenAuth
- Type: HTTP Bearer token authentication
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_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:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime
Author
# Functions
AddPinnedCert - enables pinning of the sha256 public fingerprint to the http client's transport.
CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
No description provided by the author
No description provided by the author
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.
NewErrorMessages instantiates a new ErrorMessages 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.
NewErrorMessagesWithDefaults instantiates a new ErrorMessages 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.
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.
NewGateway instantiates a new Gateway 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.
NewGatewayCreate instantiates a new GatewayCreate 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.
NewGatewayCreateWithDefaults instantiates a new GatewayCreate 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.
NewGatewayCustomDomains instantiates a new GatewayCustomDomains 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.
NewGatewayCustomDomainsWithDefaults instantiates a new GatewayCustomDomains 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.
NewGatewayEnsure instantiates a new GatewayEnsure 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.
NewGatewayEnsureWithDefaults instantiates a new GatewayEnsure 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.
NewGatewayRead instantiates a new GatewayRead 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.
NewGatewayReadList instantiates a new GatewayReadList 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.
NewGatewayReadListAllOf instantiates a new GatewayReadListAllOf 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.
NewGatewayReadListAllOfWithDefaults instantiates a new GatewayReadListAllOf 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.
NewGatewayReadListWithDefaults instantiates a new GatewayReadList 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.
NewGatewayReadWithDefaults instantiates a new GatewayRead 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.
NewGatewayWithDefaults instantiates a new Gateway 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.
NewGenericOpenAPIError - constructor for GenericOpenAPIError.
NewLinks instantiates a new Links 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.
NewLinksWithDefaults instantiates a new Links 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.
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.
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.
NewMetadataWithEndpoint instantiates a new MetadataWithEndpoint 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.
NewMetadataWithEndpointAllOf instantiates a new MetadataWithEndpointAllOf 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.
NewMetadataWithEndpointAllOfWithDefaults instantiates a new MetadataWithEndpointAllOf 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.
NewMetadataWithEndpointWithDefaults instantiates a new MetadataWithEndpoint 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.
NewMetadataWithStatus instantiates a new MetadataWithStatus 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.
NewMetadataWithStatusAllOf instantiates a new MetadataWithStatusAllOf 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.
NewMetadataWithStatusAllOfWithDefaults instantiates a new MetadataWithStatusAllOf 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.
NewMetadataWithStatusWithDefaults instantiates a new MetadataWithStatus 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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPagination instantiates a new Pagination 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.
NewPaginationWithDefaults instantiates a new Pagination 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.
NewRoute instantiates a new Route 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.
NewRouteCreate instantiates a new RouteCreate 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.
NewRouteCreateWithDefaults instantiates a new RouteCreate 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.
NewRouteEnsure instantiates a new RouteEnsure 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.
NewRouteEnsureWithDefaults instantiates a new RouteEnsure 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.
NewRouteRead instantiates a new RouteRead 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.
NewRouteReadList instantiates a new RouteReadList 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.
NewRouteReadListAllOf instantiates a new RouteReadListAllOf 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.
NewRouteReadListAllOfWithDefaults instantiates a new RouteReadListAllOf 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.
NewRouteReadListWithDefaults instantiates a new RouteReadList 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.
NewRouteReadWithDefaults instantiates a new RouteRead 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.
NewRouteUpstreams instantiates a new RouteUpstreams 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.
NewRouteUpstreamsWithDefaults instantiates a new RouteUpstreams 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.
NewRouteWithDefaults instantiates a new Route 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.
PtrBool - returns a pointer to given boolean value.
PtrFloat32 - returns a pointer to given float value.
PtrFloat64 - returns a pointer to given float value.
PtrInt - returns a pointer to given integer value.
PtrInt32 - returns a pointer to given integer value.
PtrInt64 - returns a pointer to given integer value.
PtrString - returns a pointer to given string value.
PtrTime - returns a pointer to given Time value.
No description provided by the author
ToBool - returns the value of the bool pointer passed in.
ToBoolDefault - returns the value of the bool pointer passed in, or false if the pointer is nil.
ToBoolSlice - returns a bool slice of the pointer passed in.
ToByte - returns the value of the byte pointer passed in.
ToByteDefault - returns the value of the byte pointer passed in, or 0 if the pointer is nil.
ToByteSlice - returns a byte slice of the pointer passed in.
ToFloat32 - returns the value of the float32 pointer passed in.
ToFloat32Default - returns the value of the float32 pointer passed in, or 0 if the pointer is nil.
ToFloat32Slice - returns a float32 slice of the pointer passed in.
ToFloat64 - returns the value of the float64 pointer passed in.
ToFloat64Default - returns the value of the float64 pointer passed in, or 0 if the pointer is nil.
ToFloat64Slice - returns a float64 slice of the pointer passed in.
ToInt - returns the value of the int pointer passed in.
ToInt16 - returns the value of the int16 pointer passed in.
ToInt16Default - returns the value of the int16 pointer passed in, or 0 if the pointer is nil.
ToInt16Slice - returns a int16 slice of the pointer passed in.
ToInt32 - returns the value of the int32 pointer passed in.
ToInt32Default - returns the value of the int32 pointer passed in, or 0 if the pointer is nil.
ToInt32Slice - returns a int32 slice of the pointer passed in.
ToInt64 - returns the value of the int64 pointer passed in.
ToInt64Default - returns the value of the int64 pointer passed in, or 0 if the pointer is nil.
ToInt64Slice - returns a int64 slice of the pointer passed in.
ToInt8 - returns the value of the int8 pointer passed in.
ToInt8Default - returns the value of the int8 pointer passed in, or 0 if the pointer is nil.
ToInt8Slice - returns a int8 slice of the pointer passed in.
ToIntDefault - returns the value of the int pointer passed in, or 0 if the pointer is nil.
ToIntSlice - returns a int slice of the pointer passed in.
ToPtr - returns a pointer to the given value.
ToString - returns the value of the string pointer passed in.
ToStringDefault - returns the value of the string pointer passed in, or "" if the pointer is nil.
ToStringSlice - returns a string slice of the pointer passed in.
ToTime - returns the value of the Time pointer passed in.
ToTimeDefault - returns the value of the Time pointer passed in, or 0001-01-01 00:00:00 +0000 UTC if the pointer is nil.
ToTimeSlice - returns a Time slice of the pointer passed in.
ToUint - returns the value of the uint pointer passed in.
ToUint16 - returns the value of the uint16 pointer passed in.
ToUint16Default - returns the value of the uint16 pointer passed in, or 0 if the pointer is nil.
ToUint16Slice - returns a uint16 slice of the pointer passed in.
ToUint32 - returns the value of the uint32 pointer passed in.
ToUint32Default - returns the value of the uint32 pointer passed in, or 0 if the pointer is nil.
ToUint32Slice - returns a uint32 slice of the pointer passed in.
ToUint64 - returns the value of the uint64 pointer passed in.
ToUint64Default - returns the value of the uint64 pointer passed in, or 0 if the pointer is nil.
ToUint64Slice - returns a uint63 slice of the pointer passed in.
ToUint8 -returns the value of the uint8 pointer passed in.
ToUint8Default - returns the value of the uint8 pointer passed in, or 0 if the pointer is nil.
ToUint8Slice - returns a uint8 slice of the pointer passed in.
ToUintDefault - returns the value of the uint pointer passed in, or 0 if the pointer is nil.
ToUintSlice - returns a uint slice of the pointer passed in.
ToValue - returns the value of the pointer passed in.
ToValueDefault - returns the value of the pointer passed in, or the default type value if the pointer is nil.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Trace We recommend you only set this field for debugging purposes.
No description provided by the author
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIClient manages communication with the IONOS Cloud - API Gateway API v0.0.1 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
Error The Error object is used to represent an error response from the API.
ErrorMessages struct for ErrorMessages.
Gateway An API gateway consists of the generic rules and configurations of an API Gateway.
GatewayCreate struct for GatewayCreate.
GatewayCustomDomains The custom domain that the API Gateway instance should listen on.
GatewayEnsure struct for GatewayEnsure.
GatewayRead struct for GatewayRead.
GatewayReadList struct for GatewayReadList.
GatewayReadListAllOf struct for GatewayReadListAllOf.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
No description provided by the author
Links URLs to navigate the different pages.
Metadata Metadata of the resource.
MetadataWithEndpoint struct for MetadataWithEndpoint.
MetadataWithEndpointAllOf struct for MetadataWithEndpointAllOf.
MetadataWithStatus struct for MetadataWithStatus.
MetadataWithStatusAllOf struct for MetadataWithStatusAllOf.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Pagination Pagination information.
Route A route is a rule that maps an incoming request to a specific backend service.
RouteCreate struct for RouteCreate.
RouteEnsure struct for RouteEnsure.
RouteRead struct for RouteRead.
RouteReadList struct for RouteReadList.
RouteReadListAllOf struct for RouteReadListAllOf.
RouteUpstreams struct for RouteUpstreams.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
# Interfaces
No description provided by the author
# Type aliases
APIGatewaysApiService APIGatewaysApi service.
No description provided by the author
RoutesApiService RoutesApi service.
ServerConfigurations stores multiple ServerConfiguration items.
TLSDial can be assigned to a http.Transport's DialTLS field.