Documentation ¶
Index ¶
- Constants
- Variables
- func ErrAPINotSupported(message string) error
- func ErrEntityTooLarge(totalSize, maxObjectSize int64, bucketName, objectName string) error
- func ErrEntityTooSmall(totalSize int64, bucketName, objectName string) error
- func ErrInvalidArgument(message string) error
- func ErrInvalidBucketName(message string) error
- func ErrInvalidObjectName(message string) error
- func ErrNoSuchBucketPolicy(message string) error
- func ErrTransferAccelerationBucket(bucketName string) error
- func ErrUnexpectedEOF(totalRead, totalSize int64, bucketName, objectName string) error
- type Arn
- type BucketInfo
- type BucketNotification
- func (b *BucketNotification) AddLambda(lambdaConfig NotificationConfig)
- func (b *BucketNotification) AddQueue(queueConfig NotificationConfig)
- func (b *BucketNotification) AddTopic(topicConfig NotificationConfig)
- func (b *BucketNotification) RemoveLambdaByArn(arn Arn)
- func (b *BucketNotification) RemoveQueueByArn(arn Arn)
- func (b *BucketNotification) RemoveTopicByArn(arn Arn)
- type Client
- func New(endpoint, accessKeyID, secretAccessKey string, secure bool) (*Client, error)
- func NewV2(endpoint string, accessKeyID, secretAccessKey string, secure bool) (*Client, error)
- func NewV4(endpoint string, accessKeyID, secretAccessKey string, secure bool) (*Client, error)
- func NewWithCredentials(endpoint string, creds *credentials.Credentials, secure bool, region string) (*Client, error)
- func NewWithRegion(endpoint, accessKeyID, secretAccessKey string, secure bool, region string) (*Client, error)
- func (c Client) BucketExists(bucketName string) (bool, error)
- func (c Client) ComposeObject(dst DestinationInfo, srcs []SourceInfo) error
- func (c Client) CopyObject(dst DestinationInfo, src SourceInfo) error
- func (c Client) FGetObject(bucketName, objectName, filePath string) error
- func (c Client) FPutObject(bucketName, objectName, filePath, contentType string) (n int64, err error)
- func (c Client) GetBucketLocation(bucketName string) (string, error)
- func (c Client) GetBucketNotification(bucketName string) (bucketNotification BucketNotification, err error)
- func (c Client) GetBucketPolicy(bucketName, objectPrefix string) (bucketPolicy policy.BucketPolicy, err error)
- func (c Client) GetEncryptedObject(bucketName, objectName string, encryptMaterials encrypt.Materials) (io.ReadCloser, error)
- func (c Client) GetObject(bucketName, objectName string) (*Object, error)
- func (c Client) ListBucketPolicies(bucketName, objectPrefix string) (bucketPolicies map[string]policy.BucketPolicy, err error)
- func (c Client) ListBuckets() ([]BucketInfo, error)
- func (c Client) ListIncompleteUploads(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectMultipartInfo
- func (c Client) ListObjects(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectInfo
- func (c Client) ListObjectsV2(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectInfo
- func (c Client) ListenBucketNotification(bucketName, prefix, suffix string, events []string, doneCh <-chan struct{}) <-chan NotificationInfo
- func (c Client) MakeBucket(bucketName string, location string) (err error)
- func (c Client) PresignedGetObject(bucketName string, objectName string, expires time.Duration, ...) (u *url.URL, err error)
- func (c Client) PresignedPostPolicy(p *PostPolicy) (u *url.URL, formData map[string]string, err error)
- func (c Client) PresignedPutObject(bucketName string, objectName string, expires time.Duration) (u *url.URL, err error)
- func (c Client) PutEncryptedObject(bucketName, objectName string, reader io.Reader, ...) (n int64, err error)
- func (c Client) PutObject(bucketName, objectName string, reader io.Reader, contentType string) (n int64, err error)
- func (c Client) PutObjectStreaming(bucketName, objectName string, reader io.Reader) (n int64, err error)
- func (c Client) PutObjectWithMetadata(bucketName, objectName string, reader io.Reader, metadata map[string][]string, ...) (n int64, err error)
- func (c Client) PutObjectWithProgress(bucketName, objectName string, reader io.Reader, metadata map[string][]string, ...) (n int64, err error)
- func (c Client) PutObjectWithSize(bucketName, objectName string, reader io.Reader, readerSize int64, ...) (n int64, err error)
- func (c Client) RemoveAllBucketNotification(bucketName string) error
- func (c Client) RemoveBucket(bucketName string) error
- func (c Client) RemoveIncompleteUpload(bucketName, objectName string) error
- func (c Client) RemoveObject(bucketName, objectName string) error
- func (c Client) RemoveObjects(bucketName string, objectsCh <-chan string) <-chan RemoveObjectError
- func (c *Client) SetAppInfo(appName string, appVersion string)
- func (c Client) SetBucketNotification(bucketName string, bucketNotification BucketNotification) error
- func (c Client) SetBucketPolicy(bucketName string, objectPrefix string, bucketPolicy policy.BucketPolicy) error
- func (c *Client) SetCustomTransport(customHTTPTransport http.RoundTripper)
- func (c *Client) SetS3TransferAccelerate(accelerateEndpoint string)
- func (c Client) StatObject(bucketName, objectName string) (ObjectInfo, error)
- func (c *Client) TraceOff()
- func (c *Client) TraceOn(outputStream io.Writer)
- type CommonPrefix
- type CompletePart
- type Core
- func (c Core) AbortMultipartUpload(bucket, object, uploadID string) error
- func (c Core) CompleteMultipartUpload(bucket, object, uploadID string, parts []CompletePart) error
- func (c Core) GetBucketPolicy(bucket string) (policy.BucketAccessPolicy, error)
- func (c Core) GetObject(bucketName, objectName string, reqHeaders RequestHeaders) (io.ReadCloser, ObjectInfo, error)
- func (c Core) ListMultipartUploads(bucket, prefix, keyMarker, uploadIDMarker, delimiter string, maxUploads int) (result ListMultipartUploadsResult, err error)
- func (c Core) ListObjectParts(bucket, object, uploadID string, partNumberMarker int, maxParts int) (result ListObjectPartsResult, err error)
- func (c Core) ListObjects(bucket, prefix, marker, delimiter string, maxKeys int) (result ListBucketResult, err error)
- func (c Core) ListObjectsV2(bucketName, objectPrefix, continuationToken string, fetchOwner bool, ...) (ListBucketV2Result, error)
- func (c Core) NewMultipartUpload(bucket, object string, metadata map[string][]string) (uploadID string, err error)
- func (c Core) PutBucketPolicy(bucket string, bucketPolicy policy.BucketAccessPolicy) error
- func (c Core) PutObject(bucket, object string, size int64, data io.Reader, md5Sum, sha256Sum []byte, ...) (ObjectInfo, error)
- func (c Core) PutObjectPart(bucket, object, uploadID string, partID int, size int64, data io.Reader, ...) (ObjectPart, error)
- func (c Core) PutObjectPartWithMetadata(bucket, object, uploadID string, partID int, size int64, data io.Reader, ...) (ObjectPart, error)
- func (c Core) StatObject(bucketName, objectName string, reqHeaders RequestHeaders) (ObjectInfo, error)
- type DestinationInfo
- type ErrorResponse
- type Filter
- type FilterRule
- type LambdaConfig
- type ListBucketResult
- type ListBucketV2Result
- type ListMultipartUploadsResult
- type ListObjectPartsResult
- type NotificationConfig
- type NotificationEvent
- type NotificationEventType
- type NotificationInfo
- type Object
- type ObjectInfo
- type ObjectMultipartInfo
- type ObjectPart
- type PostPolicy
- func (p *PostPolicy) SetBucket(bucketName string) error
- func (p *PostPolicy) SetContentLengthRange(min, max int64) error
- func (p *PostPolicy) SetContentType(contentType string) error
- func (p *PostPolicy) SetExpires(t time.Time) error
- func (p *PostPolicy) SetKey(key string) error
- func (p *PostPolicy) SetKeyStartsWith(keyStartsWith string) error
- func (p *PostPolicy) SetSuccessStatusAction(status string) error
- func (p PostPolicy) String() string
- type QueueConfig
- type RemoveObjectError
- type RequestHeaders
- type S3Key
- type SSEInfo
- type SourceInfo
- func (s *SourceInfo) SetMatchETagCond(etag string) error
- func (s *SourceInfo) SetMatchETagExceptCond(etag string) error
- func (s *SourceInfo) SetModifiedSinceCond(modTime time.Time) error
- func (s *SourceInfo) SetRange(start, end int64) error
- func (s *SourceInfo) SetUnmodifiedSinceCond(modTime time.Time) error
- type TopicConfig
Constants ¶
const ( ObjectCreatedAll NotificationEventType = "s3:ObjectCreated:*" ObjectCreatedPut = "s3:ObjectCreated:Put" ObjectCreatedPost = "s3:ObjectCreated:Post" ObjectCreatedCopy = "s3:ObjectCreated:Copy" ObjectCreatedCompleteMultipartUpload = "s3:ObjectCreated:CompleteMultipartUpload" ObjectAccessedGet = "s3:ObjectAccessed:Get" ObjectAccessedHead = "s3:ObjectAccessed:Head" ObjectAccessedAll = "s3:ObjectAccessed:*" ObjectRemovedAll = "s3:ObjectRemoved:*" ObjectRemovedDelete = "s3:ObjectRemoved:Delete" ObjectRemovedDeleteMarkerCreated = "s3:ObjectRemoved:DeleteMarkerCreated" ObjectReducedRedundancyLostObject = "s3:ReducedRedundancyLostObject" )
The role of all event types are described in :
http://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#notification-how-to-event-types-and-destinations
const DefaultRetryCap = time.Second * 30
DefaultRetryCap - Each retry attempt never waits no longer than this maximum time duration.
const DefaultRetryUnit = time.Second
DefaultRetryUnit - default unit multiplicative per retry. defaults to 1 second.
const MaxJitter = 1.0
MaxJitter will randomize over the full exponential backoff time
const NoJitter = 0.0
NoJitter disables the use of jitter for randomizing the exponential backoff time
Variables ¶
var ErrInvalidObjectPrefix = ErrInvalidObjectName
ErrInvalidObjectPrefix - Invalid object prefix response is similar to object name response.
var MaxRetry = 5
MaxRetry is the maximum number of retries before stopping.
Functions ¶
func ErrAPINotSupported ¶
ErrAPINotSupported - API not supported response The specified API call is not supported
func ErrEntityTooLarge ¶ added in v1.0.0
ErrEntityTooLarge - Input size is larger than supported maximum.
func ErrEntityTooSmall ¶ added in v1.0.0
ErrEntityTooSmall - Input size is smaller than supported minimum.
func ErrInvalidArgument ¶ added in v1.0.0
ErrInvalidArgument - Invalid argument response.
func ErrInvalidBucketName ¶ added in v1.0.0
ErrInvalidBucketName - Invalid bucket name response.
func ErrInvalidObjectName ¶ added in v1.0.0
ErrInvalidObjectName - Invalid object name response.
func ErrNoSuchBucketPolicy ¶
ErrNoSuchBucketPolicy - No Such Bucket Policy response The specified bucket does not have a bucket policy.
func ErrTransferAccelerationBucket ¶
ErrTransferAccelerationBucket - bucket name is invalid to be used with transfer acceleration.
func ErrUnexpectedEOF ¶ added in v1.0.0
ErrUnexpectedEOF - Unexpected end of file reached.
Types ¶
type Arn ¶
Arn - holds ARN information that will be sent to the web service, ARN desciption can be found in http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
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 BucketNotification ¶
type BucketNotification struct { XMLName xml.Name `xml:"NotificationConfiguration"` LambdaConfigs []LambdaConfig `xml:"CloudFunctionConfiguration"` TopicConfigs []TopicConfig `xml:"TopicConfiguration"` QueueConfigs []QueueConfig `xml:"QueueConfiguration"` }
BucketNotification - the struct that represents the whole XML to be sent to the web service
func (*BucketNotification) AddLambda ¶
func (b *BucketNotification) AddLambda(lambdaConfig NotificationConfig)
AddLambda adds a given lambda config to the general bucket notification config
func (*BucketNotification) AddQueue ¶
func (b *BucketNotification) AddQueue(queueConfig NotificationConfig)
AddQueue adds a given queue config to the general bucket notification config
func (*BucketNotification) AddTopic ¶
func (b *BucketNotification) AddTopic(topicConfig NotificationConfig)
AddTopic adds a given topic config to the general bucket notification config
func (*BucketNotification) RemoveLambdaByArn ¶
func (b *BucketNotification) RemoveLambdaByArn(arn Arn)
RemoveLambdaByArn removes all lambda configurations that match the exact specified ARN
func (*BucketNotification) RemoveQueueByArn ¶
func (b *BucketNotification) RemoveQueueByArn(arn Arn)
RemoveQueueByArn removes all queue configurations that match the exact specified ARN
func (*BucketNotification) RemoveTopicByArn ¶
func (b *BucketNotification) RemoveTopicByArn(arn Arn)
RemoveTopicByArn removes all topic configurations that match the exact specified ARN
type Client ¶ added in v1.0.0
type Client struct {
// contains filtered or unexported fields
}
Client implements Amazon S3 compatible methods.
func NewV2 ¶ added in v1.0.0
NewV2 - instantiate minio client with Amazon S3 signature version '2' compatibility.
func NewV4 ¶ added in v1.0.0
NewV4 - instantiate minio client with Amazon S3 signature version '4' compatibility.
func NewWithCredentials ¶
func NewWithCredentials(endpoint string, creds *credentials.Credentials, secure bool, region string) (*Client, error)
NewWithCredentials - instantiate minio client with credentials provider for retrieving credentials from various credentials provider such as IAM, File, Env etc.
func NewWithRegion ¶
func NewWithRegion(endpoint, accessKeyID, secretAccessKey string, secure bool, region string) (*Client, error)
NewWithRegion - instantiate minio client, with region configured. Unlike New(), NewWithRegion avoids bucket-location lookup operations and it is slightly faster. Use this function when if your application deals with single region.
func (Client) BucketExists ¶ added in v1.0.0
BucketExists verify if bucket exists and you have permission to access it.
func (Client) ComposeObject ¶
func (c Client) ComposeObject(dst DestinationInfo, srcs []SourceInfo) 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.
func (Client) CopyObject ¶
func (c Client) CopyObject(dst DestinationInfo, src SourceInfo) error
CopyObject - copy a source object into a new object
func (Client) FGetObject ¶ added in v1.0.0
FGetObject - download contents of an object to a local file.
func (Client) FPutObject ¶ added in v1.0.0
func (c Client) FPutObject(bucketName, objectName, filePath, contentType string) (n int64, err error)
FPutObject - Create an object in a bucket, with contents from file at filePath.
func (Client) GetBucketLocation ¶
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(bucketName string) (bucketNotification BucketNotification, err error)
GetBucketNotification - get bucket notification at a given path.
func (Client) GetBucketPolicy ¶
func (c Client) GetBucketPolicy(bucketName, objectPrefix string) (bucketPolicy policy.BucketPolicy, err error)
GetBucketPolicy - get bucket policy at a given path.
func (Client) GetEncryptedObject ¶
func (c Client) GetEncryptedObject(bucketName, objectName string, encryptMaterials encrypt.Materials) (io.ReadCloser, error)
GetEncryptedObject deciphers and streams data stored in the server after applying a specified encryption materials, returned stream should be closed by the caller.
func (Client) ListBucketPolicies ¶
func (c Client) ListBucketPolicies(bucketName, objectPrefix string) (bucketPolicies map[string]policy.BucketPolicy, err error)
ListBucketPolicies - list all policies for a given prefix and all its children.
func (Client) ListBuckets ¶ added in v1.0.0
func (c Client) ListBuckets() ([]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() { fmt.Println(message) }
func (Client) ListIncompleteUploads ¶ added in v1.0.0
func (c Client) ListIncompleteUploads(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-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 and a done channel to pro-actively close the internal go routine. If you enable recursive as 'true' this function will return back all the multipart objects in a given bucket name.
api := client.New(....) // Create a done channel. doneCh := make(chan struct{}) defer close(doneCh) // Recurively list all objects in 'mytestbucket' recursive := true for message := range api.ListIncompleteUploads("mytestbucket", "starthere", recursive) { fmt.Println(message) }
func (Client) ListObjects ¶ added in v1.0.0
func (c Client) ListObjects(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectInfo
ListObjects - (List Objects) - List some objects or all recursively.
ListObjects lists all 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 and a done channel for pro-actively closing the internal go routine. If you enable recursive as 'true' this function will return back all the objects in a given bucket name and object prefix.
api := client.New(....) // Create a done channel. doneCh := make(chan struct{}) defer close(doneCh) // Recurively list all objects in 'mytestbucket' recursive := true for message := range api.ListObjects("mytestbucket", "starthere", recursive, doneCh) { fmt.Println(message) }
func (Client) ListObjectsV2 ¶
func (c Client) ListObjectsV2(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectInfo
ListObjectsV2 lists all 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 and a done channel for pro-actively closing the internal go routine. If you enable recursive as 'true' this function will return back all the objects in a given bucket name and object prefix.
api := client.New(....) // Create a done channel. doneCh := make(chan struct{}) defer close(doneCh) // Recursively list all objects in 'mytestbucket' recursive := true for message := range api.ListObjectsV2("mytestbucket", "starthere", recursive, doneCh) { fmt.Println(message) }
func (Client) ListenBucketNotification ¶
func (c Client) ListenBucketNotification(bucketName, prefix, suffix string, events []string, doneCh <-chan struct{}) <-chan NotificationInfo
ListenBucketNotification - listen on bucket notifications.
func (Client) MakeBucket ¶ added in v1.0.0
MakeBucket creates a new bucket with bucketName.
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) PresignedGetObject ¶ added in v1.0.0
func (c Client) PresignedGetObject(bucketName string, objectName string, expires time.Duration, reqParams url.Values) (u *url.URL, err error)
PresignedGetObject - Returns a presigned URL to access an object without credentials. Expires maximum is 7days - ie. 604800 and minimum is 1. 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(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(bucketName string, objectName string, expires time.Duration) (u *url.URL, err error)
PresignedPutObject - Returns a presigned URL to upload an object without credentials. Expires maximum is 7days - ie. 604800 and minimum is 1.
func (Client) PutEncryptedObject ¶
func (c Client) PutEncryptedObject(bucketName, objectName string, reader io.Reader, encryptMaterials encrypt.Materials, metadata map[string][]string, progress io.Reader) (n int64, err error)
PutEncryptedObject - Encrypt and store object.
func (Client) PutObject ¶ added in v1.0.0
func (c Client) PutObject(bucketName, objectName string, reader io.Reader, contentType string) (n int64, 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 64MiB PutObject automatically does a single atomic Put operation.
- For size larger than 64MiB 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) PutObjectStreaming ¶
func (c Client) PutObjectStreaming(bucketName, objectName string, reader io.Reader) (n int64, err error)
PutObjectStreaming using AWS streaming signature V4
func (Client) PutObjectWithMetadata ¶
func (c Client) PutObjectWithMetadata(bucketName, objectName string, reader io.Reader, metadata map[string][]string, progress io.Reader) (n int64, err error)
PutObjectWithMetadata using AWS streaming signature V4
func (Client) PutObjectWithProgress ¶ added in v1.0.0
func (c Client) PutObjectWithProgress(bucketName, objectName string, reader io.Reader, metadata map[string][]string, progress io.Reader) (n int64, err error)
PutObjectWithProgress using AWS streaming signature V4
func (Client) PutObjectWithSize ¶
func (c Client) PutObjectWithSize(bucketName, objectName string, reader io.Reader, readerSize int64, metadata map[string][]string, progress io.Reader) (n int64, err error)
PutObjectWithSize - is a helper PutObject similar in behavior to PutObject() but takes the size argument explicitly, this function avoids doing reflection internally to figure out the size of input stream. Also if the input size is lesser than 0 this function returns an error.
func (Client) RemoveAllBucketNotification ¶
RemoveAllBucketNotification - Remove bucket notification clears all previously specified config
func (Client) RemoveBucket ¶ added in v1.0.0
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) RemoveIncompleteUpload ¶ added in v1.0.0
RemoveIncompleteUpload aborts an partially uploaded object.
func (Client) RemoveObject ¶ added in v1.0.0
RemoveObject remove an object from a bucket.
func (Client) RemoveObjects ¶
func (c Client) RemoveObjects(bucketName string, objectsCh <-chan string) <-chan RemoveObjectError
RemoveObjects remove multiples objects from a bucket. The list of objects to remove are received from objectsCh. Remove failures are sent back via error channel.
func (*Client) SetAppInfo ¶ added in v1.0.0
SetAppInfo - add application details to user agent.
func (Client) SetBucketNotification ¶
func (c Client) SetBucketNotification(bucketName string, bucketNotification BucketNotification) error
SetBucketNotification saves a new bucket notification.
func (Client) SetBucketPolicy ¶
func (c Client) SetBucketPolicy(bucketName string, objectPrefix string, bucketPolicy policy.BucketPolicy) error
SetBucketPolicy set the access permissions on an existing bucket.
For example
none - owner gets full access [default]. readonly - anonymous get access for everyone at a given object prefix. readwrite - anonymous list/put/delete access to a given object prefix. writeonly - anonymous put/delete access to a given object prefix.
func (*Client) SetCustomTransport ¶ added in v1.0.0
func (c *Client) SetCustomTransport(customHTTPTransport http.RoundTripper)
SetCustomTransport - set new custom transport.
func (*Client) SetS3TransferAccelerate ¶
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(bucketName, objectName string) (ObjectInfo, error)
StatObject verifies if object exists and you have permission to access.
type CommonPrefix ¶
type CommonPrefix struct {
Prefix string
}
CommonPrefix container for prefix response.
type CompletePart ¶
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 Core ¶
type Core struct {
*Client
}
Core - Inherits Client and adds new methods to expose the low level S3 APIs.
func NewCore ¶
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 ¶
AbortMultipartUpload - Abort an incomplete upload.
func (Core) CompleteMultipartUpload ¶
func (c Core) CompleteMultipartUpload(bucket, object, uploadID string, parts []CompletePart) error
CompleteMultipartUpload - Concatenate uploaded parts and commit to an object.
func (Core) GetBucketPolicy ¶
func (c Core) GetBucketPolicy(bucket string) (policy.BucketAccessPolicy, error)
GetBucketPolicy - fetches bucket access policy for a given bucket.
func (Core) GetObject ¶
func (c Core) GetObject(bucketName, objectName string, reqHeaders RequestHeaders) (io.ReadCloser, ObjectInfo, 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(bucket, prefix, keyMarker, uploadIDMarker, delimiter string, maxUploads int) (result ListMultipartUploadsResult, err error)
ListMultipartUploads - List incomplete uploads.
func (Core) ListObjectParts ¶
func (c Core) ListObjectParts(bucket, object, uploadID string, partNumberMarker int, 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, continuationToken string, fetchOwner bool, delimiter string, maxkeys int) (ListBucketV2Result, error)
ListObjectsV2 - Lists all the objects at a prefix, similar to ListObjects() but uses continuationToken instead of marker to further filter the results.
func (Core) NewMultipartUpload ¶
func (c Core) NewMultipartUpload(bucket, object string, metadata map[string][]string) (uploadID string, err error)
NewMultipartUpload - Initiates new multipart upload and returns the new uploaID.
func (Core) PutBucketPolicy ¶
func (c Core) PutBucketPolicy(bucket string, bucketPolicy policy.BucketAccessPolicy) error
PutBucketPolicy - applies a new bucket access policy for a given bucket.
func (Core) PutObject ¶
func (c Core) PutObject(bucket, object string, size int64, data io.Reader, md5Sum, sha256Sum []byte, metadata map[string][]string) (ObjectInfo, error)
PutObject - Upload object. Uploads using single PUT call.
func (Core) PutObjectPart ¶
func (c Core) PutObjectPart(bucket, object, uploadID string, partID int, size int64, data io.Reader, md5Sum, sha256Sum []byte) (ObjectPart, error)
PutObjectPart - Upload an object part.
func (Core) PutObjectPartWithMetadata ¶
func (c Core) PutObjectPartWithMetadata(bucket, object, uploadID string, partID int, size int64, data io.Reader, md5Sum, sha256Sum []byte, metadata map[string][]string) (ObjectPart, error)
PutObjectPartWithMetadata - upload an object part with additional request metadata.
func (Core) StatObject ¶
func (c Core) StatObject(bucketName, objectName string, reqHeaders RequestHeaders) (ObjectInfo, error)
StatObject is a lower level API implemented to support special conditions matching etag, modtime on a request.
type DestinationInfo ¶
type DestinationInfo struct {
// contains filtered or unexported fields
}
DestinationInfo - type with information about the object to be created via server-side copy requests, using the Compose API.
func NewDestinationInfo ¶
func NewDestinationInfo(bucket, object string, encryptSSEC *SSEInfo, userMeta map[string]string) (d DestinationInfo, err error)
NewDestinationInfo - creates a compose-object/copy-source destination info object.
`encSSEC` is the key info for server-side-encryption with customer provided key. If it is nil, no encryption is performed.
`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.
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 // Headers of the returned S3 XML error Headers http.Header `xml:"-" json:"-"` }
ErrorResponse - Is the typed error returned by all API operations.
func ToErrorResponse ¶
func ToErrorResponse(err error) ErrorResponse
ToErrorResponse - Returns parsed ErrorResponse struct from body and http headers.
For example:
import s3 "github.com/StudioSol/minio-go" ... ... reader, stat, err := s3.GetObject(...) if err != nil { resp := s3.ToErrorResponse(err) } ...
type Filter ¶
type Filter struct {
S3Key S3Key `xml:"S3Key,omitempty"`
}
Filter - a tag in the notification xml structure which carries suffix/prefix filters
type FilterRule ¶
FilterRule - child of S3Key, a tag in the notification xml which carries suffix/prefix filters
type LambdaConfig ¶
type LambdaConfig struct { NotificationConfig Lambda string `xml:"CloudFunction"` }
LambdaConfig carries one single cloudfunction notification configuration
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 NotificationConfig ¶
type NotificationConfig struct { ID string `xml:"Id,omitempty"` Arn Arn `xml:"-"` Events []NotificationEventType `xml:"Event"` Filter *Filter `xml:"Filter,omitempty"` }
NotificationConfig - represents one single notification configuration such as topic, queue or lambda configuration.
func NewNotificationConfig ¶
func NewNotificationConfig(arn Arn) NotificationConfig
NewNotificationConfig creates one notification config and sets the given ARN
func (*NotificationConfig) AddEvents ¶
func (t *NotificationConfig) AddEvents(events ...NotificationEventType)
AddEvents adds one event to the current notification config
func (*NotificationConfig) AddFilterPrefix ¶
func (t *NotificationConfig) AddFilterPrefix(prefix string)
AddFilterPrefix sets the prefix configuration to the current notification config
func (*NotificationConfig) AddFilterSuffix ¶
func (t *NotificationConfig) AddFilterSuffix(suffix string)
AddFilterSuffix sets the suffix configuration to the current notification config
type NotificationEvent ¶
type NotificationEvent struct { EventVersion string `json:"eventVersion"` EventSource string `json:"eventSource"` AwsRegion string `json:"awsRegion"` EventTime string `json:"eventTime"` EventName string `json:"eventName"` UserIdentity identity `json:"userIdentity"` RequestParameters map[string]string `json:"requestParameters"` ResponseElements map[string]string `json:"responseElements"` S3 eventMeta `json:"s3"` Source sourceInfo `json:"source"` }
NotificationEvent represents an Amazon an S3 bucket notification event.
type NotificationEventType ¶
type NotificationEventType string
NotificationEventType is a S3 notification event associated to the bucket notification configuration
type NotificationInfo ¶
type NotificationInfo struct { Records []NotificationEvent Err error }
NotificationInfo - represents the collection of notification events, additionally also reports errors if any while listening on bucket notifications.
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
Close - The behavior of Close after the first call returns error for subsequent Close() calls.
func (*Object) Read ¶ added in v1.0.0
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
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
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. // Collection of additional metadata on the object. // eg: x-amz-meta-*, content-encoding etc. Metadata http.Header `json:"metadata"` // Owner name. Owner struct { DisplayName string `json:"name"` ID string `json:"id"` } `json:"owner"` // The class of storage used to store the object. StorageClass string `json:"storageClass"` // Error Err error `json:"-"` }
ObjectInfo container for object metadata.
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 ¶
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 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) 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) 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) SetSuccessStatusAction ¶
func (p *PostPolicy) SetSuccessStatusAction(status string) error
SetSuccessStatusAction - Sets the status success code of the object for this policy based upload.
func (PostPolicy) String ¶ added in v1.0.0
func (p PostPolicy) String() string
Stringer interface for printing policy in json formatted string.
type QueueConfig ¶
type QueueConfig struct { NotificationConfig Queue string `xml:"Queue"` }
QueueConfig carries one single queue notification configuration
type RemoveObjectError ¶
RemoveObjectError - container of Multi Delete S3 API error
type RequestHeaders ¶
RequestHeaders - implement methods for setting special request headers for GET, HEAD object operations. http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html
func NewGetReqHeaders ¶
func NewGetReqHeaders() RequestHeaders
NewGetReqHeaders - initializes a new request headers for GET request.
func NewHeadReqHeaders ¶
func NewHeadReqHeaders() RequestHeaders
NewHeadReqHeaders - initializes a new request headers for HEAD request.
func (RequestHeaders) SetMatchETag ¶
func (c RequestHeaders) SetMatchETag(etag string) error
SetMatchETag - set match etag.
func (RequestHeaders) SetMatchETagExcept ¶
func (c RequestHeaders) SetMatchETagExcept(etag string) error
SetMatchETagExcept - set match etag except.
func (RequestHeaders) SetModified ¶
func (c RequestHeaders) SetModified(modTime time.Time) error
SetModified - set modified time since.
func (RequestHeaders) SetRange ¶
func (c RequestHeaders) 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 (RequestHeaders) SetUnmodified ¶
func (c RequestHeaders) SetUnmodified(modTime time.Time) error
SetUnmodified - set unmodified time since.
type S3Key ¶
type S3Key struct {
FilterRules []FilterRule `xml:"FilterRule,omitempty"`
}
S3Key - child of Filter, a tag in the notification xml which carries suffix/prefix filters
type SSEInfo ¶
type SSEInfo struct {
// contains filtered or unexported fields
}
SSEInfo - represents Server-Side-Encryption parameters specified by a user.
func NewSSEInfo ¶
NewSSEInfo - specifies (binary or un-encoded) encryption key and algorithm name. If algo is empty, it defaults to "AES256". Ref: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
func (*SSEInfo) GetSSEHeaders ¶
GetSSEHeaders - computes and returns headers for SSE-C as key-value pairs. They can be set as metadata in PutObject* requests (for encryption) or be set as request headers in `Core.GetObject` (for decryption).
type SourceInfo ¶
type SourceInfo struct { // Headers to send with the upload-part-copy request involving // this source object. Headers http.Header // contains filtered or unexported fields }
SourceInfo - represents a source object to be copied, using server-side copying APIs.
func NewSourceInfo ¶
func NewSourceInfo(bucket, object string, decryptSSEC *SSEInfo) SourceInfo
NewSourceInfo - create a compose-object/copy-object source info object.
`decryptSSEC` is the decryption key using server-side-encryption with customer provided key. It may be nil if the source is not encrypted.
func (*SourceInfo) SetMatchETagCond ¶
func (s *SourceInfo) SetMatchETagCond(etag string) error
SetMatchETagCond - Set ETag match condition. The object is copied only if the etag of the source matches the value given here.
func (*SourceInfo) SetMatchETagExceptCond ¶
func (s *SourceInfo) SetMatchETagExceptCond(etag string) error
SetMatchETagExceptCond - Set the ETag match exception condition. The object is copied only if the etag of the source is not the value given here.
func (*SourceInfo) SetModifiedSinceCond ¶
func (s *SourceInfo) SetModifiedSinceCond(modTime time.Time) error
SetModifiedSinceCond - Set the modified since condition.
func (*SourceInfo) SetRange ¶
func (s *SourceInfo) SetRange(start, end int64) error
SetRange - Set the start and end offset of the source object to be copied. If this method is not called, the whole source object is copied.
func (*SourceInfo) SetUnmodifiedSinceCond ¶
func (s *SourceInfo) SetUnmodifiedSinceCond(modTime time.Time) error
SetUnmodifiedSinceCond - Set the unmodified since condition.
type TopicConfig ¶
type TopicConfig struct { NotificationConfig Topic string `xml:"Topic"` }
TopicConfig carries one single topic notification configuration
Source Files ¶
- api-compose-object.go
- api-datatypes.go
- api-error-response.go
- api-get-object-file.go
- api-get-object.go
- api-get-policy.go
- api-list.go
- api-notification.go
- api-presigned.go
- api-put-bucket.go
- api-put-object-common.go
- api-put-object-copy.go
- api-put-object-encrypted.go
- api-put-object-file.go
- api-put-object-multipart.go
- api-put-object-streaming.go
- api-put-object.go
- api-remove.go
- api-s3-datatypes.go
- api-stat.go
- api.go
- bucket-cache.go
- bucket-notification.go
- constants.go
- core.go
- hook-reader.go
- post-policy.go
- request-headers.go
- retry-continous.go
- retry.go
- s3-endpoints.go
- s3-error.go
- utils.go
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
Package encrypt implements a generic interface to encrypt any stream of data.
|
Package encrypt implements a generic interface to encrypt any stream of data. |