Details about communicating with Ambar.cloud public endpoints. Supported HTTP rest endpoints and their request and response details.
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: 2024-06-11
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/ambarltd/ambar-openapi-spec
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 Ambar "github.com/GIT_USER_ID/GIT_REPO_ID"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value Ambar.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), Ambar.ContextServerIndex, 1)
Templated server URL is formatted using default variables from configuration or from context value Ambar.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), Ambar.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
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 Ambar.ContextOperationServerIndices
and Ambar.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), Ambar.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), Ambar.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
All URIs are relative to https://euw1.api.ambar.cloud
Class | Method | HTTP request | Description |
---|---|---|---|
AmbarAPI | CreateDataDestination | Post /destination | Create a DataDestination in your Ambar environment. |
AmbarAPI | CreateDataSource | Post /source | Create a DataSource in your Ambar environment. |
AmbarAPI | CreateFilter | Post /filter | Create a Filter in your Ambar environment. |
AmbarAPI | DeleteDataDestination | Delete /destination | Delete a DataDestination in your Ambar environment. |
AmbarAPI | DeleteDataSource | Delete /source | Delete a DataSource in your Ambar environment. |
AmbarAPI | DeleteFilter | Delete /filter | Delete a Filter in your Ambar environment. |
AmbarAPI | DescribeDataDestination | Get /destination | Describe a DataDestination in your Ambar environment. |
AmbarAPI | DescribeDataSource | Get /source | Describe a DataSource in your Ambar environment. |
AmbarAPI | DescribeFilter | Get /filter | Describes a Filter in your Ambar environment. |
AmbarAPI | ListResources | Get /resource | List the Ambar resources in your Ambar environment. |
AmbarAPI | UpdateDataDestination | Put /destination | Updates a DataDestination in your Ambar environment. |
AmbarAPI | UpdateDataDestinationCredentials | Patch /destination | Update the credentials associated with a DataDestination in your Ambar environment. |
AmbarAPI | UpdateDataSource | Put /source | Updates a DataSource in your Ambar environment. |
AmbarAPI | UpdateDataSourceCredentials | Patch /source | Update the credentials associated with a DataSource in your Ambar environment. |
- AmbarServiceException
- CreateDataDestinationRequest
- CreateDataSourceRequest
- CreateFilter400Response
- CreateFilterRequest
- DataDestination
- DataSource
- DeleteFilter400Response
- DeleteResourceRequest
- DescribeResourceRequest
- Filter
- InvalidFilterException
- InvalidParameterException
- ListResourcesRequest
- ListResourcesResponse
- ResourceDetails
- ResourceInvalidStateException
- ResourceNotFoundException
- ResourceStateChangeResponse
- ResourceTypeDetails
- ResourceTypeDetailsLimit
- UpdateDataDestinationRequest
- UpdateDataSourceRequest
- UpdateResourceCredentialsRequest
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey
where the key is: x-api-key and passed in as the auth context for each request.
Example
auth := context.WithValue(
context.Background(),
Ambar.ContextAPIKeys,
map[string]Ambar.APIKey{
"x-api-key": {Key: "API_KEY_STRING"},
},
)
r, err := client.Service.Operation(auth, args)
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