s3

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 30, 2020 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

Package s3 provided support for AWS s3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/Welcome.html)

Code generated by go generate via internal/cmd/service; DO NOT EDIT.

Index

Constants

View Source 
const (
	StorageClassStandard           = s3.ObjectStorageClassStandard
	StorageClassReducedRedundancy  = s3.ObjectStorageClassReducedRedundancy
	StorageClassGlacier            = s3.ObjectStorageClassGlacier
	StorageClassStandardIa         = s3.ObjectStorageClassStandardIa
	StorageClassOnezoneIa          = s3.ObjectStorageClassOnezoneIa
	StorageClassIntelligentTiering = s3.ObjectStorageClassIntelligentTiering
	StorageClassDeepArchive        = s3.ObjectStorageClassDeepArchive
)

All available storage classes are listed here.

View Source 
const (
	InfoObjectMetaStorageClass = "s3-storage-class"
)

Service available infos.

View Source 
const (
	// StorageClass will // StorageClass
	PairStorageClass = "s3_storage_class"
)

Service available pairs.

View Source 
const Type = "s3"

Type is the type for s3

Variables

This section is empty.

Functions

func GetStorageClass added in v1.1.0 

func GetStorageClass(m info.ObjectMeta) (string, bool)

GetStorageClass will get storage-class value from metadata.

func New 

func New(pairs ...*types.Pair) (storage.Servicer, storage.Storager, error)

New will create both Servicer and Storager.

func NewServicer added in v1.0.0 

func NewServicer(pairs ...*types.Pair) (storage.Servicer, error)

NewServicer will create Servicer only.

func NewStorager added in v1.0.0 

func NewStorager(pairs ...*types.Pair) (storage.Storager, error)

NewStorager will create Storager only.

func WithStorageClass added in v1.1.0 

func WithStorageClass(v string) *types.Pair

WithStorageClass will apply storage_class value to Options This pair is used to // StorageClass

Types

type Service 

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

Service is the s3 service config.

func (*Service) Create 

func (s *Service) Create(name string, pairs ...*types.Pair) (store storage.Storager, err error)

Create will create a new storager instance.

This function will create a context by default.

func (*Service) CreateWithContext added in v0.6.0 

func (s *Service) CreateWithContext(ctx context.Context, name string, pairs ...*types.Pair) (store storage.Storager, err error)

CreateWithContext will create a new storager instance.

func (*Service) Delete 

func (s *Service) Delete(name string, pairs ...*types.Pair) (err error)

Delete will delete a storager instance.

This function will create a context by default.

func (*Service) DeleteWithContext added in v0.6.0 

func (s *Service) DeleteWithContext(ctx context.Context, name string, pairs ...*types.Pair) (err error)

DeleteWithContext will delete a storager instance.

func (*Service) Get 

func (s *Service) Get(name string, pairs ...*types.Pair) (store storage.Storager, err error)

Get will get a valid storager instance for service.

This function will create a context by default.

func (*Service) GetWithContext added in v0.6.0 

func (s *Service) GetWithContext(ctx context.Context, name string, pairs ...*types.Pair) (store storage.Storager, err error)

GetWithContext will get a valid storager instance for service.

func (*Service) List 

func (s *Service) List(pairs ...*types.Pair) (err error)

List will list all storager instances under this service.

This function will create a context by default.

func (*Service) ListWithContext added in v0.6.0 

func (s *Service) ListWithContext(ctx context.Context, pairs ...*types.Pair) (err error)

ListWithContext will list all storager instances under this service.

func (*Service) String 

func (s *Service) String() string

String implements Servicer.String

type Storage 

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

Storage is the s3 object storage service.

func (*Storage) AbortSegment added in v0.9.0 

func (s *Storage) AbortSegment(seg segment.Segment, pairs ...*types.Pair) (err error)

AbortSegment will abort a segment.

This function will create a context by default.

func (*Storage) AbortSegmentWithContext added in v0.9.0 

func (s *Storage) AbortSegmentWithContext(ctx context.Context, seg segment.Segment, pairs ...*types.Pair) (err error)

AbortSegmentWithContext will abort a segment.

func (*Storage) CompleteSegment added in v0.9.0 

func (s *Storage) CompleteSegment(seg segment.Segment, pairs ...*types.Pair) (err error)

CompleteSegment will complete a segment and merge them into a File.

This function will create a context by default.

func (*Storage) CompleteSegmentWithContext added in v0.9.0 

func (s *Storage) CompleteSegmentWithContext(ctx context.Context, seg segment.Segment, pairs ...*types.Pair) (err error)

CompleteSegmentWithContext will complete a segment and merge them into a File.

func (*Storage) Delete 

func (s *Storage) Delete(path string, pairs ...*types.Pair) (err error)

Delete will delete an Object from service.

This function will create a context by default.

func (*Storage) DeleteWithContext added in v0.6.0 

func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...*types.Pair) (err error)

DeleteWithContext will delete an Object from service.

func (*Storage) InitIndexSegment added in v1.1.0 

func (s *Storage) InitIndexSegment(path string, pairs ...*types.Pair) (seg segment.Segment, err error)

InitIndexSegment will init an index based segment.

This function will create a context by default.

func (*Storage) InitIndexSegmentWithContext added in v1.1.0 

func (s *Storage) InitIndexSegmentWithContext(ctx context.Context, path string, pairs ...*types.Pair) (seg segment.Segment, err error)

InitIndexSegmentWithContext will init an index based segment.

func (*Storage) ListDir 

func (s *Storage) ListDir(dir string, pairs ...*types.Pair) (err error)

ListDir will return list a specific dir.

This function will create a context by default.

func (*Storage) ListDirWithContext added in v1.0.0 

func (s *Storage) ListDirWithContext(ctx context.Context, dir string, pairs ...*types.Pair) (err error)

ListDirWithContext will return list a specific dir.

func (*Storage) ListPrefix added in v1.0.0 

func (s *Storage) ListPrefix(prefix string, pairs ...*types.Pair) (err error)

ListPrefix will return list a specific dir.

This function will create a context by default.

func (*Storage) ListPrefixSegments added in v1.0.0 

func (s *Storage) ListPrefixSegments(prefix string, pairs ...*types.Pair) (err error)

ListPrefixSegments will list segments.

This function will create a context by default.

func (*Storage) ListPrefixSegmentsWithContext added in v1.0.0 

func (s *Storage) ListPrefixSegmentsWithContext(ctx context.Context, prefix string, pairs ...*types.Pair) (err error)

ListPrefixSegmentsWithContext will list segments.

func (*Storage) ListPrefixWithContext added in v1.0.0 

func (s *Storage) ListPrefixWithContext(ctx context.Context, prefix string, pairs ...*types.Pair) (err error)

ListPrefixWithContext will return list a specific dir.

func (*Storage) Metadata 

func (s *Storage) Metadata(pairs ...*types.Pair) (meta info.StorageMeta, err error)

Metadata will return current storager's metadata.

This function will create a context by default.

func (*Storage) MetadataWithContext added in v0.6.0 

func (s *Storage) MetadataWithContext(ctx context.Context, pairs ...*types.Pair) (meta info.StorageMeta, err error)

MetadataWithContext will return current storager's metadata.

func (*Storage) Read 

func (s *Storage) Read(path string, pairs ...*types.Pair) (rc io.ReadCloser, err error)

Read will read the file's data.

This function will create a context by default.

func (*Storage) ReadWithContext added in v0.6.0 

func (s *Storage) ReadWithContext(ctx context.Context, path string, pairs ...*types.Pair) (rc io.ReadCloser, err error)

ReadWithContext will read the file's data.

func (*Storage) Stat 

func (s *Storage) Stat(path string, pairs ...*types.Pair) (o *types.Object, err error)

Stat will stat a path to get info of an object.

This function will create a context by default.

func (*Storage) StatWithContext added in v0.6.0 

func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...*types.Pair) (o *types.Object, err error)

StatWithContext will stat a path to get info of an object.

func (*Storage) String 

func (s *Storage) String() string

String implements Storager.String

func (*Storage) Write 

func (s *Storage) Write(path string, r io.Reader, pairs ...*types.Pair) (err error)

Write will write data into a file.

This function will create a context by default.

func (*Storage) WriteIndexSegment added in v1.1.0 

func (s *Storage) WriteIndexSegment(seg segment.Segment, r io.Reader, index int, size int64, pairs ...*types.Pair) (err error)

WriteIndexSegment will write a part into an index based segment.

This function will create a context by default.

func (*Storage) WriteIndexSegmentWithContext added in v1.1.0 

func (s *Storage) WriteIndexSegmentWithContext(ctx context.Context, seg segment.Segment, r io.Reader, index int, size int64, pairs ...*types.Pair) (err error)

WriteIndexSegmentWithContext will write a part into an index based segment.

func (*Storage) WriteWithContext added in v0.6.0 

func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, pairs ...*types.Pair) (err error)

WriteWithContext will write data into a file.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.