Akhil-J / ibm-iae-java-sdk

Java SDK for IBM Analytics Engine Service.

IBM Cloud Analytics Engine SDK Version 1.2.0

Java client library to interact with various IBM Analytics Engine APIs.

• Overview
• Prerequisites
• Installation
  • All the services
  • A single service
• Using the SDK
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

The IBM Cloud Analytics Engine Services Java SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name	Artifact Coordinates
IBM Analytics Engine APIs v2	com.ibm.cloud:ibm-analytics-engine-api:1.2.0
IBM Analytics Engine APIs v3	com.ibm.cloud:ibm-analytics-engine-api:1.2.0

The module name for both the versions are same : ibm-analytics-engine-api The two versions are differntiated by the version number in the Java package structure. Example : com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v2 vs com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3

NOTE

IBM Analytics Engine v2 is for the classic plans : Lite, Standard Hourly and Standard monthly. The classic plans are now deprecated.

IBM Analytics Engine v3 is for the Standard Serverless for Apache Spark plan.

Prerequisites

• An IBM Cloud account.
• An IAM API key to allow the SDK to access your account. Create one here.
• Java 8 or above.

Installation

The current version of this SDK is: 1.2.0

Each service's artifact coordinates are listed in the table above.

The project artifacts are published on the public Maven Central artifact repository. This is the default public repository used by maven when searching for dependencies. To use this repository within a gradle build, please see this link.

To use a particular service in your application, define a dependency that contains the artifact coordinates (group id, artifact id and version) for the service. Here are examples for maven and gradle:

Maven

<dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>ibm-analytics-engine-api</artifactId>
    <version>1.2.0</version>
</dependency>

Gradle

'com.ibm.cloud:ibm-analytics-engine-api:1.2.0'

Using the SDK

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

The IBM Cloud Analytics Engine Java SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.