Go client library to interact with the various IBM Analytics Engine APIs.
- Overview
- Prerequisites
- Installation
- Using the SDK
- Questions
- Issues
- Open source @ IBM
- Contributing
- License
The IBM Cloud IBM Analytics Engine API Go SDK allows developers to programmatically interact with the following IBM Cloud services:
| Service Name | Package name |
|---|---|
| IBM Analytics Engine v2 | ibmanalyticsengineapiv2 |
| IBM Analytics Engine v3 | ibmanalyticsengineapiv3 |
NOTE
IBM Analytics Engine v2 is for the classic plans : Lite, Standard Hourly and Standard monthly. These plans are now deprecated.
IBM Analytics Engine v3 is for the Standard Serverless for Apache Spark plan
- An IBM Cloud account.
- An IAM API key to allow the SDK to access your account. Create one here.
- Go version 1.18 or above.
The current version of this SDK: 2.2.0
There are a few different ways to download and install the IBM Analytics Engine API Go SDK project for use by your Go application:
Use this command to download and install the SDK (along with its dependencies) to allow your Go application to use it:
go get -u github.com/IBM/ibm-iae-go-sdk/...
If you are creating a new go project then create a folder inside $GOPATH and install packages. For example:
mkdir -p ~/go/src/go-test
cd ~/go/src/go-test
go get -u github.com/IBM/ibm-iae-go-sdk/...
If your application is using Go modules, you can add a suitable import to your Go application, like this:
import (
"github.com/IBM/ibm-iae-go-sdk/ibmanalyticsengineapiv2"
)then run go mod tidy to download and install the new dependency and update your Go application's go.mod file.
If you are creating a new go project then create a folder outside $GOPATH, init module, and install packages. For example:
mkdir -p ~/go-test
cd ~/go-test
go mod init <some-name>
go get -u github.com/IBM/ibm-iae-go-sdk
For general SDK usage information, please see this link
In setting client options programatically to instantiate the class, provide the following two values:
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
If you encounter an issue with the project, you are welcome to submit a [bug report](/issues). Before that, please search for similar issues. It's possible that someone has already reported the problem.
Find more open source projects on the IBM Github Page
See CONTRIBUTING.
This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.