Categorygithub.com/IBM/platform-services-go-sdk

# README

Build Status Release Go Reference GitHub go.mod Go version License semantic-release CLA assistant

IBM Cloud Platform Services Go SDK Version 0.79.0

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

Table of Contents

Overview

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

Service NamePackage name
Activity Trackeratrackerv2
Case Managementcasemanagementv1
Catalog Managementcatalogmanagementv1
Context Based Restrictionscontextbasedrestrictionsv1
Enterprise Billing Unitsenterprisebillingunitsv1
Enterprise Managemententerprisemanagementv1
Enterprise Usage Reportsenterpriseusagereportsv1
Global Catalogglobalcatalogv1
Global Searchglobalsearchv2
Global Taggingglobaltaggingv1
IAM Access Groupsiamaccessgroupsv2
IAM Identity Serviceiamidentityv1
IAM Policy Managementiampolicymanagementv1
IBM Cloud Shellibmcloudshellv1
Metrics Routermetricsrouterv3
Open Service Brokeropenservicebrokerv1
Partner Center Sellpartnercentersellv1
Partner Management APIspartnermanagementv1
Resource Controllerresourcecontrollerv2
Resource Managerresourcemanagerv2
Usage Meteringusagemeteringv4
Usage Reportsusagereportsv4
User Managementusermanagementv1

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

Service NamePackage name
Configuration Governanceconfigurationgovernancev1
Posture Managementposturemanagementv1

Prerequisites

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

Installation

The current version of this SDK: 0.79.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.

# Packages

Package atrackerv2 : Operations and models for the AtrackerV2 service.
Package casemanagementv1 : Operations and models for the CaseManagementV1 service.
Package catalogmanagementv1 : Operations and models for the CatalogManagementV1 service.
No description provided by the author
Package contextbasedrestrictionsv1 : Operations and models for the ContextBasedRestrictionsV1 service.
Package enterprisebillingunitsv1 : Operations and models for the EnterpriseBillingUnitsV1 service.
Package enterprisemanagementv1 : Operations and models for the EnterpriseManagementV1 service.
Package enterpriseusagereportsv1 : Operations and models for the EnterpriseUsageReportsV1 service.
Package globalcatalogv1 : Operations and models for the GlobalCatalogV1 service.
Package globalsearchv2 : Operations and models for the GlobalSearchV2 service.
Package globaltaggingv1 : Operations and models for the GlobalTaggingV1 service.
Package iamaccessgroupsv2 : Operations and models for the IamAccessGroupsV2 service.
Package iamidentityv1 : Operations and models for the IamIdentityV1 service.
Package iampolicymanagementv1 : Operations and models for the IamPolicyManagementV1 service.
Package ibmcloudshellv1 : Operations and models for the IBMCloudShellV1 service.
Package metricsrouterv3 : Operations and models for the MetricsRouterV3 service.
Package openservicebrokerv1 : Operations and models for the OpenServiceBrokerV1 service.
Package partnercentersellv1 : Operations and models for the PartnerCenterSellV1 service.
Package partnermanagementv1 : Operations and models for the PartnerManagementV1 service.
Package resourcecontrollerv2 : Operations and models for the ResourceControllerV2 service.
Package resourcemanagerv2 : Operations and models for the ResourceManagerV2 service.
Package usagemeteringv4 : Operations and models for the UsageMeteringV4 service.
Package usagereportsv4 : Operations and models for the UsageReportsV4 service.
Package usermanagementv1 : Operations and models for the UserManagementV1 service.