Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v1

v1.1.0-beta.4

Sep 19, 2024

v1.1.0-beta.3

Sep 16, 2024

v1.1.0-beta.2

Aug 28, 2024

v1.1.0-beta.1

Aug 26, 2024

v1.0.8

Jul 3, 2024

v1.0.8-beta.2

Jul 3, 2024

v1.0.8-beta.1

Jun 28, 2024

v1.0.7

Apr 24, 2024

Changes in this version

type Client

+ func (c *Client) UpdateHostCheck(ctx context.Context, autopilotID string, hostKey types.PublicKey, ...) (err error)

v1.0.7-beta.3

Apr 24, 2024

v1.0.7-beta.2

Apr 23, 2024

v1.0.7-beta.1

Apr 22, 2024

v1.0.6

Mar 12, 2024

v1.0.6-beta.1

Mar 12, 2024

v1.0.5

Feb 14, 2024

v1.0.4

Feb 12, 2024

v1.0.3

Feb 6, 2024

v1.0.2

Jan 19, 2024

v1.0.1

Jan 10, 2024

v1.0.0

Dec 21, 2023

v0

v0.7.2

Dec 21, 2023

v0.7.1

Dec 15, 2023

v0.7.0

Dec 13, 2023

Changes in this version

+ type Client struct

+ func New(addr, password string) *Client

+ func (c *Client) AbortMultipartUpload(ctx context.Context, bucket, path string, uploadID string) (err error)

+ func (c *Client) AcceptBlock(ctx context.Context, b types.Block) (err error)

+ func (c *Client) Account(ctx context.Context, id rhpv3.Account, hostKey types.PublicKey) (account api.Account, err error)

+ func (c *Client) Accounts(ctx context.Context) (accounts []api.Account, err error)

+ func (c *Client) AcquireContract(ctx context.Context, contractID types.FileContractID, priority int, ...) (lockID uint64, err error)

+ func (c *Client) AddBalance(ctx context.Context, id rhpv3.Account, hostKey types.PublicKey, ...) (err error)

+ func (c *Client) AddContract(ctx context.Context, contract rhpv2.ContractRevision, ...) (added api.ContractMetadata, err error)

+ func (c *Client) AddMultipartPart(ctx context.Context, bucket, path, contractSet, eTag, uploadID string, ...) (err error)

+ func (c *Client) AddObject(ctx context.Context, bucket, path, contractSet string, o object.Object, ...) (err error)

+ func (c *Client) AddPartialSlab(ctx context.Context, data []byte, minShards, totalShards uint8, ...) (slabs []object.SlabSlice, slabBufferMaxSizeSoftReached bool, err error)

+ func (c *Client) AddRenewedContract(ctx context.Context, contract rhpv2.ContractRevision, ...) (renewed api.ContractMetadata, err error)

+ func (c *Client) AddUploadingSector(ctx context.Context, uID api.UploadID, id types.FileContractID, ...) (err error)

+ func (c *Client) Alerts() (alerts []alerts.Alert, err error)

+ func (c *Client) AncestorContracts(ctx context.Context, contractID types.FileContractID, minStartHeight uint64) (contracts []api.ArchivedContract, err error)

+ func (c *Client) ArchiveContracts(ctx context.Context, toArchive map[types.FileContractID]string) (err error)

+ func (c *Client) Autopilot(ctx context.Context, id string) (autopilot api.Autopilot, err error)

+ func (c *Client) Autopilots(ctx context.Context) (autopilots []api.Autopilot, err error)

+ func (c *Client) BroadcastAction(ctx context.Context, action webhooks.Event) error

+ func (c *Client) BroadcastTransaction(ctx context.Context, txns []types.Transaction) error

+ func (c *Client) Bucket(ctx context.Context, bucketName string) (resp api.Bucket, err error)

+ func (c *Client) CompleteMultipartUpload(ctx context.Context, bucket, path, uploadID string, ...) (resp api.MultipartCompleteResponse, err error)

+ func (c *Client) ConsensusNetwork(ctx context.Context) (resp api.ConsensusNetwork, err error)

+ func (c *Client) ConsensusState(ctx context.Context) (resp api.ConsensusState, err error)

+ func (c *Client) Contract(ctx context.Context, id types.FileContractID) (contract api.ContractMetadata, err error)

+ func (c *Client) ContractMetrics(ctx context.Context, start time.Time, n uint64, interval time.Duration, ...) ([]api.ContractMetric, error)

+ func (c *Client) ContractPruneMetrics(ctx context.Context, start time.Time, n uint64, interval time.Duration, ...) ([]api.ContractPruneMetric, error)

+ func (c *Client) ContractRoots(ctx context.Context, contractID types.FileContractID) (roots, uploading []types.Hash256, err error)

+ func (c *Client) ContractSetChurnMetrics(ctx context.Context, start time.Time, n uint64, interval time.Duration, ...) ([]api.ContractSetChurnMetric, error)

+ func (c *Client) ContractSetContracts(ctx context.Context, set string) (contracts []api.ContractMetadata, err error)

+ func (c *Client) ContractSetMetrics(ctx context.Context, start time.Time, n uint64, interval time.Duration, ...) ([]api.ContractSetMetric, error)

+ func (c *Client) ContractSetSettings(ctx context.Context) (gs api.ContractSetSetting, err error)

+ func (c *Client) ContractSets(ctx context.Context) (sets []string, err error)

+ func (c *Client) ContractSize(ctx context.Context, contractID types.FileContractID) (size api.ContractSize, err error)

+ func (c *Client) Contracts(ctx context.Context) (contracts []api.ContractMetadata, err error)

+ func (c *Client) CopyObject(ctx context.Context, srcBucket, dstBucket, srcPath, dstPath string, ...) (om api.ObjectMetadata, err error)

+ func (c *Client) CreateBucket(ctx context.Context, bucketName string, opts api.CreateBucketOptions) error

+ func (c *Client) CreateMultipartUpload(ctx context.Context, bucket, path string, opts api.CreateMultipartOptions) (resp api.MultipartCreateResponse, err error)

+ func (c *Client) DeleteAllContracts(ctx context.Context) (err error)

+ func (c *Client) DeleteBucket(ctx context.Context, bucketName string) error

+ func (c *Client) DeleteContract(ctx context.Context, id types.FileContractID) (err error)

+ func (c *Client) DeleteContractSet(ctx context.Context, set string) (err error)

+ func (c *Client) DeleteContracts(ctx context.Context, ids []types.FileContractID) error

+ func (c *Client) DeleteHostSector(ctx context.Context, hostKey types.PublicKey, sectorRoot types.Hash256) error

+ func (c *Client) DeleteObject(ctx context.Context, bucket, path string, opts api.DeleteObjectOptions) (err error)

+ func (c *Client) DeleteSetting(ctx context.Context, key string) error

+ func (c *Client) DeleteWebhook(ctx context.Context, url, module, event string) error

+ func (c *Client) DismissAlerts(ctx context.Context, ids ...types.Hash256) error

+ func (c *Client) FetchPartialSlab(ctx context.Context, key object.EncryptionKey, offset, length uint32) ([]byte, error)

+ func (c *Client) FileContractTax(ctx context.Context, payout types.Currency) (tax types.Currency, err error)

+ func (c *Client) FinishUpload(ctx context.Context, uID api.UploadID) (err error)

+ func (c *Client) GougingParams(ctx context.Context) (gp api.GougingParams, err error)

+ func (c *Client) GougingSettings(ctx context.Context) (gs api.GougingSettings, err error)

+ func (c *Client) Host(ctx context.Context, hostKey types.PublicKey) (h hostdb.HostInfo, err error)

+ func (c *Client) HostAllowlist(ctx context.Context) (allowlist []types.PublicKey, err error)

+ func (c *Client) HostBlocklist(ctx context.Context) (blocklist []string, err error)

+ func (c *Client) Hosts(ctx context.Context, opts api.GetHostsOptions) (hosts []hostdb.Host, err error)

+ func (c *Client) HostsForScanning(ctx context.Context, opts api.HostsForScanningOptions) (hosts []hostdb.HostAddress, err error)

+ func (c *Client) KeepaliveContract(ctx context.Context, contractID types.FileContractID, lockID uint64, ...) (err error)

+ func (c *Client) ListBuckets(ctx context.Context) (buckets []api.Bucket, err error)

+ func (c *Client) ListObjects(ctx context.Context, bucket string, opts api.ListObjectOptions) (resp api.ObjectsListResponse, err error)

+ func (c *Client) LockAccount(ctx context.Context, id rhpv3.Account, hostKey types.PublicKey, exclusive bool, ...) (account api.Account, lockID uint64, err error)

+ func (c *Client) MarkPackedSlabsUploaded(ctx context.Context, slabs []api.UploadedPackedSlab) (err error)

+ func (c *Client) MultipartUpload(ctx context.Context, uploadID string) (resp api.MultipartUpload, err error)

+ func (c *Client) MultipartUploadParts(ctx context.Context, bucket, path string, uploadID string, ...) (resp api.MultipartListPartsResponse, err error)

+ func (c *Client) MultipartUploads(ctx context.Context, bucket, prefix, keyMarker, uploadIDMarker string, ...) (resp api.MultipartListUploadsResponse, err error)

+ func (c *Client) Object(ctx context.Context, bucket, path string, opts api.GetObjectOptions) (res api.ObjectsResponse, err error)

+ func (c *Client) ObjectsBySlabKey(ctx context.Context, bucket string, key object.EncryptionKey) (objects []api.ObjectMetadata, err error)

+ func (c *Client) ObjectsStats() (osr api.ObjectsStatsResponse, err error)

+ func (c *Client) PackedSlabsForUpload(ctx context.Context, lockingDuration time.Duration, ...) (slabs []api.PackedSlab, err error)

+ func (c *Client) PrunableData(ctx context.Context) (prunableData api.ContractsPrunableDataResponse, err error)

+ func (c *Client) PruneMetrics(ctx context.Context, metric string, cutoff time.Time) error

+ func (c *Client) RecommendedFee(ctx context.Context) (fee types.Currency, err error)

+ func (c *Client) RecordContractPruneMetric(ctx context.Context, metrics ...api.ContractPruneMetric) error

+ func (c *Client) RecordContractSetChurnMetric(ctx context.Context, metrics ...api.ContractSetChurnMetric) error

+ func (c *Client) RecordContractSpending(ctx context.Context, records []api.ContractSpendingRecord) (err error)

+ func (c *Client) RecordHostScans(ctx context.Context, scans []hostdb.HostScan) (err error)

+ func (c *Client) RecordPriceTables(ctx context.Context, priceTableUpdates []hostdb.PriceTableUpdate) (err error)

+ func (c *Client) RedundancySettings(ctx context.Context) (rs api.RedundancySettings, err error)

+ func (c *Client) RefreshHealth(ctx context.Context) error

+ func (c *Client) RegisterAlert(ctx context.Context, alert alerts.Alert) error

+ func (c *Client) RegisterWebhook(ctx context.Context, url, module, event string) error

+ func (c *Client) ReleaseContract(ctx context.Context, contractID types.FileContractID, lockID uint64) (err error)

+ func (c *Client) RemoveOfflineHosts(ctx context.Context, minRecentScanFailures uint64, maxDowntime time.Duration) (removed uint64, err error)

+ func (c *Client) RenameObject(ctx context.Context, bucket, from, to string, force bool) (err error)

+ func (c *Client) RenameObjects(ctx context.Context, bucket, from, to string, force bool) (err error)

+ func (c *Client) RenewedContract(ctx context.Context, renewedFrom types.FileContractID) (contract api.ContractMetadata, err error)

+ func (c *Client) ResetDrift(ctx context.Context, id rhpv3.Account) (err error)

+ func (c *Client) ResetLostSectors(ctx context.Context, hostKey types.PublicKey) (err error)

+ func (c *Client) S3AuthenticationSettings(ctx context.Context) (as api.S3AuthenticationSettings, err error)

+ func (c *Client) ScheduleSync(ctx context.Context, id rhpv3.Account, hostKey types.PublicKey) (err error)

+ func (c *Client) SearchHosts(ctx context.Context, opts api.SearchHostOptions) (hosts []hostdb.Host, err error)

+ func (c *Client) SearchObjects(ctx context.Context, bucket string, opts api.SearchObjectOptions) (entries []api.ObjectMetadata, err error)

+ func (c *Client) SendSiacoins(ctx context.Context, scos []types.SiacoinOutput, useUnconfirmedTxns bool) (err error)

+ func (c *Client) SetBalance(ctx context.Context, id rhpv3.Account, hostKey types.PublicKey, ...) (err error)

+ func (c *Client) SetContractSet(ctx context.Context, set string, contracts []types.FileContractID) (err error)

+ func (c *Client) Setting(ctx context.Context, key string, value interface{}) (err error)

+ func (c *Client) Settings(ctx context.Context) (settings []string, err error)

+ func (c *Client) Slab(ctx context.Context, key object.EncryptionKey) (slab object.Slab, err error)

+ func (c *Client) SlabBuffers() (buffers []api.SlabBuffer, err error)

+ func (c *Client) SlabsForMigration(ctx context.Context, healthCutoff float64, set string, limit int) (slabs []api.UnhealthySlab, err error)

+ func (c *Client) State() (state api.BusStateResponse, err error)

+ func (c *Client) SyncerAddress(ctx context.Context) (addr string, err error)

+ func (c *Client) SyncerConnect(ctx context.Context, addr string) (err error)

+ func (c *Client) SyncerPeers(ctx context.Context) (resp []string, err error)

+ func (c *Client) TrackUpload(ctx context.Context, uID api.UploadID) (err error)

+ func (c *Client) TransactionPool(ctx context.Context) (txns []types.Transaction, err error)

+ func (c *Client) UnlockAccount(ctx context.Context, id rhpv3.Account, lockID uint64) (err error)

+ func (c *Client) UpdateAutopilot(ctx context.Context, autopilot api.Autopilot) (err error)

+ func (c *Client) UpdateBucketPolicy(ctx context.Context, bucketName string, policy api.BucketPolicy) error

+ func (c *Client) UpdateHostAllowlist(ctx context.Context, add, remove []types.PublicKey, clear bool) (err error)

+ func (c *Client) UpdateHostBlocklist(ctx context.Context, add, remove []string, clear bool) (err error)

+ func (c *Client) UpdateSetting(ctx context.Context, key string, value interface{}) error

+ func (c *Client) UpdateSlab(ctx context.Context, slab object.Slab, contractSet string) (err error)

+ func (c *Client) UploadPackingSettings(ctx context.Context) (ups api.UploadPackingSettings, err error)

+ func (c *Client) UploadParams(ctx context.Context) (up api.UploadParams, err error)

+ func (c *Client) Wallet(ctx context.Context) (resp api.WalletResponse, err error)

+ func (c *Client) WalletDiscard(ctx context.Context, txn types.Transaction) error

+ func (c *Client) WalletFund(ctx context.Context, txn *types.Transaction, amount types.Currency, ...) ([]types.Hash256, []types.Transaction, error)

+ func (c *Client) WalletMetrics(ctx context.Context, start time.Time, n uint64, interval time.Duration, ...) ([]api.WalletMetric, error)

+ func (c *Client) WalletOutputs(ctx context.Context) (resp []wallet.SiacoinElement, err error)

+ func (c *Client) WalletPending(ctx context.Context) (resp []types.Transaction, err error)

+ func (c *Client) WalletPrepareForm(ctx context.Context, renterAddress types.Address, renterKey types.PublicKey, ...) (txns []types.Transaction, err error)

+ func (c *Client) WalletPrepareRenew(ctx context.Context, revision types.FileContractRevision, ...) (api.WalletPrepareRenewResponse, error)

+ func (c *Client) WalletRedistribute(ctx context.Context, outputs int, amount types.Currency) (id types.TransactionID, err error)

+ func (c *Client) WalletSign(ctx context.Context, txn *types.Transaction, toSign []types.Hash256, ...) error

+ func (c *Client) WalletTransactions(ctx context.Context, opts ...api.WalletTransactionsOption) (resp []wallet.Transaction, err error)

+ func (c *Client) Webhooks(ctx context.Context) (resp api.WebHookResponse, err error)