/platform-services-java-sdk

Java SDK for IBM Cloud Platform Services

Primary LanguageJavaApache License 2.0Apache-2.0

Build Status Javadoc Release License semantic-release CLA assistant

IBM Cloud Platform Services Java SDK Version 0.60.0

Java client library to interact with various IBM Cloud Platform Service APIs.

Table of Contents

Overview

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

Service Name Artifact Coordinates
Case Management com.ibm.cloud:case-management:0.60.0
Catalog Management com.ibm.cloud:catalog-management:0.60.0
Context Based Restrictions com.ibm.cloud:context-based-restrictions:0.60.0
Enterprise Billing Units com.ibm.cloud:enterprise-billing-units:0.60.0
Enterprise Management com.ibm.cloud:enterprise-management:0.60.0
Enterprise Usage Reports com.ibm.cloud:enterprise-usage-reports:0.60.0
Global Catalog com.ibm.cloud:global-catalog:0.60.0
Global Search com.ibm.cloud:global-search:0.60.0
Global Tagging com.ibm.cloud:global-tagging:0.60.0
IAM Access Groups com.ibm.cloud:iam-access-groups:0.60.0
IAM Identity Service com.ibm.cloud:iam-identity:0.60.0
IAM Policy Management com.ibm.cloud:iam-policy-management:0.60.0
IBM Cloud Shell com.ibm.cloud:ibm-cloud-shell:0.60.0
Open Service Broker com.ibm.cloud:open-service-broker:0.60.0
Partner Management APIs com.ibm.cloud:partner-management:0.60.0
Resource Controller com.ibm.cloud:resource-controller:0.60.0
Resource Manager com.ibm.cloud:resource-manager:0.60.0
Usage Metering com.ibm.cloud:usage-metering:0.60.0
Usage Reports com.ibm.cloud:usage-reports:0.60.0
User Management com.ibm.cloud:user-management:0.60.0

The following services have been relocated to a different SDK project. Please consult the documentation for each service to determine the new location:

Service Name Artifact Coordinates
Configuration Governance com.ibm.cloud:configuration-governance:0.60.0
Posture Management com.ibm.cloud:posture_management:0.60.0

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.60.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>case-management</artifactId>
    <version>0.60.0</version>
</dependency>

Gradle

compile 'com.ibm.cloud:case-management:0.60.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 Platform Services Java SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.