An open API service indexing awesome lists of open source software.

https://github.com/ibm/platform-services-java-sdk

Java SDK for IBM Cloud Platform Services
https://github.com/ibm/platform-services-java-sdk

cloud-computing cloud-services global-search global-tagging ibm ibm-cloud java java-8 sdk sdk-java

Last synced: 6 months ago
JSON representation

Java SDK for IBM Cloud Platform Services

Awesome Lists containing this project

README

          

[![Build Status](https://github.com/IBM/platform-services-java-sdk/actions/workflows/build.yaml/badge.svg)](https://github.com/IBM/platform-services-java-sdk/actions/workflows/build.yaml)
[![Javadoc](https://img.shields.io/static/v1?label=javadoc&message=latest&color=blue)](https://ibm.github.io/platform-services-java-sdk/docs/latest)
[![Release](https://img.shields.io/github/v/release/IBM/platform-services-java-sdk)](https://github.com/IBM/platform-services-java-sdk/releases/latest)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![CLA assistant](https://cla-assistant.io/readme/badge/IBM/platform-services-java-sdk)](https://cla-assistant.io/IBM/platform-services-java-sdk)

# IBM Cloud Platform Services Java SDK Version 0.63.0

Java client library to interact with various
[IBM Cloud Platform Service APIs](https://cloud.ibm.com/docs?tab=api-docs&category=platform_services).

## Table of Contents

- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
* [Maven](#maven)
* [Gradle](#gradle)
- [Using the SDK](#using-the-sdk)
- [Questions](#questions)
- [Issues](#issues)
- [Open source @ IBM](#open-source--ibm)
- [Contributing](#contributing)
- [License](#license)

## 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](https://cloud.ibm.com/apidocs/case-management?code=java) | com.ibm.cloud:case-management:0.63.0
[Catalog Management](https://cloud.ibm.com/apidocs/resource-catalog/private-catalog?code=java) | com.ibm.cloud:catalog-management:0.63.0
[Context Based Restrictions](https://cloud.ibm.com/apidocs/context-based-restrictions?code=java) | com.ibm.cloud:context-based-restrictions:0.63.0
[Enterprise Billing Units](https://cloud.ibm.com/apidocs/enterprise-apis/billing-unit?code=java) | com.ibm.cloud:enterprise-billing-units:0.63.0
[Enterprise Management](https://cloud.ibm.com/apidocs/enterprise-apis/enterprise?code=java) | com.ibm.cloud:enterprise-management:0.63.0
[Enterprise Usage Reports](https://cloud.ibm.com/apidocs/enterprise-apis/resource-usage-reports?code=java) | com.ibm.cloud:enterprise-usage-reports:0.63.0
[Global Catalog](https://cloud.ibm.com/apidocs/resource-catalog/global-catalog?code=java) | com.ibm.cloud:global-catalog:0.63.0
[Global Search](https://cloud.ibm.com/apidocs/search?code=java) | com.ibm.cloud:global-search:0.63.0
[Global Tagging](https://cloud.ibm.com/apidocs/tagging?code=java) | com.ibm.cloud:global-tagging:0.63.0
[IAM Access Groups](https://cloud.ibm.com/apidocs/iam-access-groups?code=java) | com.ibm.cloud:iam-access-groups:0.63.0
[IAM Identity Service](https://cloud.ibm.com/apidocs/iam-identity-token-api?code=java) | com.ibm.cloud:iam-identity:0.63.0
[IAM Policy Management](https://cloud.ibm.com/apidocs/iam-policy-management?code=java) | com.ibm.cloud:iam-policy-management:0.63.0
[IBM Cloud Shell](https://cloud.ibm.com/apidocs/cloudshell?code=java) | com.ibm.cloud:ibm-cloud-shell:0.63.0
[Open Service Broker](https://cloud.ibm.com/apidocs/resource-controller/ibm-cloud-osb-api?code=java) | com.ibm.cloud:open-service-broker:0.63.0
[Partner Management APIs](https://cloud.ibm.com/apidocs/partner-apis/partner?code=go) | com.ibm.cloud:partner-management:0.63.0
[Resource Controller](https://cloud.ibm.com/apidocs/resource-controller/resource-controller?code=java) | com.ibm.cloud:resource-controller:0.63.0
[Resource Manager](https://cloud.ibm.com/apidocs/resource-controller/resource-manager?code=java) | com.ibm.cloud:resource-manager:0.63.0
[Usage Metering](https://cloud.ibm.com/apidocs/usage-metering?code=java) | com.ibm.cloud:usage-metering:0.63.0
[Usage Reports](https://cloud.ibm.com/apidocs/metering-reporting?code=java) | com.ibm.cloud:usage-reports:0.63.0
[User Management](https://cloud.ibm.com/apidocs/user-management?code=java) | com.ibm.cloud:user-management:0.63.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](https://cloud.ibm.com/apidocs/security-compliance/config?code=java) | com.ibm.cloud:configuration-governance:0.63.0
[Posture Management](https://cloud.ibm.com/apidocs/security-compliance/posture?code=java) | com.ibm.cloud:posture_management:0.63.0

## Prerequisites

[ibm-cloud-onboarding]: https://cloud.ibm.com/registration

* An [IBM Cloud][ibm-cloud-onboarding] account.
* An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).
* Java 8 or above.

## Installation
The current version of this SDK is: 0.63.0

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

The project artifacts are published on the public [Maven Central](https://repo1.maven.org/maven2/)
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](https://docs.gradle.org/current/userguide/declaring_repositories.html).

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

```xml

com.ibm.cloud
case-management
0.63.0

```

### Gradle
```gradle
compile 'com.ibm.cloud:case-management:0.63.0'
```

## Using the SDK
For general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/README.md)

## 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](http://stackoverflow.com/questions/ask?tags=ibm-cloud).

## Issues
If you encounter an issue with the project, you are welcome to submit a
[bug report](https://github.com/IBM/platform-services-java-sdk/issues).
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](http://ibm.github.io/)

## Contributing
See [CONTRIBUTING](CONTRIBUTING.md).

## 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](LICENSE).