ossClient

package module
v1.15.0 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2023 License: Apache-2.0 Imports: 58 Imported by: 2

README

杭州瑞网广通公司对象存储服务SDK

此项目为杭州瑞网广通公司对象存储系统的SDK

此项目基于MinIO开发，使用请遵守MinIO相关开源协议

操作存储桶
操作文件对象
操作对象

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 (
	MergeDir   = ".internal.merge.objects/"
	IdxPrefix  = ".idx."
	DataPrefix = ".data."
)
View Source 
const (
	PartialUpdateInsertMode  = "Insert"
	PartialUpdateReplaceMode = "Replace"
)

trinet

View Source 
const (
	// TierStandard is the standard retrieval tier
	TierStandard = TierType("Standard")
	// TierBulk is the bulk retrieval tier
	TierBulk = TierType("Bulk")
	// TierExpedited is the expedited retrieval tier
	TierExpedited = TierType("Expedited")
)
View Source 
const (

	/* trinet */
	MinIOPartialUpdateMode       = "X-Minio-Partial-Update-Mode"
	MinIOPartialUpdateOffset     = "X-Minio-Partial-Update-Offset"
	AmzSnowballExtract           = "X-Amz-Meta-Snowball-Auto-Extract"
	MinIOSnowballIgnoreDirs      = "X-Amz-Meta-Minio-Snowball-Ignore-Dirs"
	MinIOMergeMultipart          = "X-Minio-Merge-Multipart"
	MinIOPoolEngine              = "X-Minio-Pool-Engine"
	MinIODelBucketParallelDrives = "X-Minio-Del-Bucket-Parallel-Drives"
	MinIODelPrefixParallelDrives = "X-Minio-Del-Prefix-Parallel-Drives"
)
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

View Source 
const (
	// RestoreSelect represents the restore SELECT operation
	RestoreSelect = RestoreType("SELECT")
)

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 := os.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 IsNetworkOrHostDown 

func IsNetworkOrHostDown(err error, expectTimeouts bool) bool

IsNetworkOrHostDown - if there was a network error or if the host is down. expectTimeouts indicates that *context* timeouts are expected and does not indicate a downed host. Other timeouts still returns down.

func OptimalPartInfo 

func OptimalPartInfo(objectSize int64, configuredPartSize uint64) (totalPartsCount int, partSize, 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 AccessControlList 

type AccessControlList struct {
	XMLName    xml.Name `xml:"AccessControlList"`
	Grant      []Grant
	Permission string `xml:"Permission"`
}

AccessControlList contains the set of grantees and the permissions assigned to each grantee.

type AdvancedDeleteBucketOptions added in v1.10.0 

type AdvancedDeleteBucketOptions struct {
	ParallelDrives int // maximum number of parallelism
}

type AdvancedGetOptions 

type AdvancedGetOptions struct {
	ReplicationDeleteMarker           bool
	IsReplicationReadyForDeleteMarker bool
	ReplicationProxyRequest           string
}

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

type AdvancedPutOptions 

type AdvancedPutOptions struct {
	SourceVersionID          string
	SourceETag               string
	ReplicationStatus        ReplicationStatus
	SourceMTime              time.Time
	ReplicationRequest       bool
	RetentionTimestamp       time.Time
	TaggingTimestamp         time.Time
	LegalholdTimestamp       time.Time
	ReplicationValidityCheck bool
}

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

type AdvancedRemoveOptions 

type AdvancedRemoveOptions struct {
	ReplicationDeleteMarker  bool
	ReplicationStatus        ReplicationStatus
	ReplicationMTime         time.Time
	ReplicationRequest       bool
	ReplicationValidityCheck bool // check permissions
	/* trinet */
	DeletePrefixParallelDrives int // maximum number of parallelism

}

AdvancedRemoveOptions intended for internal use by replication

type BucketInfo 

type BucketInfo struct {
	// The name of the bucket.
	Name string `json:"name"`
	// Date the bucket was created.
	CreationDate time.Time `json:"creationDate"`
	/* trinet */
	RecycleEnabled    bool   `json:"recycleEnabled"`
	Size              uint64 `json:"size"`
	ObjectsCount      uint64 `json:"objectsCount"`
	ObjectLockEnabled string `json:"objectLockEnabled"`
	VersioningStatus  string `json:"versioningStatus"`
}

BucketInfo container for bucket metadata.

type BucketLookupType 

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 BucketOptions deprecated 

type BucketOptions = RemoveBucketOptions

Deprecated: BucketOptions will be renamed to RemoveBucketOptions in future versions.

type BucketVersioningConfiguration 

type BucketVersioningConfiguration struct {
	XMLName   xml.Name `xml:"VersioningConfiguration"`
	Status    string   `xml:"Status"`
	MFADelete string   `xml:"MfaDelete,omitempty"`
	// MinIO extension - allows selective, prefix-level versioning exclusion.
	// Requires versioning to be enabled
	ExcludedPrefixes []ExcludedPrefix `xml:",omitempty"`
	ExcludeFolders   bool             `xml:",omitempty"`
}

BucketVersioningConfiguration is the versioning configuration structure

func (BucketVersioningConfiguration) Enabled 

func (b BucketVersioningConfiguration) Enabled() bool

Enabled returns true if bucket versioning is enabled

func (BucketVersioningConfiguration) Suspended 

func (b BucketVersioningConfiguration) Suspended() bool

Suspended returns true if bucket versioning is suspended

type CSVFileHeaderInfo 

type CSVFileHeaderInfo string

CSVFileHeaderInfo - is the parameter for whether to utilize headers. 

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

Constants for file header info.

type CSVInputOptions 

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 

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 

func (c *CSVInputOptions) SetComments(val string)

SetComments sets the comments character in the CSV input options

func (*CSVInputOptions) SetFieldDelimiter 

func (c *CSVInputOptions) SetFieldDelimiter(val string)

SetFieldDelimiter sets the field delimiter in the CSV input options

func (*CSVInputOptions) SetFileHeaderInfo 

func (c *CSVInputOptions) SetFileHeaderInfo(val CSVFileHeaderInfo)

SetFileHeaderInfo sets the file header info in the CSV input options

func (*CSVInputOptions) SetQuoteCharacter 

func (c *CSVInputOptions) SetQuoteCharacter(val string)

SetQuoteCharacter sets the quote character in the CSV input options

func (*CSVInputOptions) SetQuoteEscapeCharacter 

func (c *CSVInputOptions) SetQuoteEscapeCharacter(val string)

SetQuoteEscapeCharacter sets the quote escape character in the CSV input options

func (*CSVInputOptions) SetRecordDelimiter 

func (c *CSVInputOptions) SetRecordDelimiter(val string)

SetRecordDelimiter sets the record delimiter in the CSV input options

type CSVOutputOptions 

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 

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

MarshalXML - produces the xml representation of the CSVOutputOptions struct

func (*CSVOutputOptions) SetFieldDelimiter 

func (c *CSVOutputOptions) SetFieldDelimiter(val string)

SetFieldDelimiter sets the field delimiter character in the CSV output options

func (*CSVOutputOptions) SetQuoteCharacter 

func (c *CSVOutputOptions) SetQuoteCharacter(val string)

SetQuoteCharacter sets the quote character in the CSV output options

func (*CSVOutputOptions) SetQuoteEscapeCharacter 

func (c *CSVOutputOptions) SetQuoteEscapeCharacter(val string)

SetQuoteEscapeCharacter sets the quote escape character in the CSV output options

func (*CSVOutputOptions) SetQuoteFields 

func (c *CSVOutputOptions) SetQuoteFields(val CSVQuoteFields)

SetQuoteFields sets the quote field parameter in the CSV output options

func (*CSVOutputOptions) SetRecordDelimiter 

func (c *CSVOutputOptions) SetRecordDelimiter(val string)

SetRecordDelimiter sets the record delimiter character in the CSV output options

type CSVQuoteFields 

type CSVQuoteFields string

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

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

Constants for csv quote styles.

type Checksum added in v1.13.0 

type Checksum struct {
	Type ChecksumType
	// contains filtered or unexported fields
}

Checksum is a type and encoded value.

func NewChecksum added in v1.13.0 

func NewChecksum(t ChecksumType, b []byte) Checksum

NewChecksum sets the checksum to the value of b, which is the raw hash output. If the length of c does not match t.RawByteLen, a checksum with ChecksumNone is returned.

func NewChecksumString added in v1.13.0 

func NewChecksumString(t ChecksumType, s string) Checksum

NewChecksumString sets the checksum to the value of s, which is the base 64 encoded raw hash output. If the length of c does not match t.RawByteLen, it is not added.

func (Checksum) Encoded added in v1.13.0 

func (c Checksum) Encoded() string

Encoded returns the encoded value. Returns the empty string if not set or valid.

func (Checksum) IsSet added in v1.13.0 

func (c Checksum) IsSet() bool

IsSet returns whether the checksum is valid and known.

func (Checksum) Raw added in v1.13.0 

func (c Checksum) Raw() []byte

Raw returns the raw checksum value if set.

type ChecksumType added in v1.13.0 

type ChecksumType uint32

ChecksumType contains information about the checksum type. 

const (

	// ChecksumSHA256 indicates a SHA256 checksum.
	ChecksumSHA256 ChecksumType = 1 << iota
	// ChecksumSHA1 indicates a SHA-1 checksum.
	ChecksumSHA1
	// ChecksumCRC32 indicates a CRC32 checksum with IEEE table.
	ChecksumCRC32
	// ChecksumCRC32C indicates a CRC32 checksum with Castagnoli table.
	ChecksumCRC32C

	// ChecksumNone indicates no checksum.
	ChecksumNone ChecksumType = 0
)

func (ChecksumType) ChecksumBytes added in v1.13.0 

func (c ChecksumType) ChecksumBytes(b []byte) Checksum

ChecksumBytes returns a checksum of the content b with type c.

func (ChecksumType) ChecksumReader added in v1.13.0 

func (c ChecksumType) ChecksumReader(r io.Reader) (Checksum, error)

ChecksumReader reads all of r and returns a checksum of type c. Returns any error that may have occurred while reading.

func (ChecksumType) Hasher added in v1.13.0 

func (c ChecksumType) Hasher() hash.Hash

Hasher returns a hasher corresponding to the checksum type. Returns nil if no checksum.

func (ChecksumType) Is added in v1.13.0 

func (c ChecksumType) Is(t ChecksumType) bool

Is returns if c is all of t.

func (ChecksumType) IsSet added in v1.13.0 

func (c ChecksumType) IsSet() bool

IsSet returns whether the type is valid and known.

func (ChecksumType) Key added in v1.13.0 

func (c ChecksumType) Key() string

Key returns the header key. returns empty string if invalid or none.

func (ChecksumType) RawByteLen added in v1.13.0 

func (c ChecksumType) RawByteLen() int

RawByteLen returns the size of the un-encoded checksum.

func (ChecksumType) String added in v1.13.0 

func (c ChecksumType) String() string

String returns the type as a string. CRC32, CRC32C, SHA1, and SHA256 for valid values. Empty string for unset and "<invalid>" if not valid.

type Client 

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) AppendObject added in v1.9.0 

func (c *Client) AppendObject(ctx context.Context, bucketName, objectName string, reader io.Reader, objectSize int64) (UploadInfo, error)

func (*Client) BucketExists 

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) CheckBucketReplication added in v1.14.0 

func (c *Client) CheckBucketReplication(ctx context.Context, bucketName string) (err error)

CheckBucketReplication validates if replication is set up properly for a bucket

func (*Client) ComposeObject 

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 

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

CopyObject - copy a source object into a new object

func (*Client) DeleteMergeID 

func (c *Client) DeleteMergeID(ctx context.Context, id, bucketName string) error

func (*Client) DeleteObjectWithId 

func (c *Client) DeleteObjectWithId(ctx context.Context, id, bucketName, objectName string) error

func (*Client) EnableVersioning 

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

EnableVersioning - enable object versioning in given bucket.

func (*Client) EndpointURL 

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

EndpointURL returns the URL of the S3 endpoint.

func (*Client) ExtractOnline 

func (c *Client) ExtractOnline(ctx context.Context, bucketName string, reader io.Reader, objectSize int64, ignoreDirs bool,
) (info UploadInfo, err error)

trinet

func (*Client) FGetObject 

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 

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) GetBucketDetailInfo added in v1.8.0 

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

GetBucketDetailInfo get the bucket creat time size and object count

func (*Client) GetBucketEncryption 

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 

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

GetBucketLifecycle fetch bucket lifecycle configuration

func (*Client) GetBucketLifecycleWithInfo added in v1.13.0 

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

GetBucketLifecycleWithInfo fetch bucket lifecycle configuration along with when it was last updated

func (*Client) GetBucketLocation 

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 

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

GetBucketNotification returns current bucket notification configuration

func (*Client) GetBucketObjectLockConfig 

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 

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

GetBucketPolicy returns the current policy

func (*Client) GetBucketReplication 

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 

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

GetBucketReplicationMetrics fetches bucket replication status metrics

func (*Client) GetBucketReplicationMetricsV2 added in v1.14.0 

func (c *Client) GetBucketReplicationMetricsV2(ctx context.Context, bucketName string) (s replication.MetricsV2, err error)

GetBucketReplicationMetricsV2 fetches bucket replication status metrics

func (*Client) GetBucketReplicationResyncStatus 

func (c *Client) GetBucketReplicationResyncStatus(ctx context.Context, bucketName, arn string) (rinfo replication.ResyncTargetsInfo, err error)

GetBucketReplicationResyncStatus gets the status of replication resync

func (*Client) GetBucketTagging 

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 

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) GetMergeObjectTagging 

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

func (*Client) GetObject 

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 

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

GetObjectACL get object ACLs

func (*Client) GetObjectIndexInfo 

func (c *Client) GetObjectIndexInfo(ctx context.Context, id, bucketName string) (*ObjectIndexInfo, error)

func (*Client) GetObjectLegalHold 

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 

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 

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 

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) GetObjectWithID 

func (c *Client) GetObjectWithID(ctx context.Context, id, bucketName, objectName string) (*Object, *ObjectIndexInfo, error)

func (*Client) GetObjectWithIndex 

func (c *Client) GetObjectWithIndex(ctx context.Context, id, bucketName, objectName string, meta *ObjectIndexInfo) (*Object, error)

func (*Client) HealthCheck 

func (c *Client) HealthCheck(hcDuration time.Duration) (context.CancelFunc, error)

HealthCheck starts a healthcheck to see if endpoint is up. Returns a context cancellation function, to stop the health check, and an error if health check is already started.

func (*Client) InitMergePartUpload 

func (c *Client) InitMergePartUpload(id, bucketName string) (*PutObjectMerge, error)

func (*Client) IsOffline 

func (c *Client) IsOffline() bool

IsOffline returns true if healthcheck enabled and client is offline If HealthCheck function has not been called this will always return false.

func (*Client) IsOnline 

func (c *Client) IsOnline() bool

IsOnline returns true if healthcheck enabled and client is online. If HealthCheck function has not been called this will always return true.

func (*Client) ListBuckets 

func (c *Client) ListBuckets(ctx context.Context, listRecycle bool) ([]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 

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 

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)
}

If caller cancels the context, then the last entry on the 'chan ObjectInfo' will be the context.Error() caller must drain the channel entirely and wait until channel is closed before proceeding, without waiting on the channel to be closed completely you might leak goroutines.

func (*Client) ListenBucketNotification 

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 

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 

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) NewUploadID 

func (c *Client) NewUploadID(ctx context.Context, bucketName, objectName string, opts *PutObjectOptions) (*MultipartUploader, error)

getUploadID - fetch upload id if already present for an object name or initiate a new request to fetch a new upload id.

func (*Client) Presign 

func (c *Client) Presign(ctx context.Context, method, bucketName, 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 and extra signed headers. URL can have a maximum expiry of upto 7days or a minimum of 1sec.

func (*Client) PresignHeader 

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

PresignHeader - similar to Presign() but allows including HTTP headers that will be used to build the signature. The request using the resulting URL will need to have the exact same headers to be added for signature validation to pass.

FIXME: The extra header parameter should be included in Presign() in the next major version bump, and this function should then be deprecated.

func (*Client) PresignedGetObject 

func (c *Client) PresignedGetObject(ctx context.Context, bucketName, 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 

func (c *Client) PresignedHeadObject(ctx context.Context, bucketName, 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 

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 

func (c *Client) PresignedPutObject(ctx context.Context, bucketName, 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) PutMergeObjectTagging 

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

func (*Client) PutObject 

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 16MiB PutObject automatically does a single atomic PUT operation.

  • For size larger than 16MiB PutObject automatically does a multipart upload 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.

    WARNING: Passing down '-1' will use memory and these cannot be reused for best outcomes for PutObject(), pass the size always.

NOTE: Upon errors during upload multipart operation is entirely aborted.

func (*Client) PutObjectFanOut added in v1.13.0 

func (c *Client) PutObjectFanOut(ctx context.Context, bucket string, fanOutData io.Reader, fanOutReq PutObjectFanOutRequest) ([]PutObjectFanOutResponse, error)

PutObjectFanOut - is a variant of PutObject instead of writing a single object from a single stream multiple objects are written, defined via a list of PutObjectFanOutRequests. Each entry in PutObjectFanOutRequest carries an object keyname and its relevant metadata if any. `Key` is mandatory, rest of the other options in PutObjectFanOutRequest are optional.

func (*Client) PutObjectLegalHold 

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 

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 

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) PutObjectsSnowball 

func (c Client) PutObjectsSnowball(ctx context.Context, bucketName string, opts SnowballOptions, objs <-chan SnowballObject) (err error)

PutObjectsSnowball will put multiple objects with a single put call. A (compressed) TAR file will be created which will contain multiple objects. The key for each object will be used for the destination in the specified bucket. Total size should be < 5TB. This function blocks until 'objs' is closed and the content has been uploaded.

func (*Client) RecycleBucket 

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

RecycleBucket recycle the bucket

func (*Client) RemoveAllBucketNotification 

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

RemoveAllBucketNotification - Remove bucket notification clears all previously specified config

func (*Client) RemoveBucket 

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 

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 

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

RemoveBucketReplication removes a replication config on an existing bucket.

func (*Client) RemoveBucketTagging 

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) RemoveBucketWithOptions 

func (c *Client) RemoveBucketWithOptions(ctx context.Context, bucketName string, opts RemoveBucketOptions) error

RemoveBucketWithOptions deletes the bucket name.

All objects (including all object versions and delete markers) in the bucket will be deleted forcibly if bucket options set ForceDelete to 'true'.

func (*Client) RemoveIncompleteUpload 

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

RemoveIncompleteUpload aborts an partially uploaded object.

func (*Client) RemoveMergeObjectTagging 

func (c *Client) RemoveMergeObjectTagging(ctx context.Context, bucketName, id string, opts RemoveObjectTaggingOptions) error

func (*Client) RemoveObject 

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

RemoveObject removes an object from a bucket.

func (*Client) RemoveObjectTagging 

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 

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) RemoveObjectsWithResult 

func (c *Client) RemoveObjectsWithResult(ctx context.Context, bucketName string, objectsCh <-chan ObjectInfo, opts RemoveObjectsOptions) <-chan RemoveObjectResult

RemoveObjectsWithResult removes multiple objects from a bucket while it is possible to specify objects versions which are received from objectsCh. Remove results, successes and failures are sent back via RemoveObjectResult channel

func (*Client) ResetBucketReplication 

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

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

func (*Client) ResetBucketReplicationOnTarget 

func (c *Client) ResetBucketReplicationOnTarget(ctx context.Context, bucketName string, olderThan time.Duration, tgtArn string) (replication.ResyncTargetsInfo, error)

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

func (*Client) RestoreObject 

func (c *Client) RestoreObject(ctx context.Context, bucketName, objectName, versionID string, req RestoreRequest) error

RestoreObject is a implementation of https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html AWS S3 API

func (*Client) SelectObjectContent 

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 

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

SetAppInfo - add application details to user agent.

func (*Client) SetBucketEncryption 

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 

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

SetBucketLifecycle set the lifecycle on an existing bucket.

func (*Client) SetBucketNotification 

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 

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 

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

SetBucketPolicy sets the access permissions on an existing bucket.

func (*Client) SetBucketReplication 

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 

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 

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

SetBucketVersioning sets a bucket versioning configuration

func (*Client) SetObjectLockConfig 

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 

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 

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

StatObject verifies if object exists, you have permission to access it and returns information about the object.

func (*Client) SuspendVersioning 

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

SuspendVersioning - suspend object versioning in given bucket.

func (*Client) TraceErrorsOnlyOff 

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 

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

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

func (*Client) TraceOff 

func (c *Client) TraceOff()

TraceOff - disable HTTP tracing.

func (*Client) TraceOn 

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

TraceOn - enable HTTP tracing.

func (*Client) UpdateObject 

func (c *Client) UpdateObject(ctx context.Context, bucketName, objectName string, updateMod string, updateOffset int,
	reader io.Reader, objectSize int64) (UploadInfo, error)

type CommonPrefix 

type CommonPrefix struct {
	Prefix string
}

CommonPrefix container for prefix response.

type CompletePart 

type CompletePart struct {
	// Part number identifies the part.
	PartNumber int
	ETag       string

	// Checksum values
	ChecksumCRC32  string `xml:"ChecksumCRC32,omitempty"`
	ChecksumCRC32C string `xml:"ChecksumCRC32C,omitempty"`
	ChecksumSHA1   string `xml:"ChecksumSHA1,omitempty"`
	ChecksumSHA256 string `xml:"ChecksumSHA256,omitempty"`
}

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

type CopyDestOptions 

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 

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

Marshal converts all the CopyDestOptions into their equivalent HTTP header representation

type CopySrcOptions 

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 

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

Marshal converts all the CopySrcOptions into their equivalent HTTP header representation

type Core 

type Core struct {
	*Client
}

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

func NewCore 

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 

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

AbortMultipartUpload - Abort an incomplete upload.

func (Core) CompleteMultipartUpload 

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

CompleteMultipartUpload - Concatenate uploaded parts and commit to an object.

func (Core) CopyObject 

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 

func (c Core) CopyObjectPart(ctx context.Context, srcBucket, srcObject, destBucket, destObject, 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 

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

GetBucketPolicy - fetches bucket access policy for a given bucket.

func (Core) GetObject 

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 

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 

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

ListObjectParts - List uploaded parts of an incomplete upload.x

func (Core) ListObjects 

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 

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 

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 

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 

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 

func (c Core) PutObjectPart(ctx context.Context, bucket, object, uploadID string, partID int,
	data io.Reader, size int64, opts PutObjectPartOptions,
) (ObjectPart, error)

PutObjectPart - Upload an object part.

type Encryption 

type Encryption struct {
	EncryptionType string
	KMSContext     string
	KMSKeyID       string `xml:"KMSKeyId"`
}

Encryption contains the type of server-side encryption used during object retrieval

type ErasurePoolEngine added in v1.10.0 

type ErasurePoolEngine string
const (
	DefaultEngine ErasurePoolEngine = ""
	HDD           ErasurePoolEngine = "HDD"
	SSD           ErasurePoolEngine = "SSD"
)

type ErrorResponse 

type ErrorResponse struct {
	XMLName    xml.Name `xml:"Error" json:"-"`
	Code       string
	Message    string
	BucketName string
	Key        string
	Resource   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 ExcludedPrefix 

type ExcludedPrefix struct {
	Prefix string
}

ExcludedPrefix - holds individual prefixes excluded from being versioned.

type GetObjectLegalHoldOptions 

type GetObjectLegalHoldOptions struct {
	VersionID string
}

GetObjectLegalHoldOptions represents options specified by user for GetObjectLegalHold call

type GetObjectOptions 

type GetObjectOptions struct {
	ServerSideEncryption encrypt.ServerSide
	VersionID            string
	PartNumber           int

	// Include any checksums, if object was uploaded with checksum.
	// For multipart objects this is a checksum of part checksums.
	// https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
	Checksum bool

	// 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) AddReqParam added in v1.10.0 

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

AddReqParam - add request query string parameter supported key: see supportedQueryValues. If an unsupported key is passed in, it will be ignored and nothing will be done.

func (GetObjectOptions) Header 

func (o GetObjectOptions) Header() http.Header

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

func (*GetObjectOptions) Set 

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 

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

SetMatchETag - set match etag.

func (*GetObjectOptions) SetMatchETagExcept 

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

SetMatchETagExcept - set match etag except.

func (*GetObjectOptions) SetModified 

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

SetModified - set modified time since.

func (*GetObjectOptions) SetRange 

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) SetReqParam added in v1.10.0 

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

SetReqParam - set request query string parameter supported key: see supportedQueryValues. If an unsupported key is passed in, it will be ignored and nothing will be done.

func (*GetObjectOptions) SetUnmodified 

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

SetUnmodified - set unmodified time since.

type GetObjectTaggingOptions 

type GetObjectTaggingOptions struct {
	VersionID string
}

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

type GlacierJobParameters 

type GlacierJobParameters struct {
	Tier TierType
}

GlacierJobParameters represents the retrieval tier parameter

type Grant 

type Grant struct {
	XMLName    xml.Name `xml:"Grant"`
	Grantee    Grantee
	Permission string `xml:"Permission"`
}

Grant holds grant information

type Grantee 

type Grantee struct {
	XMLName     xml.Name `xml:"Grantee"`
	ID          string   `xml:"ID"`
	DisplayName string   `xml:"DisplayName"`
	URI         string   `xml:"URI"`
}

Grantee represents the person being granted permissions.

type JSONInputOptions 

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

JSONInputOptions json input specific options

func (JSONInputOptions) MarshalXML 

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

MarshalXML - produces the xml representation of the JSONInputOptions struct

func (*JSONInputOptions) SetType 

func (j *JSONInputOptions) SetType(typ JSONType)

SetType sets the JSON type in the JSON input options

type JSONOutputOptions 

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

JSONOutputOptions - json output specific options

func (JSONOutputOptions) MarshalXML 

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

MarshalXML - produces the xml representation of the JSONOutputOptions struct

func (*JSONOutputOptions) SetRecordDelimiter 

func (j *JSONOutputOptions) SetRecordDelimiter(val string)

SetRecordDelimiter sets the record delimiter in the JSON output options

type JSONType 

type JSONType string

JSONType determines json input serialization type. 

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

Constants for JSONTypes.

type LegalHoldStatus 

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 

func (r LegalHoldStatus) IsValid() bool

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

func (LegalHoldStatus) String 

func (r LegalHoldStatus) String() string

type ListBucketResult 

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 

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 

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 

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 

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 

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 

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 

func (l *ListVersionsResult) UnmarshalXML(d *xml.Decoder, _ 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 

type MakeBucketOptions struct {
	// Bucket location
	Region string
	// Enable object locking
	ObjectLocking bool
	/* trinet :recycle bucket */
	RecycleEnabled bool
	PublicAccess   bool // Access Policy
	ForceCreate    bool // Create buckets even if they are already created.

}

MakeBucketOptions holds all options to tweak bucket creation

type MetadataEntry 

type MetadataEntry struct {
	Name  string
	Value string
}

MetadataEntry represents a metadata information of the restored object.

type MultipartUploader 

type MultipartUploader struct {
	BucketName string
	ObjectName string
	UploadID   string
	// contains filtered or unexported fields
}

func (*MultipartUploader) AbortMultipartUpload 

func (m *MultipartUploader) AbortMultipartUpload(ctx context.Context) error

AbortMultipartUpload aborts a multipart upload for the given uploadID, all previously uploaded parts are deleted.

func (*MultipartUploader) CompleteMultipartUpload 

func (m *MultipartUploader) CompleteMultipartUpload(ctx context.Context) (UploadInfo, error)

CompleteMultipartUpload - Completes a multipart upload by assembling previously uploaded parts.

func (*MultipartUploader) GetPart 

func (m *MultipartUploader) GetPart(ctx context.Context, partNumber int) (io.ReadCloser, ObjectInfo, error)

func (*MultipartUploader) UpdatePart 

func (m *MultipartUploader) UpdatePart(ctx context.Context, data io.Reader, partNumber int, configuredPartSize int) error

UpdatePart - Update the uploaded part.

func (*MultipartUploader) UploadPart 

func (m *MultipartUploader) UploadPart(ctx context.Context, data io.Reader, partNumber int) error

UploadPart - Uploads a part in a multipart upload.

type Object 

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 

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

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

func (*Object) Read 

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 

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 

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 

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

Stat returns the ObjectInfo structure describing Object.

type ObjectIndex 

type ObjectIndex struct {
	Valid  bool  `json:"valid"`
	Offset int64 `json:"offset"`
	Size   int64 `json:"size"`
}

type ObjectIndexInfo 

type ObjectIndexInfo struct {
	VacancySize int64                   `json:"vacancySize"`
	TotalSize   int64                   `json:"totalSize"`
	ObjectNum   int                     `json:"objectNum"`
	Info        map[string]*ObjectIndex `json:"objInfo"`
}

type ObjectInfo 

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.
	// Only returned by MinIO servers.
	UserMetadata StringMap `json:"userMetadata,omitempty"`

	// x-amz-tagging values in their k/v values.
	// Only returned by MinIO servers.
	UserTags URLMap `json:"userTags,omitempty" xml:"UserTags"`

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

	// Owner name.
	Owner Owner

	// ACL grant.
	Grant []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
	// - COMPLETED
	// - PENDING
	// - FAILED
	// - REPLICA (on the destination)
	ReplicationStatus string `xml:"ReplicationStatus"`
	// set to true if delete marker has backing object version on target, and eligible to replicate
	ReplicationReady bool
	// Lifecycle expiry-date and ruleID associated with the expiry
	// not to be confused with `Expires` HTTP header.
	Expiration       time.Time
	ExpirationRuleID string

	Restore *RestoreInfo
	/*trinet*/
	TransitionedObjName string
	TransitionTier      string
	TransitionStatus    string

	// Checksum values
	ChecksumCRC32  string
	ChecksumCRC32C string
	ChecksumSHA1   string
	ChecksumSHA256 string

	Internal *struct {
		K int // Data blocks
		M int // Parity blocks
	} `xml:"Internal"`

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

ObjectInfo container for object metadata.

func ToObjectInfo 

func ToObjectInfo(bucketName, 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 

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 

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

	// Checksum values of each part.
	ChecksumCRC32  string
	ChecksumCRC32C string
	ChecksumSHA1   string
	ChecksumSHA256 string
}

ObjectPart container for particular part of an object.

type Options 

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

	// Allows setting a custom region lookup based on URL pattern
	// not all URL patterns are covered by this library so if you
	// have a custom endpoints with many regions you can use this
	// function to perform region lookups appropriately.
	CustomRegionViaURL func(u url.URL) string

	// TrailingHeaders indicates server support of trailing headers.
	// Only supported for v4 signatures.
	TrailingHeaders bool

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

Options for New method

type OutputLocation 

type OutputLocation struct {
	XMLName xml.Name `xml:"OutputLocation"`
	S3      S3       `xml:"S3"`
}

OutputLocation holds properties of the copy of the archived object

type Owner 

type Owner struct {
	XMLName     xml.Name `xml:"Owner" json:"owner"`
	DisplayName string   `xml:"ID" json:"name"`
	ID          string   `xml:"DisplayName" json:"id"`
}

Owner name.

type ParquetInputOptions 

type ParquetInputOptions struct{}

ParquetInputOptions parquet input specific options

type PartialUpdateInfo added in v1.4.0 

type PartialUpdateInfo struct {
	UpdateMode   string
	UpdateOffset string
}

type PostPolicy 

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 

func NewPostPolicy() *PostPolicy

NewPostPolicy - Instantiate new post policy.

func (*PostPolicy) SetBucket 

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

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

func (*PostPolicy) SetChecksum added in v1.13.0 

func (p *PostPolicy) SetChecksum(c Checksum)

SetChecksum sets the checksum of the request.

func (*PostPolicy) SetCondition 

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

SetCondition - Sets condition for credentials, date and algorithm

func (*PostPolicy) SetContentLengthRange 

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

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

func (*PostPolicy) SetContentType 

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

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

func (*PostPolicy) SetContentTypeStartsWith 

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

SetContentTypeStartsWith - Sets what content-type of the object for this policy based upload can start with. Can use an empty value ("") to allow any content-type.

func (*PostPolicy) SetEncryption added in v1.13.0 

func (p *PostPolicy) SetEncryption(sse encrypt.ServerSide)

SetEncryption - sets encryption headers for POST API

func (*PostPolicy) SetExpires 

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

SetExpires - Sets expiration time for the new policy.

func (*PostPolicy) SetKey 

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

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

func (*PostPolicy) SetKeyStartsWith 

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

SetKeyStartsWith - Sets an object name that an policy based upload can start with. Can use an empty value ("") to allow any key.

func (*PostPolicy) SetSuccessActionRedirect 

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

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

func (*PostPolicy) SetSuccessStatusAction 

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

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

func (*PostPolicy) SetUserData 

func (p *PostPolicy) SetUserData(key, 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 

func (p *PostPolicy) SetUserMetadata(key, 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 

func (p PostPolicy) String() string

String function for printing policy in json formatted string.

type ProgressMessage 

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

ProgressMessage is a struct for progress xml message.

type PutObjectFanOutEntry added in v1.13.0 

type PutObjectFanOutEntry struct {
	Key                string            `json:"key"`
	UserMetadata       map[string]string `json:"metadata,omitempty"`
	UserTags           map[string]string `json:"tags,omitempty"`
	ContentType        string            `json:"contentType,omitempty"`
	ContentEncoding    string            `json:"contentEncoding,omitempty"`
	ContentDisposition string            `json:"contentDisposition,omitempty"`
	ContentLanguage    string            `json:"contentLanguage,omitempty"`
	CacheControl       string            `json:"cacheControl,omitempty"`
	Retention          RetentionMode     `json:"retention,omitempty"`
	RetainUntilDate    *time.Time        `json:"retainUntil,omitempty"`
}

PutObjectFanOutEntry is per object entry fan-out metadata

type PutObjectFanOutRequest added in v1.13.0 

type PutObjectFanOutRequest struct {
	Entries  []PutObjectFanOutEntry
	Checksum Checksum
	SSE      encrypt.ServerSide
}

PutObjectFanOutRequest this is the request structure sent to the server to fan-out the stream to multiple objects.

type PutObjectFanOutResponse added in v1.13.0 

type PutObjectFanOutResponse struct {
	Key          string     `json:"key"`
	ETag         string     `json:"etag,omitempty"`
	VersionID    string     `json:"versionId,omitempty"`
	LastModified *time.Time `json:"lastModified,omitempty"`
	Error        string     `json:"error,omitempty"`
}

PutObjectFanOutResponse this is the response structure sent by the server upon success or failure for each object fan-out keys. Additionally, this response carries ETag, VersionID and LastModified for each object fan-out.

type PutObjectLegalHoldOptions 

type PutObjectLegalHoldOptions struct {
	VersionID string
	Status    *LegalHoldStatus
}

PutObjectLegalHoldOptions represents options specified by user for PutObjectLegalHold call

type PutObjectMerge 

type PutObjectMerge struct {
	ID string
	// contains filtered or unexported fields
}

func (*PutObjectMerge) CompleteMergePartUpload 

func (p *PutObjectMerge) CompleteMergePartUpload(ctx context.Context) error

func (*PutObjectMerge) UploadMergePart 

func (p *PutObjectMerge) UploadMergePart(objectName string, reader io.Reader) (*ObjectIndexInfo, error)

type PutObjectMergeReader 

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

func (*PutObjectMergeReader) Read 

func (r *PutObjectMergeReader) Read(buf []byte) (int, error)

type PutObjectOptions 

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
	DisableContentSha256    bool
	DisableMultipart        bool

	// ConcurrentStreamParts will create NumThreads buffers of PartSize bytes,
	// fill them serially and upload them in parallel.
	// This can be used for faster uploads on non-seekable or slow-to-seek input.
	ConcurrentStreamParts bool

	/* trinet */
	MergeMultipart          bool              // merge all parts in CompleteMultipartUpload and trans to a normal object
	PartialUpdateInfo       PartialUpdateInfo // partial update
	AppendMode              bool              // append write, and PartialUpdateInfo parameters conflict
	PreferredEnginePool     ErasurePoolEngine // the user can choose which engine's pool to save data to
	AmzSnowballExtract      bool              // online extract
	MinIOSnowballIgnoreDirs bool              // ignore dirs when extract upload

	Internal AdvancedPutOptions
	// contains filtered or unexported fields
}

PutObjectOptions represents options specified by user for PutObject call

func (PutObjectOptions) Header 

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

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

func (*PutObjectOptions) SetMatchETag added in v1.10.0 

func (opts *PutObjectOptions) SetMatchETag(etag string)

SetMatchETag if etag matches while PUT MinIO returns an error this is a MinIO specific extension to support optimistic locking semantics.

func (*PutObjectOptions) SetMatchETagExcept added in v1.10.0 

func (opts *PutObjectOptions) SetMatchETagExcept(etag string)

SetMatchETagExcept if etag does not match while PUT MinIO returns an error this is a MinIO specific extension to support optimistic locking semantics.

type PutObjectPartOptions added in v1.10.0 

type PutObjectPartOptions struct {
	Md5Base64, Sha256Hex  string
	SSE                   encrypt.ServerSide
	CustomHeader, Trailer http.Header
}

PutObjectPartOptions contains options for PutObjectPart API

type PutObjectRetentionOptions 

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

PutObjectRetentionOptions represents options specified by user for PutObject call

type PutObjectTaggingOptions 

type PutObjectTaggingOptions struct {
	VersionID string
}

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

type QueryExpressionType 

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 RemoveBucketOptions 

type RemoveBucketOptions struct {
	ForceDelete bool
	/* trinet */
	Internal AdvancedDeleteBucketOptions
}

RemoveBucketOptions special headers to purge buckets, only useful when endpoint is MinIO

type RemoveObjectError 

type RemoveObjectError struct {
	ObjectName string
	VersionID  string
	Err        error
}

RemoveObjectError - container of Multi Delete S3 API error

type RemoveObjectOptions 

type RemoveObjectOptions struct {
	ForceDelete      bool
	GovernanceBypass bool
	VersionID        string
	Internal         AdvancedRemoveOptions
}

RemoveObjectOptions represents options specified by user for RemoveObject call

type RemoveObjectResult 

type RemoveObjectResult struct {
	ObjectName      string
	ObjectVersionID string

	DeleteMarker          bool
	DeleteMarkerVersionID string

	Err error
}

RemoveObjectResult - container of Multi Delete S3 API result

type RemoveObjectTaggingOptions 

type RemoveObjectTaggingOptions struct {
	VersionID string
}

RemoveObjectTaggingOptions holds the version id of the object to remove

type RemoveObjectsOptions 

type RemoveObjectsOptions struct {
	GovernanceBypass bool
}

RemoveObjectsOptions represents options specified by user for RemoveObjects call

type ReplicationStatus 

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 = "COMPLETED"
	// ReplicationStatusFailed indicates replication failed
	ReplicationStatusFailed ReplicationStatus = "FAILED"
	// ReplicationStatusReplica indicates object is a replica of a source
	ReplicationStatusReplica ReplicationStatus = "REPLICA"
)

func (ReplicationStatus) Empty 

func (r ReplicationStatus) Empty() bool

Empty returns true if no replication status set.

type RestoreInfo 

type RestoreInfo struct {
	// Is the restoring operation is still ongoing
	OngoingRestore bool
	// When the restored copy of the archived object will be removed
	ExpiryTime time.Time
}

RestoreInfo contains information of the restore operation of an archived object

type RestoreRequest 

type RestoreRequest struct {
	XMLName              xml.Name              `xml:"http://s3.amazonaws.com/doc/2006-03-01/ RestoreRequest"`
	Type                 *RestoreType          `xml:"Type,omitempty"`
	Tier                 *TierType             `xml:"Tier,omitempty"`
	Days                 *int                  `xml:"Days,omitempty"`
	GlacierJobParameters *GlacierJobParameters `xml:"GlacierJobParameters,omitempty"`
	Description          *string               `xml:"Description,omitempty"`
	SelectParameters     *SelectParameters     `xml:"SelectParameters,omitempty"`
	OutputLocation       *OutputLocation       `xml:"OutputLocation,omitempty"`
}

RestoreRequest holds properties of the restore object request

func (*RestoreRequest) SetDays 

func (r *RestoreRequest) SetDays(v int)

SetDays sets the days parameter of the restore request

func (*RestoreRequest) SetDescription 

func (r *RestoreRequest) SetDescription(v string)

SetDescription sets the description of the restore request

func (*RestoreRequest) SetGlacierJobParameters 

func (r *RestoreRequest) SetGlacierJobParameters(v GlacierJobParameters)

SetGlacierJobParameters sets the GlacierJobParameters of the restore request

func (*RestoreRequest) SetOutputLocation 

func (r *RestoreRequest) SetOutputLocation(v OutputLocation)

SetOutputLocation sets the properties of the copy of the archived object

func (*RestoreRequest) SetSelectParameters 

func (r *RestoreRequest) SetSelectParameters(v SelectParameters)

SetSelectParameters sets SelectParameters of the restore select request

func (*RestoreRequest) SetTier 

func (r *RestoreRequest) SetTier(v TierType)

SetTier sets the retrieval tier of the restore request

func (*RestoreRequest) SetType 

func (r *RestoreRequest) SetType(v RestoreType)

SetType sets the type of the restore request

type RestoreType 

type RestoreType string

RestoreType represents the restore request type

type Retention 

type Retention struct {
	Mode     RetentionMode
	Validity time.Duration
}

Retention - bucket level retention configuration.

func (Retention) IsEmpty 

func (r Retention) IsEmpty() bool

IsEmpty - returns whether retention is empty or not.

func (Retention) String 

func (r Retention) String() string

type RetentionMode 

type RetentionMode string

RetentionMode - object retention mode. 

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

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

func (RetentionMode) IsValid 

func (r RetentionMode) IsValid() bool

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

func (RetentionMode) String 

func (r RetentionMode) String() string

type S3 

type S3 struct {
	AccessControlList *AccessControlList `xml:"AccessControlList,omitempty"`
	BucketName        string
	Prefix            string
	CannedACL         *string        `xml:"CannedACL,omitempty"`
	Encryption        *Encryption    `xml:"Encryption,omitempty"`
	StorageClass      *string        `xml:"StorageClass,omitempty"`
	Tagging           *tags.Tags     `xml:"Tagging,omitempty"`
	UserMetadata      *MetadataEntry `xml:"UserMetadata,omitempty"`
}

S3 holds properties of the copy of the archived object

type SelectCompressionType 

type SelectCompressionType string

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

const (
	SelectCompressionNONE SelectCompressionType = "NONE"
	SelectCompressionGZIP SelectCompressionType = "GZIP"
	SelectCompressionBZIP SelectCompressionType = "BZIP2"

	SelectCompressionZSTD   SelectCompressionType = "ZSTD"   // Zstandard compression.
	SelectCompressionLZ4    SelectCompressionType = "LZ4"    // LZ4 Stream
	SelectCompressionS2     SelectCompressionType = "S2"     // S2 Stream
	SelectCompressionSNAPPY SelectCompressionType = "SNAPPY" // Snappy stream
)

Constants for compression types under select API.

type SelectObjectInputSerialization 

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

SelectObjectInputSerialization - input serialization parameters

type SelectObjectOptions 

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 

func (o SelectObjectOptions) Header() http.Header

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

type SelectObjectOutputSerialization 

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

SelectObjectOutputSerialization - output serialization parameters.

type SelectObjectType 

type SelectObjectType string

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

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

Constants for input data types.

type SelectParameters 

type SelectParameters struct {
	XMLName             xml.Name `xml:"SelectParameters"`
	ExpressionType      QueryExpressionType
	Expression          string
	InputSerialization  SelectObjectInputSerialization
	OutputSerialization SelectObjectOutputSerialization
}

SelectParameters holds the select request parameters

type SelectResults 

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

SelectResults is used for the streaming responses from the server.

func NewSelectResults 

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 

func (s *SelectResults) Close() error

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

func (*SelectResults) Progress 

func (s *SelectResults) Progress() *ProgressMessage

Progress - information about the progress of a request.

func (*SelectResults) Read 

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

Read - is a reader compatible implementation for SelectObjectContent records.

func (*SelectResults) Stats 

func (s *SelectResults) Stats() *StatsMessage

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

type SnowballObject 

type SnowballObject struct {
	// Key is the destination key, including prefix.
	Key string

	// Size is the content size of this object.
	Size int64

	// Modtime to apply to the object.
	// If Modtime is the zero value current time will be used.
	ModTime time.Time

	// Content of the object.
	// Exactly 'Size' number of bytes must be provided.
	Content io.Reader

	// Close will be called when an object has finished processing.
	// Note that if PutObjectsSnowball returns because of an error,
	// objects not consumed from the input will NOT have been closed.
	// Leave as nil for no callback.
	Close func()
}

SnowballObject contains information about a single object to be added to the snowball.

type SnowballOptions 

type SnowballOptions struct {
	// Opts is options applied to all objects.
	Opts PutObjectOptions

	// InMemory specifies that all objects should be collected in memory
	// before they are uploaded.
	// If false a temporary file will be created.
	InMemory bool

	// Compress enabled content compression before upload.
	// Compression will typically reduce memory and network usage,
	// Compression can safely be enabled with MinIO hosts.
	Compress bool

	// SkipErrs if enabled will skip any errors while reading the
	// object content while creating the snowball archive
	SkipErrs bool
}

SnowballOptions contains options for PutObjectsSnowball calls.

type StatObjectOptions 

type StatObjectOptions = GetObjectOptions

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

type StatsMessage 

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 

type StringMap map[string]string

StringMap represents map with custom UnmarshalXML

func (*StringMap) UnmarshalXML 

func (m *StringMap) UnmarshalXML(d *xml.Decoder, _ 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 TierType 

type TierType string

TierType represents a retrieval tier

type URLMap added in v1.10.0 

type URLMap map[string]string

URLMap represents map with custom UnmarshalXML

func (*URLMap) UnmarshalXML added in v1.10.0 

func (m *URLMap) UnmarshalXML(d *xml.Decoder, se 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 

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

	// Verified checksum values, if any.
	// Values are base64 (standard) encoded.
	// For multipart objects this is a checksum of the checksum of each part.
	ChecksumCRC32  string
	ChecksumCRC32C string
	ChecksumSHA1   string
	ChecksumSHA256 string
}

UploadInfo contains information about the newly uploaded or copied object.

type ValidityUnit 

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 

func (unit ValidityUnit) String() string

type Version 

type Version struct {
	ETag         string
	IsLatest     bool
	Key          string
	LastModified time.Time
	Owner        Owner
	Size         int64
	StorageClass string
	VersionID    string `xml:"VersionId"`

	// x-amz-meta-* headers stripped "x-amz-meta-" prefix containing the first value.
	// Only returned by MinIO servers.
	UserMetadata StringMap `json:"userMetadata,omitempty"`

	// x-amz-tagging values in their k/v values.
	// Only returned by MinIO servers.
	UserTags URLMap `json:"userTags,omitempty" xml:"UserTags"`

	Internal *struct {
		K int // Data blocks
		M int // Parity blocks
	} `xml:"Internal"`
	// 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.