platform-services-go-sdk

README

IBM Cloud Platform Services Go SDK Version 0.17.6

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

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
• Prerequisites
• Installation
  • go get command
  • Go modules
  • dep dependency manager
• Using the SDK
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

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

Service Name	Package name
Activity Tracker	atrackerv1
Case Management	casemanagementv1
Catalog Management	catalogmanagementv1
Configuration Governance	configurationgovernancev1
Enterprise Billing Units	enterprisebillingunitsv1
Enterprise Management	enterprisemanagementv1
Enterprise Usage Reports	enterpriseusagereportsv1
Global Catalog	globalcatalogv1
Global Search	globalsearchv2
Global Tagging	globaltaggingv1
IAM Access Groups	iamaccessgroupsv2
IAM Identity Service	iamidentityv1
IAM Policy Managemenet	iampolicymanagementv1
Open Service Broker	openservicebrokerv1
Resource Controller	resourcecontrollerv2
Resource Manager	resourcemanagerv2
Usage Metering	usagemeteringv4
Usage Reports	usagereportsv4
User Management	usermanagementv1

Prerequisites

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

Installation

The current version of this SDK: 0.17.6

There are a few different ways to download and install the Platform Services Go SDK project for use by your Go application:

go get command

Use this command to download and install the Platform Services Go SDK project to allow your Go application to use it:

go get -u github.com/IBM/platform-services-go-sdk

Go modules

If your application is using Go modules, you can add a suitable import to your Go application, like this:

import (
	"github.com/IBM/platform-services-go-sdk/globalsearchv2"
)

then run go mod tidy to download and install the new dependency and update your Go application's go.mod file.

dep dependency manager

If your application is using the dep dependency management tool, you can add a dependency to your Gopkg.toml file. Here is an example:

[[constraint]]
  name = "github.com/IBM/platform-services-go-sdk/globalsearchv2"
  version = "0.17.6"

then run dep ensure.

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