README
¶
IBM Cloud Platform Services Go SDK Version 0.25.0
Go client library to interact with various IBM Cloud Platform Service APIs.
Table of Contents
- Overview
- Prerequisites
- Installation
- 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 | atrackerv2 |
| Activity Tracker v1 [deprecated] | atrackerv1 |
| Case Management | casemanagementv1 |
| Catalog Management | catalogmanagementv1 |
| Configuration Governance | configurationgovernancev1 |
| Context Based Restrictions | contextbasedrestrictionsv1 |
| 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 Management | iampolicymanagementv1 |
| IBM Cloud Shell | ibmcloudshellv1 |
| Open Service Broker | openservicebrokerv1 |
| Posture Management | posturemanagementv1 |
| 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.16 or above.
Installation
The current version of this SDK: 0.25.0
Go modules
If your application uses Go modules for dependency management (recommended), just add an import for each service
that you will use in your application.
Here is an example:
import (
"github.com/IBM/platform-services-go-sdk/globalsearchv2"
)
Next, run go build or go mod tidy to download and install the new dependencies and update your application's
go.mod file.
In the example above, the globalsearchv2 part of the import path is the package name
associated with the Global Search service.
See the service table above to find the approprate package name for the services used by your application.
go get command
Alternatively, you can use the go get command to download and install the appropriate packages needed by your application:
go get -u github.com/IBM/platform-services-go-sdk/globalsearchv2
Be sure to use the appropriate package name from the service table above for the services used by your application.
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package atrackerv1 : Operations and models for the AtrackerV1 service
|
Package atrackerv1 : Operations and models for the AtrackerV1 service |
|
Package atrackerv2 : Operations and models for the AtrackerV2 service
|
Package atrackerv2 : Operations and models for the AtrackerV2 service |
|
Package casemanagementv1 : Operations and models for the CaseManagementV1 service
|
Package casemanagementv1 : Operations and models for the CaseManagementV1 service |
|
Package catalogmanagementv1 : Operations and models for the CatalogManagementV1 service
|
Package catalogmanagementv1 : Operations and models for the CatalogManagementV1 service |
|
Package configurationgovernancev1 : Operations and models for the ConfigurationGovernanceV1 service
|
Package configurationgovernancev1 : Operations and models for the ConfigurationGovernanceV1 service |
|
Package contextbasedrestrictionsv1 : Operations and models for the ContextBasedRestrictionsV1 service
|
Package contextbasedrestrictionsv1 : Operations and models for the ContextBasedRestrictionsV1 service |
|
Package enterprisebillingunitsv1 : Operations and models for the EnterpriseBillingUnitsV1 service
|
Package enterprisebillingunitsv1 : Operations and models for the EnterpriseBillingUnitsV1 service |
|
Package enterprisemanagementv1 : Operations and models for the EnterpriseManagementV1 service
|
Package enterprisemanagementv1 : Operations and models for the EnterpriseManagementV1 service |
|
Package enterpriseusagereportsv1 : Operations and models for the EnterpriseUsageReportsV1 service
|
Package enterpriseusagereportsv1 : Operations and models for the EnterpriseUsageReportsV1 service |
|
Package globalcatalogv1 : Operations and models for the GlobalCatalogV1 service
|
Package globalcatalogv1 : Operations and models for the GlobalCatalogV1 service |
|
Package globalsearchv2 : Operations and models for the GlobalSearchV2 service
|
Package globalsearchv2 : Operations and models for the GlobalSearchV2 service |
|
Package globaltaggingv1 : Operations and models for the GlobalTaggingV1 service
|
Package globaltaggingv1 : Operations and models for the GlobalTaggingV1 service |
|
Package iamaccessgroupsv2 : Operations and models for the IamAccessGroupsV2 service
|
Package iamaccessgroupsv2 : Operations and models for the IamAccessGroupsV2 service |
|
Package iamidentityv1 : Operations and models for the IamIdentityV1 service
|
Package iamidentityv1 : Operations and models for the IamIdentityV1 service |
|
Package iampolicymanagementv1 : Operations and models for the IamPolicyManagementV1 service
|
Package iampolicymanagementv1 : Operations and models for the IamPolicyManagementV1 service |
|
Package ibmcloudshellv1 : Operations and models for the IBMCloudShellV1 service
|
Package ibmcloudshellv1 : Operations and models for the IBMCloudShellV1 service |
|
Package openservicebrokerv1 : Operations and models for the OpenServiceBrokerV1 service
|
Package openservicebrokerv1 : Operations and models for the OpenServiceBrokerV1 service |
|
Package posturemanagementv1 : Operations and models for the PostureManagementV1 service
|
Package posturemanagementv1 : Operations and models for the PostureManagementV1 service |
|
Package projectsv1 : Operations and models for the ProjectsV1 service
|
Package projectsv1 : Operations and models for the ProjectsV1 service |
|
Package resourcecontrollerv2 : Operations and models for the ResourceControllerV2 service
|
Package resourcecontrollerv2 : Operations and models for the ResourceControllerV2 service |
|
Package resourcemanagerv2 : Operations and models for the ResourceManagerV2 service
|
Package resourcemanagerv2 : Operations and models for the ResourceManagerV2 service |
|
Package usagemeteringv4 : Operations and models for the UsageMeteringV4 service
|
Package usagemeteringv4 : Operations and models for the UsageMeteringV4 service |
|
Package usagereportsv4 : Operations and models for the UsageReportsV4 service
|
Package usagereportsv4 : Operations and models for the UsageReportsV4 service |
|
Package usermanagementv1 : Operations and models for the UserManagementV1 service
|
Package usermanagementv1 : Operations and models for the UserManagementV1 service |