bucket

Documentation

Index

• Constants
• Variables
• type BucketsCreateParams
• type BucketsDeleteParams
• type BucketsListParams
• type BucketsUpdateParams
• type Client
  • func (c Client) Create(ctx context.Context, params *BucketsCreateParams) error
  • func (c Client) Delete(ctx context.Context, params *BucketsDeleteParams) error
  • func (c Client) List(ctx context.Context, params *BucketsListParams) error
  • func (c Client) Update(ctx context.Context, params *BucketsUpdateParams) error

Constants

const InfiniteRetention = 0

Variables

var ErrMustSpecifyOrgDeleteByName = fmt.Errorf("%s when deleting a bucket by name", clients.ErrMustSpecifyOrg)

Types

type BucketsCreateParams

type BucketsCreateParams struct {
	clients.OrgParams
	Name               string
	Description        string
	Retention          string
	ShardGroupDuration string
	SchemaType         api.SchemaType
}

type BucketsDeleteParams

type BucketsDeleteParams struct {
	clients.OrgBucketParams
}

type BucketsListParams

type BucketsListParams struct {
	clients.OrgBucketParams
	Limit    int
	Offset   int
	PageSize int
}

type BucketsUpdateParams

type BucketsUpdateParams struct {
	clients.BucketParams
	Description        string
	Retention          string
	ShardGroupDuration string
}

type Client

type Client struct {
	clients.CLI
	api.OrganizationsApi
	api.BucketsApi
}

func (Client) Create

func (c Client) Create(ctx context.Context, params *BucketsCreateParams) error

func (Client) Delete

func (c Client) Delete(ctx context.Context, params *BucketsDeleteParams) error

func (Client) List

func (c Client) List(ctx context.Context, params *BucketsListParams) error

func (Client) Update

func (c Client) Update(ctx context.Context, params *BucketsUpdateParams) error