minio

package module
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Jul 27, 2021 License: Apache-2.0 Imports: 51 Imported by: 0

README

MinIO Go Client SDK for Amazon S3 Compatible Cloud Storage Slack Sourcegraph Apache V2 License

The MinIO Go Client SDK provides simple APIs to access any Amazon S3 compatible object storage.

This quickstart guide will show you how to install the MinIO client SDK, connect to MinIO, and provide a walkthrough for a simple file uploader. For a complete list of APIs and examples, please take a look at the Go Client API Reference.

This document assumes that you have a working Go development environment.

Download from Github

GO111MODULE=on go get github.com/minio/minio-go/v7

Initialize MinIO Client

MinIO client requires the following four parameters specified to connect to an Amazon S3 compatible object storage.

Parameter Description
endpoint URL to object storage service.
minio.Options All the options such as credentials, custom transport etc. 
package main

import (
	"log"

	"github.com/minio/minio-go/v7"
	"github.com/minio/minio-go/v7/pkg/credentials"
)

func main() {
	endpoint := "play.min.io"
	accessKeyID := "Q3AM3UQ867SPQQA43P2F"
	secretAccessKey := "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
	useSSL := true

	// Initialize minio client object.
	minioClient, err := minio.New(endpoint, &minio.Options{
		Creds:  credentials.NewStaticV4(accessKeyID, secretAccessKey, ""),
		Secure: useSSL,
	})
	if err != nil {
		log.Fatalln(err)
	}

	log.Printf("%#v\n", minioClient) // minioClient is now set up
}

Quick Start Example - File Uploader

This example program connects to an object storage server, creates a bucket and uploads a file to the bucket.

We will use the MinIO server running at https://play.min.io in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.

FileUploader.go
package main

import (
	"context"
	"log"

	"github.com/minio/minio-go/v7"
	"github.com/minio/minio-go/v7/pkg/credentials"
)

func main() {
	ctx := context.Background()
	endpoint := "play.min.io"
	accessKeyID := "Q3AM3UQ867SPQQA43P2F"
	secretAccessKey := "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
	useSSL := true

	// Initialize minio client object.
	minioClient, err := minio.New(endpoint, &minio.Options{
		Creds:  credentials.NewStaticV4(accessKeyID, secretAccessKey, ""),
		Secure: useSSL,
	})
	if err != nil {
		log.Fatalln(err)
	}

	// Make a new bucket called mymusic.
	bucketName := "mymusic"
	location := "us-east-1"

	err = minioClient.MakeBucket(ctx, bucketName, minio.MakeBucketOptions{Region: location})
	if err != nil {
		// Check to see if we already own this bucket (which happens if you run this twice)
		exists, errBucketExists := minioClient.BucketExists(ctx, bucketName)
		if errBucketExists == nil && exists {
			log.Printf("We already own %s\n", bucketName)
		} else {
			log.Fatalln(err)
		}
	} else {
		log.Printf("Successfully created %s\n", bucketName)
	}

	// Upload the zip file
	objectName := "golden-oldies.zip"
	filePath := "/tmp/golden-oldies.zip"
	contentType := "application/zip"

	// Upload the zip file with FPutObject
	info, err := minioClient.FPutObject(ctx, bucketName, objectName, filePath, minio.PutObjectOptions{ContentType: contentType})
	if err != nil {
		log.Fatalln(err)
	}

	log.Printf("Successfully uploaded %s of size %d\n", objectName, info.Size)
}
Run FileUploader
export GO111MODULE=on
go run file-uploader.go
2016/08/13 17:03:28 Successfully created mymusic
2016/08/13 17:03:40 Successfully uploaded golden-oldies.zip of size 16253413

mc ls play/mymusic/
[2016-05-27 16:02:16 PDT]  17MiB golden-oldies.zip

API Reference

The full API Reference is available here.

API Reference : Bucket Operations
API Reference : Bucket policy Operations
API Reference : Bucket notification Operations
API Reference : File Object Operations
API Reference : Object Operations
API Reference : Presigned Operations
API Reference : Client custom settings

Full Examples

Full Examples : Bucket Operations
Full Examples : Bucket policy Operations
Full Examples : Bucket lifecycle Operations
Full Examples : Bucket encryption Operations
Full Examples : Bucket replication Operations
Full Examples : Bucket notification Operations
Full Examples : File Object Operations
Full Examples : Object Operations
Full Examples : Encrypted Object Operations
Full Examples : Presigned Operations

Explore Further

Contribute

Contributors Guide

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE and NOTICE for more information.

Documentation

Index

Constants

View Source 
const (
	Enabled = "Enabled"
	// Disabled  State = "Disabled" only used by MFA Delete not supported yet.
	Suspended = "Suspended"
)

Various supported states

View Source 
const (
	CSVFileHeaderInfoNone   CSVFileHeaderInfo = "NONE"
	CSVFileHeaderInfoIgnore                   = "IGNORE"
	CSVFileHeaderInfoUse                      = "USE"
)

Constants for file header info.

View Source 
const (
	SelectCompressionNONE SelectCompressionType = "NONE"
	SelectCompressionGZIP                       = "GZIP"
	SelectCompressionBZIP                       = "BZIP2"
)

Constants for compression types under select API.

View Source 
const (
	SelectObjectTypeCSV     SelectObjectType = "CSV"
	SelectObjectTypeJSON                     = "JSON"
	SelectObjectTypeParquet                  = "Parquet"
)

Constants for input data types.

View Source 
const MaxJitter = 1.0

MaxJitter will randomize over the full exponential backoff time

View Source 
const NoJitter = 0.0

NoJitter disables the use of jitter for randomizing the exponential backoff time

Variables

View Source 
var DefaultRetryCap = time.Second

DefaultRetryCap - Each retry attempt never waits no longer than this maximum time duration.

View Source 
var DefaultRetryUnit = 200 * time.Millisecond

DefaultRetryUnit - default unit multiplicative per retry. defaults to 200 * time.Millisecond

View Source 
var DefaultTransport = func(secure bool) (*http.Transport, error) {
	tr := &http.Transport{
		Proxy: http.ProxyFromEnvironment,
		DialContext: (&net.Dialer{
			Timeout:   30 * time.Second,
			KeepAlive: 30 * time.Second,
		}).DialContext,
		MaxIdleConns:          256,
		MaxIdleConnsPerHost:   16,
		ResponseHeaderTimeout: time.Minute,
		IdleConnTimeout:       time.Minute,
		TLSHandshakeTimeout:   10 * time.Second,
		ExpectContinueTimeout: 10 * time.Second,

		DisableCompression: true,
	}

	if secure {
		tr.TLSClientConfig = &tls.Config{

			MinVersion: tls.VersionTLS12,
		}
		if f := os.Getenv("SSL_CERT_FILE"); f != "" {
			rootCAs := mustGetSystemCertPool()
			data, err := ioutil.ReadFile(f)
			if err == nil {
				rootCAs.AppendCertsFromPEM(data)
			}
			tr.TLSClientConfig.RootCAs = rootCAs
		}
	}
	return tr, nil
}

DefaultTransport - this default transport is similar to http.DefaultTransport but with additional param DisableCompression is set to true to avoid decompressing content with 'gzip' encoding.

View Source 
var MaxRetry = 10

MaxRetry is the maximum number of retries before stopping.

Functions

func OptimalPartInfo added in v1.0.1 

func OptimalPartInfo(objectSize int64, configuredPartSize uint64) (totalPartsCount int, partSize int64, lastPartSize int64, err error)

OptimalPartInfo - calculate the optimal part info for a given object size.

NOTE: Assumption here is that for any object to be uploaded to any S3 compatible object storage it will have the following parameters as constants. 

maxPartsCount - 10000
minPartSize - 16MiB
maxMultipartPutObjectSize - 5TiB

Types

type AdvancedGetOptions added in v1.0.1 

type AdvancedGetOptions struct {
	ReplicationDeleteMarker bool
	ReplicationProxyRequest string
}

AdvancedGetOptions for internal use by MinIO server - not intended for client use.

type AdvancedPutOptions added in v1.0.1 

type AdvancedPutOptions struct {
	SourceVersionID    string
	SourceETag         string
	ReplicationStatus  ReplicationStatus
	SourceMTime        time.Time
	ReplicationRequest bool
}

AdvancedPutOptions for internal use - to be utilized by replication, ILM transition implementation on MinIO server

type AdvancedRemoveOptions added in v1.0.1 

type AdvancedRemoveOptions struct {
	ReplicationDeleteMarker bool
	ReplicationStatus       ReplicationStatus
	ReplicationMTime        time.Time
	ReplicationRequest      bool
}

AdvancedRemoveOptions intended for internal use by replication

type BucketInfo added in v1.0.0 

type BucketInfo struct {
	// The name of the bucket.
	Name string `json:"name"`
	// Date the bucket was created.
	CreationDate time.Time `json:"creationDate"`
}

BucketInfo container for bucket metadata.

type BucketLookupType added in v1.0.1 

type BucketLookupType int

BucketLookupType is type of url lookup supported by server. 

const (
	BucketLookupAuto BucketLookupType = iota
	BucketLookupDNS
	BucketLookupPath
)

Different types of url lookup supported by the server.Initialized to BucketLookupAuto

type BucketVersioningConfiguration added in v1.0.1 

type BucketVersioningConfiguration struct {
	XMLName   xml.Name `xml:"VersioningConfiguration"`
	Status    string   `xml:"Status"`
	MFADelete string   `xml:"MfaDelete,omitempty"`
}

BucketVersioningConfiguration is the versioning configuration structure

func (BucketVersioningConfiguration) Enabled added in v1.0.1 

func (b BucketVersioningConfiguration) Enabled() bool

Enabled returns true if bucket versioning is enabled

func (BucketVersioningConfiguration) Suspended added in v1.0.1 

func (b BucketVersioningConfiguration) Suspended() bool

Suspended returns true if bucket versioning is suspended

type CSVFileHeaderInfo added in v1.0.1 

type CSVFileHeaderInfo string

CSVFileHeaderInfo - is the parameter for whether to utilize headers.

type CSVInputOptions added in v1.0.1 

type CSVInputOptions struct {
	FileHeaderInfo CSVFileHeaderInfo

	RecordDelimiter string

	FieldDelimiter string

	QuoteCharacter string

	QuoteEscapeCharacter string

	Comments string
	// contains filtered or unexported fields
}

CSVInputOptions csv input specific options

func (CSVInputOptions) MarshalXML added in v1.0.1 

func (c CSVInputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML - produces the xml representation of the CSV input options struct

func (*CSVInputOptions) SetComments added in v1.0.1 

func (c *CSVInputOptions) SetComments(val string)

SetComments sets the comments character in the CSV input options

func (*CSVInputOptions) SetFieldDelimiter added in v1.0.1 

func (c *CSVInputOptions) SetFieldDelimiter(val string)

SetFieldDelimiter sets the field delimiter in the CSV input options

func (*CSVInputOptions) SetFileHeaderInfo added in v1.0.1 

func (c *CSVInputOptions) SetFileHeaderInfo(val CSVFileHeaderInfo)

SetFileHeaderInfo sets the file header info in the CSV input options

func (*CSVInputOptions) SetQuoteCharacter added in v1.0.1 

func (c *CSVInputOptions) SetQuoteCharacter(val string)

SetQuoteCharacter sets the quote character in the CSV input options

func (*CSVInputOptions) SetQuoteEscapeCharacter added in v1.0.1 

func (c *CSVInputOptions) SetQuoteEscapeCharacter(val string)

SetQuoteEscapeCharacter sets the quote escape character in the CSV input options

func (*CSVInputOptions) SetRecordDelimiter added in v1.0.1 

func (c *CSVInputOptions) SetRecordDelimiter(val string)

SetRecordDelimiter sets the record delimiter in the CSV input options

type CSVOutputOptions added in v1.0.1 

type CSVOutputOptions struct {
	QuoteFields CSVQuoteFields

	RecordDelimiter string

	FieldDelimiter string

	QuoteCharacter string

	QuoteEscapeCharacter string
	// contains filtered or unexported fields
}

CSVOutputOptions csv output specific options

func (CSVOutputOptions) MarshalXML added in v1.0.1 

func (c CSVOutputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML - produces the xml representation of the CSVOutputOptions struct

func (*CSVOutputOptions) SetFieldDelimiter added in v1.0.1 

func (c *CSVOutputOptions) SetFieldDelimiter(val string)

SetFieldDelimiter sets the field delimiter character in the CSV output options

func (*CSVOutputOptions) SetQuoteCharacter added in v1.0.1 

func (c *CSVOutputOptions) SetQuoteCharacter(val string)

SetQuoteCharacter sets the quote character in the CSV output options

func (*CSVOutputOptions) SetQuoteEscapeCharacter added in v1.0.1 

func (c *CSVOutputOptions) SetQuoteEscapeCharacter(val string)

SetQuoteEscapeCharacter sets the quote escape character in the CSV output options

func (*CSVOutputOptions) SetQuoteFields added in v1.0.1 

func (c *CSVOutputOptions) SetQuoteFields(val CSVQuoteFields)

SetQuoteFields sets the quote field parameter in the CSV output options

func (*CSVOutputOptions) SetRecordDelimiter added in v1.0.1 

func (c *CSVOutputOptions) SetRecordDelimiter(val string)

SetRecordDelimiter sets the record delimiter character in the CSV output options

type CSVQuoteFields added in v1.0.1 

type CSVQuoteFields string

CSVQuoteFields - is the parameter for how CSV fields are quoted. 

const (
	CSVQuoteFieldsAlways   CSVQuoteFields = "Always"
	CSVQuoteFieldsAsNeeded                = "AsNeeded"
)

Constants for csv quote styles.

type Client added in v1.0.0 

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

Client implements Amazon S3 compatible methods.

func New 

func New(endpoint string, opts *Options) (*Client, error)

New - instantiate minio client with options

func (Client) BucketExists added in v1.0.0 

func (c Client) BucketExists(ctx context.Context, bucketName string) (bool, error)

BucketExists verifies if bucket exists and you have permission to access it. Allows for a Context to control cancellations and timeouts.

func (Client) ComposeObject added in v1.0.1 

func (c Client) ComposeObject(ctx context.Context, dst CopyDestOptions, srcs ...CopySrcOptions) (UploadInfo, error)

ComposeObject - creates an object using server-side copying of existing objects. It takes a list of source objects (with optional offsets) and concatenates them into a new object using only server-side copying operations. Optionally takes progress reader hook for applications to look at current progress.

func (Client) CopyObject added in v1.0.1 

func (c Client) CopyObject(ctx context.Context, dst CopyDestOptions, src CopySrcOptions) (UploadInfo, error)

CopyObject - copy a source object into a new object

func (Client) EnableVersioning added in v1.0.1 

func (c Client) EnableVersioning(ctx context.Context, bucketName string) error

EnableVersioning - enable object versioning in given bucket.

func (*Client) EndpointURL added in v1.0.1 

func (c *Client) EndpointURL() *url.URL

EndpointURL returns the URL of the S3 endpoint.

func (Client) FGetObject added in v1.0.0 

func (c Client) FGetObject(ctx context.Context, bucketName, objectName, filePath string, opts GetObjectOptions) error

FGetObject - download contents of an object to a local file. The options can be used to specify the GET request further.

func (Client) FPutObject added in v1.0.0 

func (c Client) FPutObject(ctx context.Context, bucketName, objectName, filePath string, opts PutObjectOptions) (info UploadInfo, err error)

FPutObject - Create an object in a bucket, with contents from file at filePath. Allows request cancellation.

func (Client) GetBucketEncryption added in v1.0.1 

func (c Client) GetBucketEncryption(ctx context.Context, bucketName string) (*sse.Configuration, error)

GetBucketEncryption gets the default encryption configuration on an existing bucket with a context to control cancellations and timeouts.

func (Client) GetBucketLifecycle added in v1.0.1 

func (c Client) GetBucketLifecycle(ctx context.Context, bucketName string) (*lifecycle.Configuration, error)

GetBucketLifecycle fetch bucket lifecycle configuration

func (Client) GetBucketLocation added in v1.0.1 

func (c Client) GetBucketLocation(ctx context.Context, bucketName string) (string, error)

GetBucketLocation - get location for the bucket name from location cache, if not fetch freshly by making a new request.

func (Client) GetBucketNotification added in v1.0.1 

func (c Client) GetBucketNotification(ctx context.Context, bucketName string) (bucketNotification notification.Configuration, err error)

GetBucketNotification returns current bucket notification configuration

func (Client) GetBucketObjectLockConfig added in v1.0.1 

func (c Client) GetBucketObjectLockConfig(ctx context.Context, bucketName string) (mode *RetentionMode, validity *uint, unit *ValidityUnit, err error)

GetBucketObjectLockConfig gets object lock configuration of given bucket.

func (Client) GetBucketPolicy added in v1.0.1 

func (c Client) GetBucketPolicy(ctx context.Context, bucketName string) (string, error)

GetBucketPolicy returns the current policy

func (Client) GetBucketReplication added in v1.0.1 

func (c Client) GetBucketReplication(ctx context.Context, bucketName string) (cfg replication.Config, err error)

GetBucketReplication fetches bucket replication configuration.If config is not found, returns empty config with nil error.

func (Client) GetBucketReplicationMetrics added in v1.0.1 

func (c Client) GetBucketReplicationMetrics(ctx context.Context, bucketName string) (s replication.Metrics, err error)

GetBucketReplicationMetrics fetches bucket replication status metrics

func (Client) GetBucketTagging added in v1.0.1 

func (c Client) GetBucketTagging(ctx context.Context, bucketName string) (*tags.Tags, error)

GetBucketTagging fetch tagging configuration for a bucket with a context to control cancellations and timeouts.

func (Client) GetBucketVersioning added in v1.0.1 

func (c Client) GetBucketVersioning(ctx context.Context, bucketName string) (BucketVersioningConfiguration, error)

GetBucketVersioning gets the versioning configuration on an existing bucket with a context to control cancellations and timeouts.

func (Client) GetObject added in v1.0.0 

func (c Client) GetObject(ctx context.Context, bucketName, objectName string, opts GetObjectOptions) (*Object, error)

GetObject wrapper function that accepts a request context

func (Client) GetObjectACL added in v1.0.1 

func (c Client) GetObjectACL(ctx context.Context, bucketName, objectName string) (*ObjectInfo, error)

GetObjectACL get object ACLs

func (Client) GetObjectLegalHold added in v1.0.1 

func (c Client) GetObjectLegalHold(ctx context.Context, bucketName, objectName string, opts GetObjectLegalHoldOptions) (status *LegalHoldStatus, err error)

GetObjectLegalHold gets legal-hold status of given object.

func (Client) GetObjectLockConfig added in v1.0.1 

func (c Client) GetObjectLockConfig(ctx context.Context, bucketName string) (objectLock string, mode *RetentionMode, validity *uint, unit *ValidityUnit, err error)

GetObjectLockConfig gets object lock configuration of given bucket.

func (Client) GetObjectRetention added in v1.0.1 

func (c Client) GetObjectRetention(ctx context.Context, bucketName, objectName, versionID string) (mode *RetentionMode, retainUntilDate *time.Time, err error)

GetObjectRetention gets retention of given object.

func (Client) GetObjectTagging added in v1.0.1 

func (c Client) GetObjectTagging(ctx context.Context, bucketName, objectName string, opts GetObjectTaggingOptions) (*tags.Tags, error)

GetObjectTagging fetches object tag(s) with options to target a specific object version in a versioned bucket.

func (Client) ListBuckets added in v1.0.0 

func (c Client) ListBuckets(ctx context.Context) ([]BucketInfo, error)

ListBuckets list all buckets owned by this authenticated user.

This call requires explicit authentication, no anonymous requests are allowed for listing buckets. 

api := client.New(....)
for message := range api.ListBuckets(context.Background()) {
    fmt.Println(message)
}

func (Client) ListIncompleteUploads added in v1.0.0 

func (c Client) ListIncompleteUploads(ctx context.Context, bucketName, objectPrefix string, recursive bool) <-chan ObjectMultipartInfo

ListIncompleteUploads - List incompletely uploaded multipart objects.

ListIncompleteUploads lists all incompleted objects matching the objectPrefix from the specified bucket. If recursion is enabled it would list all subdirectories and all its contents.

Your input parameters are just bucketName, objectPrefix, recursive. If you enable recursive as 'true' this function will return back all the multipart objects in a given bucket name. 

api := client.New(....)
// Recurively list all objects in 'mytestbucket'
recursive := true
for message := range api.ListIncompleteUploads(context.Background(), "mytestbucket", "starthere", recursive) {
    fmt.Println(message)
}

func (Client) ListObjects added in v1.0.0 

func (c Client) ListObjects(ctx context.Context, bucketName string, opts ListObjectsOptions) <-chan ObjectInfo

ListObjects returns objects list after evaluating the passed options. 

api := client.New(....)
for object := range api.ListObjects(ctx, "mytestbucket", minio.ListObjectsOptions{Prefix: "starthere", Recursive:true}) {
    fmt.Println(object)
}

func (Client) ListenBucketNotification added in v1.0.1 

func (c Client) ListenBucketNotification(ctx context.Context, bucketName, prefix, suffix string, events []string) <-chan notification.Info

ListenBucketNotification listen for bucket events, this is a MinIO specific API

func (Client) ListenNotification added in v1.0.1 

func (c Client) ListenNotification(ctx context.Context, prefix, suffix string, events []string) <-chan notification.Info

ListenNotification listen for all events, this is a MinIO specific API

func (Client) MakeBucket added in v1.0.0 

func (c Client) MakeBucket(ctx context.Context, bucketName string, opts MakeBucketOptions) (err error)

MakeBucket creates a new bucket with bucketName with a context to control cancellations and timeouts.

Location is an optional argument, by default all buckets are created in US Standard Region.

For Amazon S3 for more supported regions - http://docs.aws.amazon.com/general/latest/gr/rande.html For Google Cloud Storage for more supported regions - https://cloud.google.com/storage/docs/bucket-locations

func (Client) Presign added in v1.0.1 

func (c Client) Presign(ctx context.Context, method string, bucketName string, objectName string, expires time.Duration, reqParams url.Values) (u *url.URL, err error)

Presign - returns a presigned URL for any http method of your choice along with custom request params. URL can have a maximum expiry of upto 7days or a minimum of 1sec.

func (Client) PresignedGetObject added in v1.0.0 

func (c Client) PresignedGetObject(ctx context.Context, bucketName string, objectName string, expires time.Duration, reqParams url.Values) (u *url.URL, err error)

PresignedGetObject - Returns a presigned URL to access an object data without credentials. URL can have a maximum expiry of upto 7days or a minimum of 1sec. Additionally you can override a set of response headers using the query parameters.

func (Client) PresignedHeadObject added in v1.0.1 

func (c Client) PresignedHeadObject(ctx context.Context, bucketName string, objectName string, expires time.Duration, reqParams url.Values) (u *url.URL, err error)

PresignedHeadObject - Returns a presigned URL to access object metadata without credentials. URL can have a maximum expiry of upto 7days or a minimum of 1sec. Additionally you can override a set of response headers using the query parameters.

func (Client) PresignedPostPolicy added in v1.0.0 

func (c Client) PresignedPostPolicy(ctx context.Context, p *PostPolicy) (u *url.URL, formData map[string]string, err error)

PresignedPostPolicy - Returns POST urlString, form data to upload an object.

func (Client) PresignedPutObject added in v1.0.0 

func (c Client) PresignedPutObject(ctx context.Context, bucketName string, objectName string, expires time.Duration) (u *url.URL, err error)

PresignedPutObject - Returns a presigned URL to upload an object without credentials. URL can have a maximum expiry of upto 7days or a minimum of 1sec.

func (Client) PutObject added in v1.0.0 

func (c Client) PutObject(ctx context.Context, bucketName, objectName string, reader io.Reader, objectSize int64,
	opts PutObjectOptions) (info UploadInfo, err error)

PutObject creates an object in a bucket.

You must have WRITE permissions on a bucket to create an object.

  • For size smaller than 128MiB PutObject automatically does a single atomic Put operation.
  • For size larger than 128MiB PutObject automatically does a multipart Put operation.
  • For size input as -1 PutObject does a multipart Put operation until input stream reaches EOF. Maximum object size that can be uploaded through this operation will be 5TiB.

func (Client) PutObjectLegalHold added in v1.0.1 

func (c Client) PutObjectLegalHold(ctx context.Context, bucketName, objectName string, opts PutObjectLegalHoldOptions) error

PutObjectLegalHold : sets object legal hold for a given object and versionID.

func (Client) PutObjectRetention added in v1.0.1 

func (c Client) PutObjectRetention(ctx context.Context, bucketName, objectName string, opts PutObjectRetentionOptions) error

PutObjectRetention sets object retention for a given object and versionID.

func (Client) PutObjectTagging added in v1.0.1 

func (c Client) PutObjectTagging(ctx context.Context, bucketName, objectName string, otags *tags.Tags, opts PutObjectTaggingOptions) error

PutObjectTagging replaces or creates object tag(s) and can target a specific object version in a versioned bucket.

func (Client) RemoveAllBucketNotification added in v1.0.1 

func (c Client) RemoveAllBucketNotification(ctx context.Context, bucketName string) error

RemoveAllBucketNotification - Remove bucket notification clears all previously specified config

func (Client) RemoveBucket added in v1.0.0 

func (c Client) RemoveBucket(ctx context.Context, bucketName string) error

RemoveBucket deletes the bucket name. 

All objects (including all object versions and delete markers).
in the bucket must be deleted before successfully attempting this request.

func (Client) RemoveBucketEncryption added in v1.0.1 

func (c Client) RemoveBucketEncryption(ctx context.Context, bucketName string) error

RemoveBucketEncryption removes the default encryption configuration on a bucket with a context to control cancellations and timeouts.

func (Client) RemoveBucketReplication added in v1.0.1 

func (c Client) RemoveBucketReplication(ctx context.Context, bucketName string) error

RemoveBucketReplication removes a replication config on an existing bucket.

func (Client) RemoveBucketTagging added in v1.0.1 

func (c Client) RemoveBucketTagging(ctx context.Context, bucketName string) error

RemoveBucketTagging removes tagging configuration for a bucket with a context to control cancellations and timeouts.

func (Client) RemoveIncompleteUpload added in v1.0.0 

func (c Client) RemoveIncompleteUpload(ctx context.Context, bucketName, objectName string) error

RemoveIncompleteUpload aborts an partially uploaded object.

func (Client) RemoveObject added in v1.0.0 

func (c Client) RemoveObject(ctx context.Context, bucketName, objectName string, opts RemoveObjectOptions) error

RemoveObject removes an object from a bucket.

func (Client) RemoveObjectTagging added in v1.0.1 

func (c Client) RemoveObjectTagging(ctx context.Context, bucketName, objectName string, opts RemoveObjectTaggingOptions) error

RemoveObjectTagging removes object tag(s) with options to control a specific object version in a versioned bucket

func (Client) RemoveObjects added in v1.0.1 

func (c Client) RemoveObjects(ctx context.Context, bucketName string, objectsCh <-chan ObjectInfo, opts RemoveObjectsOptions) <-chan RemoveObjectError

RemoveObjects removes multiple objects from a bucket while it is possible to specify objects versions which are received from objectsCh. Remove failures are sent back via error channel.

func (Client) ResetBucketReplication added in v1.0.1 

func (c Client) ResetBucketReplication(ctx context.Context, bucketName string, olderThan time.Duration) (resetID string, err error)

ResetBucketReplication kicks off replication of previously replicated objects if ExistingObjectReplication is enabled in the replication config

func (Client) SelectObjectContent added in v1.0.1 

func (c Client) SelectObjectContent(ctx context.Context, bucketName, objectName string, opts SelectObjectOptions) (*SelectResults, error)

SelectObjectContent is a implementation of http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html AWS S3 API.

func (*Client) SetAppInfo added in v1.0.0 

func (c *Client) SetAppInfo(appName string, appVersion string)

SetAppInfo - add application details to user agent.

func (Client) SetBucketEncryption added in v1.0.1 

func (c Client) SetBucketEncryption(ctx context.Context, bucketName string, config *sse.Configuration) error

SetBucketEncryption sets the default encryption configuration on an existing bucket.

func (Client) SetBucketLifecycle added in v1.0.1 

func (c Client) SetBucketLifecycle(ctx context.Context, bucketName string, config *lifecycle.Configuration) error

SetBucketLifecycle set the lifecycle on an existing bucket.

func (Client) SetBucketNotification added in v1.0.1 

func (c Client) SetBucketNotification(ctx context.Context, bucketName string, config notification.Configuration) error

SetBucketNotification saves a new bucket notification with a context to control cancellations and timeouts.

func (Client) SetBucketObjectLockConfig added in v1.0.1 

func (c Client) SetBucketObjectLockConfig(ctx context.Context, bucketName string, mode *RetentionMode, validity *uint, unit *ValidityUnit) error

SetBucketObjectLockConfig sets object lock configuration in given bucket. mode, validity and unit are either all set or all nil.

func (Client) SetBucketPolicy added in v1.0.1 

func (c Client) SetBucketPolicy(ctx context.Context, bucketName, policy string) error

SetBucketPolicy sets the access permissions on an existing bucket.

func (Client) SetBucketReplication added in v1.0.1 

func (c Client) SetBucketReplication(ctx context.Context, bucketName string, cfg replication.Config) error

SetBucketReplication sets a replication config on an existing bucket.

func (Client) SetBucketTagging added in v1.0.1 

func (c Client) SetBucketTagging(ctx context.Context, bucketName string, tags *tags.Tags) error

SetBucketTagging sets tagging configuration for a bucket with a context to control cancellations and timeouts.

func (Client) SetBucketVersioning added in v1.0.1 

func (c Client) SetBucketVersioning(ctx context.Context, bucketName string, config BucketVersioningConfiguration) error

SetBucketVersioning sets a bucket versioning configuration

func (Client) SetObjectLockConfig added in v1.0.1 

func (c Client) SetObjectLockConfig(ctx context.Context, bucketName string, mode *RetentionMode, validity *uint, unit *ValidityUnit) error

SetObjectLockConfig sets object lock configuration in given bucket. mode, validity and unit are either all set or all nil.

func (*Client) SetS3TransferAccelerate added in v1.0.1 

func (c *Client) SetS3TransferAccelerate(accelerateEndpoint string)

SetS3TransferAccelerate - turns s3 accelerated endpoint on or off for all your requests. This feature is only specific to S3 for all other endpoints this function does nothing. To read further details on s3 transfer acceleration please vist - http://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html

func (Client) StatObject added in v1.0.0 

func (c Client) StatObject(ctx context.Context, bucketName, objectName string, opts StatObjectOptions) (ObjectInfo, error)

StatObject verifies if object exists and you have permission to access.

func (Client) SuspendVersioning added in v1.0.1 

func (c Client) SuspendVersioning(ctx context.Context, bucketName string) error

SuspendVersioning - suspend object versioning in given bucket.

func (*Client) TraceErrorsOnlyOff added in v1.0.1 

func (c *Client) TraceErrorsOnlyOff()

TraceErrorsOnlyOff - Turns off the errors only tracing and everything will be traced after this call. If all tracing needs to be turned off, call TraceOff().

func (*Client) TraceErrorsOnlyOn added in v1.0.1 

func (c *Client) TraceErrorsOnlyOn(outputStream io.Writer)

TraceErrorsOnlyOn - same as TraceOn, but only errors will be traced.

func (*Client) TraceOff added in v1.0.0 

func (c *Client) TraceOff()

TraceOff - disable HTTP tracing.

func (*Client) TraceOn added in v1.0.0 

func (c *Client) TraceOn(outputStream io.Writer)

TraceOn - enable HTTP tracing.

type CommonPrefix added in v1.0.1 

type CommonPrefix struct {
	Prefix string
}

CommonPrefix container for prefix response.

type CompletePart added in v1.0.1 

type CompletePart struct {
	XMLName xml.Name `xml:"http://s3.amazonaws.com/doc/2006-03-01/ Part" json:"-"`

	// Part number identifies the part.
	PartNumber int
	ETag       string
}

CompletePart sub container lists individual part numbers and their md5sum, part of completeMultipartUpload.

type CopyDestOptions added in v1.0.1 

type CopyDestOptions struct {
	Bucket string // points to destination bucket
	Object string // points to destination object

	// `Encryption` is the key info for server-side-encryption with customer
	// provided key. If it is nil, no encryption is performed.
	Encryption encrypt.ServerSide

	// `userMeta` is the user-metadata key-value pairs to be set on the
	// destination. The keys are automatically prefixed with `x-amz-meta-`
	// if needed. If nil is passed, and if only a single source (of any
	// size) is provided in the ComposeObject call, then metadata from the
	// source is copied to the destination.
	// if no user-metadata is provided, it is copied from source
	// (when there is only once source object in the compose
	// request)
	UserMetadata map[string]string
	// UserMetadata is only set to destination if ReplaceMetadata is true
	// other value is UserMetadata is ignored and we preserve src.UserMetadata
	// NOTE: if you set this value to true and now metadata is present
	// in UserMetadata your destination object will not have any metadata
	// set.
	ReplaceMetadata bool

	// `userTags` is the user defined object tags to be set on destination.
	// This will be set only if the `replaceTags` field is set to true.
	// Otherwise this field is ignored
	UserTags    map[string]string
	ReplaceTags bool

	// Specifies whether you want to apply a Legal Hold to the copied object.
	LegalHold LegalHoldStatus

	// Object Retention related fields
	Mode            RetentionMode
	RetainUntilDate time.Time

	Size int64 // Needs to be specified if progress bar is specified.
	// Progress of the entire copy operation will be sent here.
	Progress io.Reader
}

CopyDestOptions represents options specified by user for CopyObject/ComposeObject APIs

func (CopyDestOptions) Marshal added in v1.0.1 

func (opts CopyDestOptions) Marshal(header http.Header)

Marshal converts all the CopyDestOptions into their equivalent HTTP header representation

type CopySrcOptions added in v1.0.1 

type CopySrcOptions struct {
	Bucket, Object       string
	VersionID            string
	MatchETag            string
	NoMatchETag          string
	MatchModifiedSince   time.Time
	MatchUnmodifiedSince time.Time
	MatchRange           bool
	Start, End           int64
	Encryption           encrypt.ServerSide
}

CopySrcOptions represents a source object to be copied, using server-side copying APIs.

func (CopySrcOptions) Marshal added in v1.0.1 

func (opts CopySrcOptions) Marshal(header http.Header)

Marshal converts all the CopySrcOptions into their equivalent HTTP header representation

type Core added in v1.0.1 

type Core struct {
	*Client
}

Core - Inherits Client and adds new methods to expose the low level S3 APIs.

func NewCore added in v1.0.1 

func NewCore(endpoint string, opts *Options) (*Core, error)

NewCore - Returns new initialized a Core client, this CoreClient should be only used under special conditions such as need to access lower primitives and being able to use them to write your own wrappers.

func (Core) AbortMultipartUpload added in v1.0.1 

func (c Core) AbortMultipartUpload(ctx context.Context, bucket, object, uploadID string) error

AbortMultipartUpload - Abort an incomplete upload.

func (Core) CompleteMultipartUpload added in v1.0.1 

func (c Core) CompleteMultipartUpload(ctx context.Context, bucket, object, uploadID string, parts []CompletePart, opts PutObjectOptions) (string, error)

CompleteMultipartUpload - Concatenate uploaded parts and commit to an object.

func (Core) CopyObject added in v1.0.1 

func (c Core) CopyObject(ctx context.Context, sourceBucket, sourceObject, destBucket, destObject string, metadata map[string]string, srcOpts CopySrcOptions, dstOpts PutObjectOptions) (ObjectInfo, error)

CopyObject - copies an object from source object to destination object on server side.

func (Core) CopyObjectPart added in v1.0.1 

func (c Core) CopyObjectPart(ctx context.Context, srcBucket, srcObject, destBucket, destObject string, uploadID string,
	partID int, startOffset, length int64, metadata map[string]string) (p CompletePart, err error)

CopyObjectPart - creates a part in a multipart upload by copying (a part of) an existing object.

func (Core) GetBucketPolicy added in v1.0.1 

func (c Core) GetBucketPolicy(ctx context.Context, bucket string) (string, error)

GetBucketPolicy - fetches bucket access policy for a given bucket.

func (Core) GetObject added in v1.0.1 

func (c Core) GetObject(ctx context.Context, bucketName, objectName string, opts GetObjectOptions) (io.ReadCloser, ObjectInfo, http.Header, error)

GetObject is a lower level API implemented to support reading partial objects and also downloading objects with special conditions matching etag, modtime etc.

func (Core) ListMultipartUploads added in v1.0.1 

func (c Core) ListMultipartUploads(ctx context.Context, bucket, prefix, keyMarker, uploadIDMarker, delimiter string, maxUploads int) (result ListMultipartUploadsResult, err error)

ListMultipartUploads - List incomplete uploads.

func (Core) ListObjectParts added in v1.0.1 

func (c Core) ListObjectParts(ctx context.Context, bucket, object, uploadID string, partNumberMarker int, maxParts int) (result ListObjectPartsResult, err error)

ListObjectParts - List uploaded parts of an incomplete upload.x

func (Core) ListObjects added in v1.0.1 

func (c Core) ListObjects(bucket, prefix, marker, delimiter string, maxKeys int) (result ListBucketResult, err error)

ListObjects - List all the objects at a prefix, optionally with marker and delimiter you can further filter the results.

func (Core) ListObjectsV2 added in v1.0.1 

func (c Core) ListObjectsV2(bucketName, objectPrefix, startAfter, continuationToken, delimiter string, maxkeys int) (ListBucketV2Result, error)

ListObjectsV2 - Lists all the objects at a prefix, similar to ListObjects() but uses continuationToken instead of marker to support iteration over the results.

func (Core) NewMultipartUpload added in v1.0.1 

func (c Core) NewMultipartUpload(ctx context.Context, bucket, object string, opts PutObjectOptions) (uploadID string, err error)

NewMultipartUpload - Initiates new multipart upload and returns the new uploadID.

func (Core) PutBucketPolicy added in v1.0.1 

func (c Core) PutBucketPolicy(ctx context.Context, bucket, bucketPolicy string) error

PutBucketPolicy - applies a new bucket access policy for a given bucket.

func (Core) PutObject added in v1.0.1 

func (c Core) PutObject(ctx context.Context, bucket, object string, data io.Reader, size int64, md5Base64, sha256Hex string, opts PutObjectOptions) (UploadInfo, error)

PutObject - Upload object. Uploads using single PUT call.

func (Core) PutObjectPart added in v1.0.1 

func (c Core) PutObjectPart(ctx context.Context, bucket, object, uploadID string, partID int, data io.Reader, size int64, md5Base64, sha256Hex string, sse encrypt.ServerSide) (ObjectPart, error)

PutObjectPart - Upload an object part.

func (Core) StatObject added in v1.0.1 

func (c Core) StatObject(ctx context.Context, bucketName, objectName string, opts StatObjectOptions) (ObjectInfo, error)

StatObject is a lower level API implemented to support special conditions matching etag, modtime on a request.

type ErrorResponse 

type ErrorResponse struct {
	XMLName    xml.Name `xml:"Error" json:"-"`
	Code       string
	Message    string
	BucketName string
	Key        string
	RequestID  string `xml:"RequestId"`
	HostID     string `xml:"HostId"`

	// Region where the bucket is located. This header is returned
	// only in HEAD bucket and ListObjects response.
	Region string

	// Captures the server string returned in response header.
	Server string

	// Underlying HTTP status code for the returned error
	StatusCode int `xml:"-" json:"-"`
}

ErrorResponse - Is the typed error returned by all API operations. ErrorResponse struct should be comparable since it is compared inside golang http API (https://github.com/golang/go/issues/29768)

func ToErrorResponse 

func ToErrorResponse(err error) ErrorResponse

ToErrorResponse - Returns parsed ErrorResponse struct from body and http headers.

For example: 

import s3 "github.com/minio/minio-go/v7"
...
...
reader, stat, err := s3.GetObject(...)
if err != nil {
   resp := s3.ToErrorResponse(err)
}
...

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error - Returns S3 error string.

type GetObjectLegalHoldOptions added in v1.0.1 

type GetObjectLegalHoldOptions struct {
	VersionID string
}

GetObjectLegalHoldOptions represents options specified by user for GetObjectLegalHold call

type GetObjectOptions added in v1.0.1 

type GetObjectOptions struct {
	ServerSideEncryption encrypt.ServerSide
	VersionID            string
	// To be not used by external applications
	Internal AdvancedGetOptions
	// contains filtered or unexported fields
}

GetObjectOptions are used to specify additional headers or options during GET requests.

func (GetObjectOptions) Header added in v1.0.1 

func (o GetObjectOptions) Header() http.Header

Header returns the http.Header representation of the GET options.

func (*GetObjectOptions) Set added in v1.0.1 

func (o *GetObjectOptions) Set(key, value string)

Set adds a key value pair to the options. The key-value pair will be part of the HTTP GET request headers.

func (*GetObjectOptions) SetMatchETag added in v1.0.1 

func (o *GetObjectOptions) SetMatchETag(etag string) error

SetMatchETag - set match etag.

func (*GetObjectOptions) SetMatchETagExcept added in v1.0.1 

func (o *GetObjectOptions) SetMatchETagExcept(etag string) error

SetMatchETagExcept - set match etag except.

func (*GetObjectOptions) SetModified added in v1.0.1 

func (o *GetObjectOptions) SetModified(modTime time.Time) error

SetModified - set modified time since.

func (*GetObjectOptions) SetRange added in v1.0.1 

func (o *GetObjectOptions) SetRange(start, end int64) error

SetRange - set the start and end offset of the object to be read. See https://tools.ietf.org/html/rfc7233#section-3.1 for reference.

func (*GetObjectOptions) SetUnmodified added in v1.0.1 

func (o *GetObjectOptions) SetUnmodified(modTime time.Time) error

SetUnmodified - set unmodified time since.

type GetObjectTaggingOptions added in v1.0.1 

type GetObjectTaggingOptions struct {
	VersionID string
}

GetObjectTaggingOptions holds the object version ID to fetch the tagging key/value pairs

type JSONInputOptions added in v1.0.1 

type JSONInputOptions struct {
	Type JSONType
	// contains filtered or unexported fields
}

JSONInputOptions json input specific options

func (JSONInputOptions) MarshalXML added in v1.0.1 

func (j JSONInputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML - produces the xml representation of the JSONInputOptions struct

func (*JSONInputOptions) SetType added in v1.0.1 

func (j *JSONInputOptions) SetType(typ JSONType)

SetType sets the JSON type in the JSON input options

type JSONOutputOptions added in v1.0.1 

type JSONOutputOptions struct {
	RecordDelimiter string
	// contains filtered or unexported fields
}

JSONOutputOptions - json output specific options

func (JSONOutputOptions) MarshalXML added in v1.0.1 

func (j JSONOutputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML - produces the xml representation of the JSONOutputOptions struct

func (*JSONOutputOptions) SetRecordDelimiter added in v1.0.1 

func (j *JSONOutputOptions) SetRecordDelimiter(val string)

SetRecordDelimiter sets the record delimiter in the JSON output options

type JSONType added in v1.0.1 

type JSONType string

JSONType determines json input serialization type. 

const (
	JSONDocumentType JSONType = "DOCUMENT"
	JSONLinesType             = "LINES"
)

Constants for JSONTypes.

type LegalHoldStatus added in v1.0.1 

type LegalHoldStatus string

LegalHoldStatus - object legal hold status. 

const (
	// LegalHoldEnabled indicates legal hold is enabled
	LegalHoldEnabled LegalHoldStatus = "ON"

	// LegalHoldDisabled indicates legal hold is disabled
	LegalHoldDisabled LegalHoldStatus = "OFF"
)

func (LegalHoldStatus) IsValid added in v1.0.1 

func (r LegalHoldStatus) IsValid() bool

IsValid - check whether this legal hold status is valid or not.

func (LegalHoldStatus) String added in v1.0.1 

func (r LegalHoldStatus) String() string

type ListBucketResult added in v1.0.1 

type ListBucketResult struct {
	// A response can contain CommonPrefixes only if you have
	// specified a delimiter.
	CommonPrefixes []CommonPrefix
	// Metadata about each object returned.
	Contents  []ObjectInfo
	Delimiter string

	// Encoding type used to encode object keys in the response.
	EncodingType string

	// A flag that indicates whether or not ListObjects returned all of the results
	// that satisfied the search criteria.
	IsTruncated bool
	Marker      string
	MaxKeys     int64
	Name        string

	// When response is truncated (the IsTruncated element value in
	// the response is true), you can use the key name in this field
	// as marker in the subsequent request to get next set of objects.
	// Object storage lists objects in alphabetical order Note: This
	// element is returned only if you have delimiter request
	// parameter specified. If response does not include the NextMaker
	// and it is truncated, you can use the value of the last Key in
	// the response as the marker in the subsequent request to get the
	// next set of object keys.
	NextMarker string
	Prefix     string
}

ListBucketResult container for listObjects response.

type ListBucketV2Result added in v1.0.1 

type ListBucketV2Result struct {
	// A response can contain CommonPrefixes only if you have
	// specified a delimiter.
	CommonPrefixes []CommonPrefix
	// Metadata about each object returned.
	Contents  []ObjectInfo
	Delimiter string

	// Encoding type used to encode object keys in the response.
	EncodingType string

	// A flag that indicates whether or not ListObjects returned all of the results
	// that satisfied the search criteria.
	IsTruncated bool
	MaxKeys     int64
	Name        string

	// Hold the token that will be sent in the next request to fetch the next group of keys
	NextContinuationToken string

	ContinuationToken string
	Prefix            string

	// FetchOwner and StartAfter are currently not used
	FetchOwner string
	StartAfter string
}

ListBucketV2Result container for listObjects response version 2.

type ListMultipartUploadsResult added in v1.0.1 

type ListMultipartUploadsResult struct {
	Bucket             string
	KeyMarker          string
	UploadIDMarker     string `xml:"UploadIdMarker"`
	NextKeyMarker      string
	NextUploadIDMarker string `xml:"NextUploadIdMarker"`
	EncodingType       string
	MaxUploads         int64
	IsTruncated        bool
	Uploads            []ObjectMultipartInfo `xml:"Upload"`
	Prefix             string
	Delimiter          string
	// A response can contain CommonPrefixes only if you specify a delimiter.
	CommonPrefixes []CommonPrefix
}

ListMultipartUploadsResult container for ListMultipartUploads response

type ListObjectPartsResult added in v1.0.1 

type ListObjectPartsResult struct {
	Bucket   string
	Key      string
	UploadID string `xml:"UploadId"`

	Initiator initiator
	Owner     owner

	StorageClass         string
	PartNumberMarker     int
	NextPartNumberMarker int
	MaxParts             int

	// Indicates whether the returned list of parts is truncated.
	IsTruncated bool
	ObjectParts []ObjectPart `xml:"Part"`

	EncodingType string
}

ListObjectPartsResult container for ListObjectParts response.

type ListObjectsOptions added in v1.0.1 

type ListObjectsOptions struct {
	// Include objects versions in the listing
	WithVersions bool
	// Include objects metadata in the listing
	WithMetadata bool
	// Only list objects with the prefix
	Prefix string
	// Ignore '/' delimiter
	Recursive bool
	// The maximum number of objects requested per
	// batch, advanced use-case not useful for most
	// applications
	MaxKeys int
	// StartAfter start listing lexically at this
	// object onwards, this value can also be set
	// for Marker when `UseV1` is set to true.
	StartAfter string

	// Use the deprecated list objects V1 API
	UseV1 bool
	// contains filtered or unexported fields
}

ListObjectsOptions holds all options of a list object request

func (*ListObjectsOptions) Set added in v1.0.1 

func (o *ListObjectsOptions) Set(key, value string)

Set adds a key value pair to the options. The key-value pair will be part of the HTTP GET request headers.

type ListVersionsResult added in v1.0.1 

type ListVersionsResult struct {
	Versions []Version

	CommonPrefixes      []CommonPrefix
	Name                string
	Prefix              string
	Delimiter           string
	MaxKeys             int64
	EncodingType        string
	IsTruncated         bool
	KeyMarker           string
	VersionIDMarker     string
	NextKeyMarker       string
	NextVersionIDMarker string
}

ListVersionsResult is an element in the list object versions response and has a special Unmarshaler because we need to preserver the order of <Version> and <DeleteMarker> in ListVersionsResult.Versions slice

func (*ListVersionsResult) UnmarshalXML added in v1.0.1 

func (l *ListVersionsResult) UnmarshalXML(d *xml.Decoder, start xml.StartElement) (err error)

UnmarshalXML is a custom unmarshal code for the response of ListObjectVersions, the custom code will unmarshal <Version> and <DeleteMarker> tags and save them in Versions field to preserve the lexical order of the listing.

type MakeBucketOptions added in v1.0.1 

type MakeBucketOptions struct {
	// Bucket location
	Region string
	// Enable object locking
	ObjectLocking bool
}

MakeBucketOptions holds all options to tweak bucket creation

type Object added in v1.0.0 

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

Object represents an open object. It implements Reader, ReaderAt, Seeker, Closer for a HTTP stream.

func (*Object) Close added in v1.0.0 

func (o *Object) Close() (err error)

Close - The behavior of Close after the first call returns error for subsequent Close() calls.

func (*Object) Read added in v1.0.0 

func (o *Object) Read(b []byte) (n int, err error)

Read reads up to len(b) bytes into b. It returns the number of bytes read (0 <= n <= len(b)) and any error encountered. Returns io.EOF upon end of file.

func (*Object) ReadAt added in v1.0.0 

func (o *Object) ReadAt(b []byte, offset int64) (n int, err error)

ReadAt reads len(b) bytes from the File starting at byte offset off. It returns the number of bytes read and the error, if any. ReadAt always returns a non-nil error when n < len(b). At end of file, that error is io.EOF.

func (*Object) Seek added in v1.0.0 

func (o *Object) Seek(offset int64, whence int) (n int64, err error)

Seek sets the offset for the next Read or Write to offset, interpreted according to whence: 0 means relative to the origin of the file, 1 means relative to the current offset, and 2 means relative to the end. Seek returns the new offset and an error, if any.

Seeking to a negative offset is an error. Seeking to any positive offset is legal, subsequent io operations succeed until the underlying object is not closed.

func (*Object) Stat added in v1.0.0 

func (o *Object) Stat() (ObjectInfo, error)

Stat returns the ObjectInfo structure describing Object.

type ObjectInfo added in v1.0.0 

type ObjectInfo struct {
	// An ETag is optionally set to md5sum of an object.  In case of multipart objects,
	// ETag is of the form MD5SUM-N where MD5SUM is md5sum of all individual md5sums of
	// each parts concatenated into one string.
	ETag string `json:"etag"`

	Key          string    `json:"name"`         // Name of the object
	LastModified time.Time `json:"lastModified"` // Date and time the object was last modified.
	Size         int64     `json:"size"`         // Size in bytes of the object.
	ContentType  string    `json:"contentType"`  // A standard MIME type describing the format of the object data.
	Expires      time.Time `json:"expires"`      // The date and time at which the object is no longer able to be cached.

	// Collection of additional metadata on the object.
	// eg: x-amz-meta-*, content-encoding etc.
	Metadata http.Header `json:"metadata" xml:"-"`

	// x-amz-meta-* headers stripped "x-amz-meta-" prefix containing the first value.
	UserMetadata StringMap `json:"userMetadata"`

	// x-amz-tagging values in their k/v values.
	UserTags map[string]string `json:"userTags"`

	// x-amz-tagging-count value
	UserTagCount int

	// Owner name.
	Owner Owner

	// ACL grant.
	Grant []struct {
		Grantee struct {
			ID          string `xml:"ID"`
			DisplayName string `xml:"DisplayName"`
			URI         string `xml:"URI"`
		} `xml:"Grantee"`
		Permission string `xml:"Permission"`
	} `xml:"Grant"`

	// The class of storage used to store the object.
	StorageClass string `json:"storageClass"`

	// Versioning related information
	IsLatest       bool
	IsDeleteMarker bool
	VersionID      string `xml:"VersionId"`

	// x-amz-replication-status value is either in one of the following states
	// - COMPLETE
	// - PENDING
	// - FAILED
	// - REPLICA (on the destination)
	ReplicationStatus string `xml:"ReplicationStatus"`

	// Lifecycle expiry-date and ruleID associated with the expiry
	// not to be confused with `Expires` HTTP header.
	Expiration       time.Time
	ExpirationRuleID string

	// Error
	Err error `json:"-"`
}

ObjectInfo container for object metadata.

func ToObjectInfo added in v1.0.1 

func ToObjectInfo(bucketName string, objectName string, h http.Header) (ObjectInfo, error)

ToObjectInfo converts http header values into ObjectInfo type, extracts metadata and fills in all the necessary fields in ObjectInfo.

type ObjectMultipartInfo added in v1.0.0 

type ObjectMultipartInfo struct {
	// Date and time at which the multipart upload was initiated.
	Initiated time.Time `type:"timestamp" timestampFormat:"iso8601"`

	Initiator initiator
	Owner     owner

	// The type of storage to use for the object. Defaults to 'STANDARD'.
	StorageClass string

	// Key of the object for which the multipart upload was initiated.
	Key string

	// Size in bytes of the object.
	Size int64

	// Upload ID that identifies the multipart upload.
	UploadID string `xml:"UploadId"`

	// Error
	Err error
}

ObjectMultipartInfo container for multipart object metadata.

type ObjectPart added in v1.0.1 

type ObjectPart struct {
	// Part number identifies the part.
	PartNumber int

	// Date and time the part was uploaded.
	LastModified time.Time

	// Entity tag returned when the part was uploaded, usually md5sum
	// of the part.
	ETag string

	// Size of the uploaded part data.
	Size int64
}

ObjectPart container for particular part of an object.

type Options added in v1.0.1 

type Options struct {
	Creds        *credentials.Credentials
	Secure       bool
	Transport    http.RoundTripper
	Region       string
	BucketLookup BucketLookupType

	// Custom hash routines. Leave nil to use standard.
	CustomMD5    func() md5simd.Hasher
	CustomSHA256 func() md5simd.Hasher
}

Options for New method

type Owner added in v1.0.1 

type Owner struct {
	DisplayName string `json:"name"`
	ID          string `json:"id"`
}

Owner name.

type ParquetInputOptions added in v1.0.1 

type ParquetInputOptions struct{}

ParquetInputOptions parquet input specific options

type PostPolicy added in v1.0.0 

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

PostPolicy - Provides strict static type conversion and validation for Amazon S3's POST policy JSON string.

func NewPostPolicy added in v1.0.0 

func NewPostPolicy() *PostPolicy

NewPostPolicy - Instantiate new post policy.

func (*PostPolicy) SetBucket added in v1.0.0 

func (p *PostPolicy) SetBucket(bucketName string) error

SetBucket - Sets bucket at which objects will be uploaded to.

func (*PostPolicy) SetCondition added in v1.0.1 

func (p *PostPolicy) SetCondition(matchType, condition, value string) error

SetCondition - Sets condition for credentials, date and algorithm

func (*PostPolicy) SetContentLengthRange added in v1.0.0 

func (p *PostPolicy) SetContentLengthRange(min, max int64) error

SetContentLengthRange - Set new min and max content length condition for all incoming uploads.

func (*PostPolicy) SetContentType added in v1.0.0 

func (p *PostPolicy) SetContentType(contentType string) error

SetContentType - Sets content-type of the object for this policy based upload.

func (*PostPolicy) SetContentTypeStartsWith added in v1.0.1 

func (p *PostPolicy) SetContentTypeStartsWith(contentTypeStartsWith string) error

SetContentTypeStartsWith - Sets what content-type of the object for this policy based upload can start with.

func (*PostPolicy) SetExpires added in v1.0.0 

func (p *PostPolicy) SetExpires(t time.Time) error

SetExpires - Sets expiration time for the new policy.

func (*PostPolicy) SetKey added in v1.0.0 

func (p *PostPolicy) SetKey(key string) error

SetKey - Sets an object name for the policy based upload.

func (*PostPolicy) SetKeyStartsWith added in v1.0.0 

func (p *PostPolicy) SetKeyStartsWith(keyStartsWith string) error

SetKeyStartsWith - Sets an object name that an policy based upload can start with.

func (*PostPolicy) SetSuccessActionRedirect added in v1.0.1 

func (p *PostPolicy) SetSuccessActionRedirect(redirect string) error

SetSuccessActionRedirect - Sets the redirect success url of the object for this policy based upload.

func (*PostPolicy) SetSuccessStatusAction added in v1.0.1 

func (p *PostPolicy) SetSuccessStatusAction(status string) error

SetSuccessStatusAction - Sets the status success code of the object for this policy based upload.

func (*PostPolicy) SetUserData added in v1.0.1 

func (p *PostPolicy) SetUserData(key string, value string) error

SetUserData - Set user data as a key/value couple. Can be retrieved through a HEAD request or an event.

func (*PostPolicy) SetUserMetadata added in v1.0.1 

func (p *PostPolicy) SetUserMetadata(key string, value string) error

SetUserMetadata - Set user metadata as a key/value couple. Can be retrieved through a HEAD request or an event.

func (PostPolicy) String added in v1.0.0 

func (p PostPolicy) String() string

String function for printing policy in json formatted string.

type ProgressMessage added in v1.0.1 

type ProgressMessage struct {
	XMLName xml.Name `xml:"Progress" json:"-"`
	StatsMessage
}

ProgressMessage is a struct for progress xml message.

type PutObjectLegalHoldOptions added in v1.0.1 

type PutObjectLegalHoldOptions struct {
	VersionID string
	Status    *LegalHoldStatus
}

PutObjectLegalHoldOptions represents options specified by user for PutObjectLegalHold call

type PutObjectOptions added in v1.0.1 

type PutObjectOptions struct {
	UserMetadata            map[string]string
	UserTags                map[string]string
	Progress                io.Reader
	ContentType             string
	ContentEncoding         string
	ContentDisposition      string
	ContentLanguage         string
	CacheControl            string
	Mode                    RetentionMode
	RetainUntilDate         time.Time
	ServerSideEncryption    encrypt.ServerSide
	NumThreads              uint
	StorageClass            string
	WebsiteRedirectLocation string
	PartSize                uint64
	LegalHold               LegalHoldStatus
	SendContentMd5          bool
	DisableMultipart        bool
	Internal                AdvancedPutOptions
}

PutObjectOptions represents options specified by user for PutObject call

func (PutObjectOptions) Header added in v1.0.1 

func (opts PutObjectOptions) Header() (header http.Header)

Header - constructs the headers from metadata entered by user in PutObjectOptions struct

type PutObjectRetentionOptions added in v1.0.1 

type PutObjectRetentionOptions struct {
	GovernanceBypass bool
	Mode             *RetentionMode
	RetainUntilDate  *time.Time
	VersionID        string
}

PutObjectRetentionOptions represents options specified by user for PutObject call

type PutObjectTaggingOptions added in v1.0.1 

type PutObjectTaggingOptions struct {
	VersionID string
}

PutObjectTaggingOptions holds an object version id to update tag(s) of a specific object version

type QueryExpressionType added in v1.0.1 

type QueryExpressionType string

QueryExpressionType - is of what syntax the expression is, this should only be SQL 

const (
	QueryExpressionTypeSQL QueryExpressionType = "SQL"
)

Constants for expression type.

type RemoveObjectError added in v1.0.1 

type RemoveObjectError struct {
	ObjectName string
	VersionID  string
	Err        error
}

RemoveObjectError - container of Multi Delete S3 API error

type RemoveObjectOptions added in v1.0.1 

type RemoveObjectOptions struct {
	GovernanceBypass bool
	VersionID        string
	Internal         AdvancedRemoveOptions
}

RemoveObjectOptions represents options specified by user for RemoveObject call

type RemoveObjectTaggingOptions added in v1.0.1 

type RemoveObjectTaggingOptions struct {
	VersionID string
}

RemoveObjectTaggingOptions holds the version id of the object to remove

type RemoveObjectsOptions added in v1.0.1 

type RemoveObjectsOptions struct {
	GovernanceBypass bool
}

RemoveObjectsOptions represents options specified by user for RemoveObjects call

type ReplicationStatus added in v1.0.1 

type ReplicationStatus string

ReplicationStatus represents replication status of object 

const (
	// ReplicationStatusPending indicates replication is pending
	ReplicationStatusPending ReplicationStatus = "PENDING"
	// ReplicationStatusComplete indicates replication completed ok
	ReplicationStatusComplete ReplicationStatus = "COMPLETE"
	// ReplicationStatusFailed indicates replication failed
	ReplicationStatusFailed ReplicationStatus = "FAILED"
	// ReplicationStatusReplica indicates object is a replica of a source
	ReplicationStatusReplica ReplicationStatus = "REPLICA"
)

func (ReplicationStatus) Empty added in v1.0.1 

func (r ReplicationStatus) Empty() bool

Empty returns true if no replication status set.

type Retention added in v1.0.1 

type Retention struct {
	Mode     RetentionMode
	Validity time.Duration
}

Retention - bucket level retention configuration.

func (Retention) IsEmpty added in v1.0.1 

func (r Retention) IsEmpty() bool

IsEmpty - returns whether retention is empty or not.

func (Retention) String added in v1.0.1 

func (r Retention) String() string

type RetentionMode added in v1.0.1 

type RetentionMode string

RetentionMode - object retention mode. 

const (
	// Governance - governance mode.
	Governance RetentionMode = "GOVERNANCE"

	// Compliance - compliance mode.
	Compliance RetentionMode = "COMPLIANCE"
)

func (RetentionMode) IsValid added in v1.0.1 

func (r RetentionMode) IsValid() bool

IsValid - check whether this retention mode is valid or not.

func (RetentionMode) String added in v1.0.1 

func (r RetentionMode) String() string

type SelectCompressionType added in v1.0.1 

type SelectCompressionType string

SelectCompressionType - is the parameter for what type of compression is present

type SelectObjectInputSerialization added in v1.0.1 

type SelectObjectInputSerialization struct {
	CompressionType SelectCompressionType
	Parquet         *ParquetInputOptions `xml:"Parquet,omitempty"`
	CSV             *CSVInputOptions     `xml:"CSV,omitempty"`
	JSON            *JSONInputOptions    `xml:"JSON,omitempty"`
}

SelectObjectInputSerialization - input serialization parameters

type SelectObjectOptions added in v1.0.1 

type SelectObjectOptions struct {
	XMLName              xml.Name           `xml:"SelectObjectContentRequest" json:"-"`
	ServerSideEncryption encrypt.ServerSide `xml:"-"`
	Expression           string
	ExpressionType       QueryExpressionType
	InputSerialization   SelectObjectInputSerialization
	OutputSerialization  SelectObjectOutputSerialization
	RequestProgress      struct {
		Enabled bool
	}
}

SelectObjectOptions - represents the input select body

func (SelectObjectOptions) Header added in v1.0.1 

func (o SelectObjectOptions) Header() http.Header

Header returns the http.Header representation of the SelectObject options.

type SelectObjectOutputSerialization added in v1.0.1 

type SelectObjectOutputSerialization struct {
	CSV  *CSVOutputOptions  `xml:"CSV,omitempty"`
	JSON *JSONOutputOptions `xml:"JSON,omitempty"`
}

SelectObjectOutputSerialization - output serialization parameters.

type SelectObjectType added in v1.0.1 

type SelectObjectType string

SelectObjectType - is the parameter which defines what type of object the operation is being performed on.

type SelectResults added in v1.0.1 

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

SelectResults is used for the streaming responses from the server.

func NewSelectResults added in v1.0.1 

func NewSelectResults(resp *http.Response, bucketName string) (*SelectResults, error)

NewSelectResults creates a Select Result parser that parses the response and returns a Reader that will return parsed and assembled select output.

func (*SelectResults) Close added in v1.0.1 

func (s *SelectResults) Close() error

Close - closes the underlying response body and the stream reader.

func (*SelectResults) Progress added in v1.0.1 

func (s *SelectResults) Progress() *ProgressMessage

Progress - information about the progress of a request.

func (*SelectResults) Read added in v1.0.1 

func (s *SelectResults) Read(b []byte) (n int, err error)

Read - is a reader compatible implementation for SelectObjectContent records.

func (*SelectResults) Stats added in v1.0.1 

func (s *SelectResults) Stats() *StatsMessage

Stats - information about a request's stats when processing is complete.

type StatObjectOptions added in v1.0.1 

type StatObjectOptions = GetObjectOptions

StatObjectOptions are used to specify additional headers or options during GET info/stat requests.

type StatsMessage added in v1.0.1 

type StatsMessage struct {
	XMLName        xml.Name `xml:"Stats" json:"-"`
	BytesScanned   int64
	BytesProcessed int64
	BytesReturned  int64
}

StatsMessage is a struct for stat xml message.

type StringMap added in v1.0.1 

type StringMap map[string]string

StringMap represents map with custom UnmarshalXML

func (*StringMap) UnmarshalXML added in v1.0.1 

func (m *StringMap) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML unmarshals the XML into a map of string to strings, creating a key in the map for each tag and setting it's value to the tags contents.

The fact this function is on the pointer of Map is important, so that if m is nil it can be initialized, which is often the case if m is nested in another xml structural. This is also why the first thing done on the first line is initialize it.

type UploadInfo added in v1.0.1 

type UploadInfo struct {
	Bucket       string
	Key          string
	ETag         string
	Size         int64
	LastModified time.Time
	Location     string
	VersionID    string

	// Lifecycle expiry-date and ruleID associated with the expiry
	// not to be confused with `Expires` HTTP header.
	Expiration       time.Time
	ExpirationRuleID string
}

UploadInfo contains information about the newly uploaded or copied object.

type ValidityUnit added in v1.0.1 

type ValidityUnit string

ValidityUnit - retention validity unit. 

const (
	// Days - denotes no. of days.
	Days ValidityUnit = "DAYS"

	// Years - denotes no. of years.
	Years ValidityUnit = "YEARS"
)

func (ValidityUnit) String added in v1.0.1 

func (unit ValidityUnit) String() string

type Version added in v1.0.1 

type Version struct {
	ETag         string
	IsLatest     bool
	Key          string
	LastModified time.Time
	Owner        Owner
	Size         int64
	StorageClass string
	VersionID    string `xml:"VersionId"`
	// contains filtered or unexported fields
}

Version is an element in the list object versions response

Source Files

View all Source files

Directories

Path Synopsis
pkg
credentials
Package credentials provides credential retrieval and management for S3 compatible object storage.
 Package credentials provides credential retrieval and management for S3 compatible object storage.
encrypt
lifecycle
Package lifecycle contains all the lifecycle related data types and marshallers.
 Package lifecycle contains all the lifecycle related data types and marshallers.
notification
policy
replication
s3utils
set
signer
sse
tags

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.