tbclient

package
v0.4.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 10, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Package tbclient provides client functions to interact with CB-Tumblebug API

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiConfig 

type ApiConfig struct {
	RestUrl  string
	Username string
	Password string
}

ApiConfig holds the configuration for Tumblebug API

type Bucket added in v0.4.2 

type Bucket struct {
	Name         string `xml:"Name" json:"name" example:"spider-test-bucket"`
	CreationDate string `xml:"CreationDate" json:"creationDate" example:"2025-09-04T04:18:06Z"`
}

Bucket represents a single bucket in S3 bucket list response

type Buckets added in v0.4.2 

type Buckets struct {
	Bucket []Bucket `xml:"Bucket" json:"bucket"`
}

Buckets represents the collection of buckets in S3 bucket list response

type ListAllMyBucketsResult added in v0.4.2 

type ListAllMyBucketsResult struct {
	Owner   Owner   `xml:"Owner" json:"owner"`
	Buckets Buckets `xml:"Buckets" json:"buckets"`
}

ListAllMyBucketsResult represents the response structure for S3 ListAllMyBuckets operation

type ListBucketResult added in v0.4.2 

type ListBucketResult struct {
	Name        string `xml:"Name" json:"name" example:"spider-test-bucket"`
	Prefix      string `xml:"Prefix" json:"prefix" example:""`
	Marker      string `xml:"Marker" json:"marker" example:""`
	MaxKeys     int    `xml:"MaxKeys" json:"maxKeys" example:"1000"`
	IsTruncated bool   `xml:"IsTruncated" json:"isTruncated" example:"false"`
}

ListBucketResult represents the response structure for S3 ListBucket operation

type LocationConstraint added in v0.4.2 

type LocationConstraint struct {
	Location string `xml:",chardata" json:"location" example:"ap-northeast-2"`
}

LocationConstraint represents the location constraint of a bucket

type Owner added in v0.4.2 

type Owner struct {
	ID          string `xml:"ID" json:"id" example:"aws-ap-northeast-2"`
	DisplayName string `xml:"DisplayName" json:"displayName" example:"aws-ap-northeast-2"`
}

Owner represents the owner information in S3 bucket list response

type TbMciInfoList 

type TbMciInfoList struct {
	Mci []tbmodel.MciInfo `json:"mci"`
}

type TumblebugClient 

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

TumblebugClient is the structure for Tumblebug client

func NewClient 

func NewClient(apiConfig ApiConfig) *TumblebugClient

NewClient creates a new Tumblebug client

func NewDefaultClient 

func NewDefaultClient() *TumblebugClient

NewDefaultClient creates a new Tumblebug client using global config

func (*TumblebugClient) CreateMci 

func (c *TumblebugClient) CreateMci(nsId string, reqBody tbmodel.MciReq) (tbmodel.MciInfo, error)

CreateMci creates a new MCI (Multi-Cloud Image) in the specified namespace

func (*TumblebugClient) CreateMciDynamic 

func (c *TumblebugClient) CreateMciDynamic(nsId string, reqBody tbmodel.MciDynamicReq) (tbmodel.MciInfo, error)

CreateMciDynamic creates a new MCI (Multi-Cloud Image) with defaults in the specified namespace

func (*TumblebugClient) CreateNamespace 

func (c *TumblebugClient) CreateNamespace(nsReq tbmodel.NsReq) (tbmodel.NsInfo, error)

CreateNamespace creates a new namespace in Tumblebug

func (*TumblebugClient) CreateObjectStorage added in v0.4.2 

func (c *TumblebugClient) CreateObjectStorage(objectStorageName, connName string) error

CreateObjectStorage creates a new object storage (bucket)

func (*TumblebugClient) CreateSecurityGroup 

func (c *TumblebugClient) CreateSecurityGroup(nsId string, reqBody tbmodel.SecurityGroupReq, option string) (tbmodel.SecurityGroupInfo, error)

CreateSecurityGroup creates a new Security Group in the specified namespace

func (*TumblebugClient) CreateSshKey 

func (c *TumblebugClient) CreateSshKey(nsId string, reqBody tbmodel.SshKeyReq) (tbmodel.SshKeyInfo, error)

CreateSshKey creates a new SSH Key in the specified namespace

func (*TumblebugClient) CreateVNet 

func (c *TumblebugClient) CreateVNet(nsId string, reqBody tbmodel.VNetReq) (tbmodel.VNetInfo, error)

CreateVNet creates a new Virtual Network (VNet) in the specified namespace

func (*TumblebugClient) DeleteMci 

func (c *TumblebugClient) DeleteMci(nsId, mciId, option string) (tbmodel.IdList, error)

DeleteMci deletes a specific MCI (Multi-Cloud Image) in the specified namespace

func (*TumblebugClient) DeleteObjectStorage added in v0.4.2 

func (c *TumblebugClient) DeleteObjectStorage(objectStorageName, connName string) error

DeleteObjectStorage deletes an object storage (bucket)

func (*TumblebugClient) DeleteSecurityGroup 

func (c *TumblebugClient) DeleteSecurityGroup(nsId, securityGroupId string) (tbmodel.SimpleMsg, error)

DeleteSecurityGroup deletes a specific Security Group in the specified namespace

func (*TumblebugClient) DeleteSharedResources 

func (c *TumblebugClient) DeleteSharedResources(nsId string) (tbmodel.IdList, error)

func (*TumblebugClient) DeleteSshKey 

func (c *TumblebugClient) DeleteSshKey(nsId, sshKeyId string) (tbmodel.SimpleMsg, error)

func (*TumblebugClient) DeleteVNet 

func (c *TumblebugClient) DeleteVNet(nsId, vNetId, action string) (tbmodel.SimpleMsg, error)

func (*TumblebugClient) ExistObjectStorage added in v0.4.2 

func (c *TumblebugClient) ExistObjectStorage(objectStorageName, connName string) (bool, error)

ExistObjectStorage checks the existence of an object storage (bucket)

func (*TumblebugClient) GetConnConfig added in v0.4.2 

func (c *TumblebugClient) GetConnConfig(connectionConfigName string) (tbmodel.ConnConfig, error)

func (*TumblebugClient) GetObjectStorage added in v0.4.2 

func (c *TumblebugClient) GetObjectStorage(objectStorageName, connName string) (ListBucketResult, error)

GetObjectStorage retrieves details of an object storage (bucket)

func (*TumblebugClient) GetObjectStorageLocation added in v0.4.2 

func (c *TumblebugClient) GetObjectStorageLocation(objectStorageName, connName string) (LocationConstraint, error)

GetObjectStorageLocation retrieves the location of an object storage (bucket)

func (*TumblebugClient) IsReady 

func (c *TumblebugClient) IsReady() (bool, error)

IsReady checks if Tumblebug is ready

func (*TumblebugClient) ListObjectStorages added in v0.4.2 

func (c *TumblebugClient) ListObjectStorages(connName string) (ListAllMyBucketsResult, error)

ListObjectStorages retrieves the list of all object storages (buckets)

func (*TumblebugClient) MciRecommendSpec added in v0.3.8 

func (c *TumblebugClient) MciRecommendSpec(planToSearchProperVm string) ([]tbmodel.SpecInfo, error)

MciRecommendSpec finds appropriate VM specs by filtering and prioritzing.

func (*TumblebugClient) ReadAllMci 

func (c *TumblebugClient) ReadAllMci(nsId string) (TbMciInfoList, error)

ReadAllMci retrieves all MCIs (Multi-Cloud Images) in the specified namespace

func (*TumblebugClient) ReadMci 

func (c *TumblebugClient) ReadMci(nsId, mciId string) (tbmodel.MciInfo, error)

ReadMci retrieves information about a specific MCI (Multi-Cloud Image) in the specified namespace

func (*TumblebugClient) ReadMciAccessInfo added in v0.3.10 

func (c *TumblebugClient) ReadMciAccessInfo(nsId, mciId, option, accessInfoOption string) (tbmodel.MciAccessInfo, error)

func (*TumblebugClient) ReadMciIDs 

func (c *TumblebugClient) ReadMciIDs(nsId string) (tbmodel.IdList, error)

func (*TumblebugClient) ReadNamespace 

func (c *TumblebugClient) ReadNamespace(nsId string) (tbmodel.NsInfo, error)

ReadNamespace retrieves information about a specific namespace

func (*TumblebugClient) ReadRegionInfo 

func (c *TumblebugClient) ReadRegionInfo(providerName string, regionName string) (tbmodel.RegionDetail, error)

ReadRegionInfo reads region information in a specific provider

func (*TumblebugClient) ReadSecurityGroup 

func (c *TumblebugClient) ReadSecurityGroup(nsId, securityGroupId string) (tbmodel.SecurityGroupInfo, error)

ReadSecurityGroup retrieves information about a specific Security Group in the specified namespace

func (*TumblebugClient) ReadSshKey 

func (c *TumblebugClient) ReadSshKey(nsId, sshKeyId string) (tbmodel.SshKeyInfo, error)

ReadSshKey retrieves information about a specific SSH Key in the specified namespace

func (*TumblebugClient) ReadVNet 

func (c *TumblebugClient) ReadVNet(nsId, vNetId string) (tbmodel.VNetInfo, error)

ReadVNet retrieves information about a specific Virtual Network (VNet) in the specified namespace

func (*TumblebugClient) ReadVmOsImage 

func (c *TumblebugClient) ReadVmOsImage(nsId, vmOsImageId string) (tbmodel.ImageInfo, error)

ReadVmOsImage retrieves information about a specific VM OS Image in the specified namespace

func (*TumblebugClient) ReadVmSpec 

func (c *TumblebugClient) ReadVmSpec(nsId, vmSpecId string) (tbmodel.SpecInfo, error)

ReadVmSpec retrieves information about a specific VM Spec in the specified namespace

func (*TumblebugClient) SearchVmOsImage 

func (c *TumblebugClient) SearchVmOsImage(nsId string, searchImageReq tbmodel.SearchImageRequest) (tbmodel.SearchImageResponse, error)

SearchVmOsImage searches VM OS images

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.