openstack

Documentation

Index

• type SwiftConfig
  • func (cfg *SwiftConfig) RegisterFlags(f *flag.FlagSet)
  • func (cfg *SwiftConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
  • func (cfg *SwiftConfig) Validate() error
• type SwiftObjectClient
  • func NewSwiftObjectClient(cfg SwiftConfig) (*SwiftObjectClient, error)
  • func (s *SwiftObjectClient) DeleteObject(ctx context.Context, objectKey string) error
  • func (s *SwiftObjectClient) GetObject(ctx context.Context, objectKey string) (io.ReadCloser, error)
  • func (s *SwiftObjectClient) IsObjectNotFoundErr(err error) bool
  • func (s *SwiftObjectClient) List(ctx context.Context, prefix, delimiter string) ([]chunk.StorageObject, []chunk.StorageCommonPrefix, error)
  • func (s *SwiftObjectClient) PutObject(ctx context.Context, objectKey string, object io.ReadSeeker) error
  • func (s *SwiftObjectClient) Stop()

Types

type SwiftConfig

type SwiftConfig struct {
	cortex_swift.Config `yaml:",inline"`
}

SwiftConfig is config for the Swift Chunk Client.

func (*SwiftConfig) RegisterFlags

func (cfg *SwiftConfig) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers flags.

func (*SwiftConfig) RegisterFlagsWithPrefix

func (cfg *SwiftConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix registers flags with prefix.

func (*SwiftConfig) Validate

func (cfg *SwiftConfig) Validate() error

Validate config and returns error on failure

type SwiftObjectClient

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

func NewSwiftObjectClient

func NewSwiftObjectClient(cfg SwiftConfig) (*SwiftObjectClient, error)

NewSwiftObjectClient makes a new chunk.Client that writes chunks to OpenStack Swift.

func (*SwiftObjectClient) DeleteObject

func (s *SwiftObjectClient) DeleteObject(ctx context.Context, objectKey string) error

DeleteObject deletes the specified object key from the configured Swift container.

func (*SwiftObjectClient) GetObject

func (s *SwiftObjectClient) GetObject(ctx context.Context, objectKey string) (io.ReadCloser, error)

GetObject returns a reader for the specified object key from the configured swift container.

func (*SwiftObjectClient) IsObjectNotFoundErr

func (s *SwiftObjectClient) IsObjectNotFoundErr(err error) bool

IsObjectNotFoundErr returns true if error means that object is not found. Relevant to GetObject and DeleteObject operations.

func (*SwiftObjectClient) List

func (s *SwiftObjectClient) List(ctx context.Context, prefix, delimiter string) ([]chunk.StorageObject, []chunk.StorageCommonPrefix, error)

List only objects from the store non-recursively

func (*SwiftObjectClient) PutObject

func (s *SwiftObjectClient) PutObject(ctx context.Context, objectKey string, object io.ReadSeeker) error

PutObject puts the specified bytes into the configured Swift container at the provided key

func (*SwiftObjectClient) Stop

func (s *SwiftObjectClient) Stop()