Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateFullSnapshot(ctx context.Context, request *hookdeckgosdk.CreateFullSnapshotRequest) (*hookdeckgosdk.CreateFullSnapshotResponse, error)
- func (c *Client) CreateShardSnapshot(ctx context.Context, collectionName string, shardId int, ...) (*hookdeckgosdk.CreateShardSnapshotResponse, error)
- func (c *Client) CreateSnapshot(ctx context.Context, collectionName string, ...) (*hookdeckgosdk.CreateSnapshotResponse, error)
- func (c *Client) DeleteFullSnapshot(ctx context.Context, snapshotName string, ...) (*hookdeckgosdk.DeleteFullSnapshotResponse, error)
- func (c *Client) DeleteShardSnapshot(ctx context.Context, collectionName string, shardId int, snapshotName string, ...) (*hookdeckgosdk.DeleteShardSnapshotResponse, error)
- func (c *Client) DeleteSnapshot(ctx context.Context, collectionName string, snapshotName string, ...) (*hookdeckgosdk.DeleteSnapshotResponse, error)
- func (c *Client) GetFullSnapshot(ctx context.Context, snapshotName string) (io.Reader, error)
- func (c *Client) GetShardSnapshot(ctx context.Context, collectionName string, shardId int, snapshotName string) (io.Reader, error)
- func (c *Client) GetSnapshot(ctx context.Context, collectionName string, snapshotName string) (io.Reader, error)
- func (c *Client) ListFullSnapshots(ctx context.Context) (*hookdeckgosdk.ListFullSnapshotsResponse, error)
- func (c *Client) ListShardSnapshots(ctx context.Context, collectionName string, shardId int) (*hookdeckgosdk.ListShardSnapshotsResponse, error)
- func (c *Client) ListSnapshots(ctx context.Context, collectionName string) (*hookdeckgosdk.ListSnapshotsResponse, error)
- func (c *Client) RecoverFromSnapshot(ctx context.Context, collectionName string, ...) (*hookdeckgosdk.RecoverFromSnapshotResponse, error)
- func (c *Client) RecoverFromUploadedSnapshot(ctx context.Context, collectionName string, snapshot io.Reader, ...) (*hookdeckgosdk.RecoverFromUploadedSnapshotResponse, error)
- func (c *Client) RecoverShardFromSnapshot(ctx context.Context, collectionName string, shardId int, ...) (*hookdeckgosdk.RecoverShardFromSnapshotResponse, error)
- func (c *Client) RecoverShardFromUploadedSnapshot(ctx context.Context, collectionName string, shardId int, snapshot io.Reader, ...) (*hookdeckgosdk.RecoverShardFromUploadedSnapshotResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(opts ...core.ClientOption) *Client
func (*Client) CreateFullSnapshot ¶
func (c *Client) CreateFullSnapshot(ctx context.Context, request *hookdeckgosdk.CreateFullSnapshotRequest) (*hookdeckgosdk.CreateFullSnapshotResponse, error)
Create new snapshot of the whole storage
func (*Client) CreateShardSnapshot ¶
func (c *Client) CreateShardSnapshot(ctx context.Context, collectionName string, shardId int, request *hookdeckgosdk.CreateShardSnapshotRequest) (*hookdeckgosdk.CreateShardSnapshotResponse, error)
Create new snapshot of a shard for a collection
Name of the collection for which to create a snapshot Id of the shard
func (*Client) CreateSnapshot ¶
func (c *Client) CreateSnapshot(ctx context.Context, collectionName string, request *hookdeckgosdk.CreateSnapshotRequest) (*hookdeckgosdk.CreateSnapshotResponse, error)
Create new snapshot for a collection
Name of the collection for which to create a snapshot
func (*Client) DeleteFullSnapshot ¶
func (c *Client) DeleteFullSnapshot(ctx context.Context, snapshotName string, request *hookdeckgosdk.DeleteFullSnapshotRequest) (*hookdeckgosdk.DeleteFullSnapshotResponse, error)
Delete snapshot of the whole storage
Name of the full snapshot to delete
func (*Client) DeleteShardSnapshot ¶
func (c *Client) DeleteShardSnapshot(ctx context.Context, collectionName string, shardId int, snapshotName string, request *hookdeckgosdk.DeleteShardSnapshotRequest) (*hookdeckgosdk.DeleteShardSnapshotResponse, error)
Delete snapshot of a shard for a collection
Name of the collection for which to delete a snapshot Id of the shard Name of the snapshot to delete
func (*Client) DeleteSnapshot ¶
func (c *Client) DeleteSnapshot(ctx context.Context, collectionName string, snapshotName string, request *hookdeckgosdk.DeleteSnapshotRequest) (*hookdeckgosdk.DeleteSnapshotResponse, error)
Delete snapshot for a collection
Name of the collection for which to delete a snapshot Name of the snapshot to delete
func (*Client) GetFullSnapshot ¶
Download specified snapshot of the whole storage as a file
Name of the snapshot to download
func (*Client) GetShardSnapshot ¶
func (c *Client) GetShardSnapshot(ctx context.Context, collectionName string, shardId int, snapshotName string) (io.Reader, error)
Download specified snapshot of a shard from a collection as a file
Name of the collection Id of the shard Name of the snapshot to download
func (*Client) GetSnapshot ¶
func (c *Client) GetSnapshot(ctx context.Context, collectionName string, snapshotName string) (io.Reader, error)
Download specified snapshot from a collection as a file
Name of the collection Name of the snapshot to download
func (*Client) ListFullSnapshots ¶
func (c *Client) ListFullSnapshots(ctx context.Context) (*hookdeckgosdk.ListFullSnapshotsResponse, error)
Get list of snapshots of the whole storage
func (*Client) ListShardSnapshots ¶
func (c *Client) ListShardSnapshots(ctx context.Context, collectionName string, shardId int) (*hookdeckgosdk.ListShardSnapshotsResponse, error)
Get list of snapshots for a shard of a collection
Name of the collection Id of the shard
func (*Client) ListSnapshots ¶
func (c *Client) ListSnapshots(ctx context.Context, collectionName string) (*hookdeckgosdk.ListSnapshotsResponse, error)
Get list of snapshots for a collection
Name of the collection
func (*Client) RecoverFromSnapshot ¶
func (c *Client) RecoverFromSnapshot(ctx context.Context, collectionName string, request *hookdeckgosdk.SnapshotRecover) (*hookdeckgosdk.RecoverFromSnapshotResponse, error)
Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
Name of the collection
func (*Client) RecoverFromUploadedSnapshot ¶
func (c *Client) RecoverFromUploadedSnapshot(ctx context.Context, collectionName string, snapshot io.Reader, request *hookdeckgosdk.RecoverFromUploadedSnapshotRequest) (*hookdeckgosdk.RecoverFromUploadedSnapshotResponse, error)
Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
Name of the collection
func (*Client) RecoverShardFromSnapshot ¶
func (c *Client) RecoverShardFromSnapshot(ctx context.Context, collectionName string, shardId int, request *hookdeckgosdk.ShardSnapshotRecover) (*hookdeckgosdk.RecoverShardFromSnapshotResponse, error)
Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection.
Name of the collection Id of the shard to recover
func (*Client) RecoverShardFromUploadedSnapshot ¶
func (c *Client) RecoverShardFromUploadedSnapshot(ctx context.Context, collectionName string, shardId int, snapshot io.Reader, request *hookdeckgosdk.RecoverShardFromUploadedSnapshotRequest) (*hookdeckgosdk.RecoverShardFromUploadedSnapshotResponse, error)
Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard.
Name of the collection Id of the shard to recover