Skip to content

IBM/dra-java-sdk

Build Status semantic-release

IBM Cloud DrAutomation java SDK Version 0.0.1

Java client library to interact with various IBM Cloud DrAutomation services.

Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.

Table of Contents

Overview

The IBM Cloud DrAutomation services Java SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name Artifact Coordinates
DrAutomation Service com.ibm.cloud:drautomation-sdk:0.0.1

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: 0.0.1

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, 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>dr-automation-service</artifactId>
    <version>0.0.1</version>
</dependency>

Gradle

compile 'com.ibm.cloud:dr-automation-service:0.0.1'

Using the SDK

For general SDK usage information, please see this link

Environment Configuration

The SDK can be configured using environment variables. Here's an example configuration:

# Service URL (for development/testing)
export DR_AUTOMATION_SERVICE_URL=https://power-dra.cloud.ibm.com

# Authentication type
export DR_AUTOMATION_SERVICE_AUTH_TYPE=bearerToken

# Bearer token for authentication
export DR_AUTOMATION_SERVICE_BEARER_TOKEN=eyJraWQiOiIyMDE5MD......

Note: The bearer token shown above is an example. For production use:

  • Use the actual service endpoint URL
  • Generate your own valid IAM bearer token

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 DrAutomation services Java SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.

About

Enabling SDK for java for the IBM Power Virtual Server DR Automation offer

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •