cos

package

v0.27.0 Latest Latest Go to latest Published: Jul 5, 2022 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/thanos-io/thanos

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DefaultTransport(c HTTPConfig) *http.Transport
func NewTestBucket(t testing.TB) (objstore.Bucket, func(), error)
type Bucket
- func NewBucket(logger log.Logger, conf []byte, component string) (*Bucket, error)
- func NewBucketWithConfig(logger log.Logger, config Config, component string) (*Bucket, error)
type Config
type HTTPConfig

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultConfig = Config{
	HTTPConfig: HTTPConfig{
		IdleConnTimeout:       model.Duration(90 * time.Second),
		ResponseHeaderTimeout: model.Duration(2 * time.Minute),
		TLSHandshakeTimeout:   model.Duration(10 * time.Second),
		ExpectContinueTimeout: model.Duration(1 * time.Second),
		MaxIdleConns:          100,
		MaxIdleConnsPerHost:   100,
		MaxConnsPerHost:       0,
	},
}

DefaultConfig is the default config for an cos client. default tune the `MaxIdleConnsPerHost`.

Functions ¶

func DefaultTransport ¶ added in v0.23.0

func DefaultTransport(c HTTPConfig) *http.Transport

DefaultTransport build http.Transport from config.

func NewTestBucket ¶

func NewTestBucket(t testing.TB) (objstore.Bucket, func(), error)

NewTestBucket creates test bkt client that before returning creates temporary bucket. In a close function it empties and deletes the bucket.

Types ¶

type Bucket ¶

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

Bucket implements the store.Bucket interface against cos-compatible(Tencent Object Storage) APIs.

func NewBucket ¶

func NewBucket(logger log.Logger, conf []byte, component string) (*Bucket, error)

NewBucket returns a new Bucket using the provided cos configuration.

func NewBucketWithConfig ¶ added in v0.25.0

func NewBucketWithConfig(logger log.Logger, config Config, component string) (*Bucket, error)

NewBucketWithConfig returns a new Bucket using the provided cos config values.

func (*Bucket) Attributes ¶ added in v0.14.0

func (b *Bucket) Attributes(ctx context.Context, name string) (objstore.ObjectAttributes, error)

Attributes returns information about the specified object.

func (*Bucket) Close ¶

func (b *Bucket) Close() error

func (*Bucket) Delete ¶

func (b *Bucket) Delete(ctx context.Context, name string) error

Delete removes the object with the given name.

func (*Bucket) Exists ¶

func (b *Bucket) Exists(ctx context.Context, name string) (bool, error)

Exists checks if the given object exists in the bucket.

func (*Bucket) Get ¶

func (b *Bucket) Get(ctx context.Context, name string) (io.ReadCloser, error)

Get returns a reader for the given object name.

func (*Bucket) GetRange ¶

func (b *Bucket) GetRange(ctx context.Context, name string, off, length int64) (io.ReadCloser, error)

GetRange returns a new range reader for the given object name and range.

func (*Bucket) IsObjNotFoundErr ¶

func (b *Bucket) IsObjNotFoundErr(err error) bool

IsObjNotFoundErr returns true if error means that object is not found. Relevant to Get operations.

func (*Bucket) Iter ¶

func (b *Bucket) Iter(ctx context.Context, dir string, f func(string) error, options ...objstore.IterOption) error

Iter calls f for each entry in the given directory (not recursive.). The argument to f is the full object name including the prefix of the inspected directory.

func (*Bucket) Name ¶

func (b *Bucket) Name() string

Name returns the bucket name for COS.

func (*Bucket) Upload ¶

func (b *Bucket) Upload(ctx context.Context, name string, r io.Reader) error

Upload the contents of the reader as an object into the bucket.

type Config ¶

type Config struct {
	Bucket     string     `yaml:"bucket"`
	Region     string     `yaml:"region"`
	AppId      string     `yaml:"app_id"`
	Endpoint   string     `yaml:"endpoint"`
	SecretKey  string     `yaml:"secret_key"`
	SecretId   string     `yaml:"secret_id"`
	HTTPConfig HTTPConfig `yaml:"http_config"`
}

Config encapsulates the necessary config values to instantiate an cos client.

type HTTPConfig ¶ added in v0.23.0

type HTTPConfig struct {
	IdleConnTimeout       model.Duration `yaml:"idle_conn_timeout"`
	ResponseHeaderTimeout model.Duration `yaml:"response_header_timeout"`
	TLSHandshakeTimeout   model.Duration `yaml:"tls_handshake_timeout"`
	ExpectContinueTimeout model.Duration `yaml:"expect_continue_timeout"`
	MaxIdleConns          int            `yaml:"max_idle_conns"`
	MaxIdleConnsPerHost   int            `yaml:"max_idle_conns_per_host"`
	MaxConnsPerHost       int            `yaml:"max_conns_per_host"`
}

HTTPConfig stores the http.Transport configuration for the cos client.

Source Files ¶

View all Source files

cos.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL