ibmcloud

Documentation

Index

• type API
  • func New(opts *Options) (*API, error)
  • func (a *API) CheckBucketExists(bucketName string) (bool, error)
  • func (a *API) CopyObject(srcBucket, srcName, destBucket string) error
  • func (a *API) CreateBucket(bucketName string) error
  • func (a *API) CreateCloudObjectStorageInstance(storageName string, resourceGroup string) (string, error)
  • func (a *API) ListCloudObjectStorageInstances() (map[string]string, error)
  • func (a *API) NewS3Client(cloudObjectStorageName, region string) (err error)
  • func (a *API) UploadObject(r io.Reader, objectName, bucketName string, force bool) error
• type Client
• type Options
• type S3Client

Types

type API

type API struct {
	// contains filtered or unexported fields
}

func New

func New(opts *Options) (*API, error)

New creates an IBMCloud API wrapper

func (*API) CheckBucketExists

func (a *API) CheckBucketExists(bucketName string) (bool, error)

CheckBucketExists will verify the existence of the bucket for the particular account in the particular cloud object storage instance

func (*API) CopyObject

func (a *API) CopyObject(srcBucket, srcName, destBucket string) error

CopyObject - Copy an Object to a new location

func (*API) CreateBucket

func (a *API) CreateBucket(bucketName string) error

CreateBucket creates a new bucket in the provided cloud object storage instance

func (*API) CreateCloudObjectStorageInstance

func (a *API) CreateCloudObjectStorageInstance(storageName string, resourceGroup string) (string, error)

CreateCloudObjectStorageInstance creates a cloud object storage instance

func (*API) ListCloudObjectStorageInstances

func (a *API) ListCloudObjectStorageInstances() (map[string]string, error)

ListCloudObjectStorageInstances list all available cloud object storage instances of particular servicetype

func (*API) NewS3Client

func (a *API) NewS3Client(cloudObjectStorageName, region string) (err error)

NewS3Client accepts apikey, instanceid of the IBM Cloud Object Storage instance and returns the s3 client

func (*API) UploadObject

func (a *API) UploadObject(r io.Reader, objectName, bucketName string, force bool) error

UploadObject - upload to s3 bucket

type Client

type Client struct {
	*bluemixsession.Session
	ResourceClientV2   controllerv2.ResourceServiceInstanceRepository
	ResourceClientV1   controller.ResourceServiceInstanceRepository
	ResourceServiceKey controller.ResourceServiceKeyRepository
	ResCatalogAPI      catalog.ResourceCatalogRepository
	ResGroupAPI        management.ResourceGroupRepository
}

Client used to interact with the IBMCloud apis

type Options

type Options struct {
	*platform.Options
	// The path to the shared credentials file, if not ~/.bluemix/credentials
	CredentialsFile string

	// ApiKey is the optional access key to use. It will override all other sources
	ApiKey string

	// Cloud Object storage name to use
	CloudObjectStorage string
}

type S3Client

type S3Client struct {
	// contains filtered or unexported fields
}

S3Client - to interface with the IBMCloud s3 storage