multipartclient

Documentation

Index

• type AbortMultipartUploadRequest
• type CommonPrefixes
• type CompleteMultipartUploadBody
• type CompleteMultipartUploadRequest
• type CompleteMultipartUploadResponse
• type CompleteMultipartUploadResult
• type CompletePart
• type InitiateMultipartUploadRequest
• type InitiateMultipartUploadResult
• type ListMultipartUploadsRequest
• type ListMultipartUploadsResult
• type ListObjectPartsRequest
• type ListObjectPartsResult
• type ListObjectPartsResultPart
• type ListUpload
• type MultipartClient
  • func New(hc *http.Client) *MultipartClient
  • func NewWithBaseURL(hc *http.Client, baseURL string) *MultipartClient
  • func (mpuc *MultipartClient) AbortMultipartUpload(ctx context.Context, req *AbortMultipartUploadRequest) error
  • func (mpuc *MultipartClient) CompleteMultipartUpload(ctx context.Context, req *CompleteMultipartUploadRequest) (*CompleteMultipartUploadResult, error)
  • func (mpuc *MultipartClient) InitiateMultipartUpload(ctx context.Context, req *InitiateMultipartUploadRequest) (*InitiateMultipartUploadResult, error)
  • func (mpuc *MultipartClient) ListMultipartUploads(ctx context.Context, req *ListMultipartUploadsRequest) (*ListMultipartUploadsResult, error)
  • func (mpuc *MultipartClient) ListObjectParts(ctx context.Context, req *ListObjectPartsRequest) (*ListObjectPartsResult, error)
  • func (mpuc *MultipartClient) UploadObjectPart(ctx context.Context, req *UploadObjectPartRequest) (*UploadObjectPartResult, error)
• type UploadObjectPartRequest
• type UploadObjectPartResult

Types

type AbortMultipartUploadRequest

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

type CommonPrefixes

type CommonPrefixes struct {
	XMLName xml.Name `xml:"CommonPrefixes"`
	Prefix  string   `xml:"Prefix"`
}

CommonPrefixes represents grouped object name prefixes

type CompleteMultipartUploadBody

type CompleteMultipartUploadBody struct {
	XMLName xml.Name `xml:"CompleteMultipartUpload"`
	Parts   []CompletePart
}

type CompleteMultipartUploadRequest

type CompleteMultipartUploadRequest struct {
	Bucket   string
	Key      string
	UploadID string
	Body     CompleteMultipartUploadBody
}

TODO: Add header support.

type CompleteMultipartUploadResponse

type CompleteMultipartUploadResponse struct {
	Result CompleteMultipartUploadResult
	Hash   string
}

type CompleteMultipartUploadResult

type CompleteMultipartUploadResult struct {
	XMLName  xml.Name `xml:"CompleteMultipartUploadResult"`
	Location string   `xml:"Location"`
	Bucket   string   `xml:"Bucket"`
	Key      string   `xml:"Key"`
	Etag     string   `xml:"ETag"`
}

type CompletePart

type CompletePart struct {
	XMLName    xml.Name `xml:"Part"`
	PartNumber int      `xml:"PartNumber"`
	Etag       string   `xml:"ETag"`
}

type InitiateMultipartUploadRequest

type InitiateMultipartUploadRequest struct {
	Bucket string
	Key    string

	// Custom metadata
	CustomMetadata map[string]string
}

Initiate Multipart Upload Request https://cloud.google.com/storage/docs/xml-api/post-object-multipart

type InitiateMultipartUploadResult

type InitiateMultipartUploadResult struct {
	XMLName  xml.Name `xml:"InitiateMultipartUploadResult"`
	Bucket   string   `xml:"Bucket"`
	Key      string   `xml:"Key"`
	UploadID string   `xml:"UploadId"`
}

Initiate Multipart Upload Response https://cloud.google.com/storage/docs/xml-api/post-object-multipart

type ListMultipartUploadsRequest

type ListMultipartUploadsRequest struct {
	Bucket string

	// Query string parameters for pagination and filtering
	KeyMarker      string
	MaxUploads     int
	Prefix         string
	UploadIdMarker string
	Delimiter      string
}

type ListMultipartUploadsResult

type ListMultipartUploadsResult struct {
	XMLName            xml.Name         `xml:"ListMultipartUploadsResult"`
	Bucket             string           `xml:"Bucket"`
	KeyMarker          string           `xml:"KeyMarker"`
	UploadIdMarker     string           `xml:"UploadIdMarker"`
	NextKeyMarker      string           `xml:"NextKeyMarker"`
	NextUploadIdMarker string           `xml:"NextUploadIdMarker"`
	Delimiter          string           `xml:"Delimiter"`
	Prefix             string           `xml:"Prefix"`
	MaxUploads         int              `xml:"MaxUploads"`
	IsTruncated        bool             `xml:"IsTruncated"`
	Uploads            []ListUpload     `xml:"Upload"`
	CommonPrefixes     []CommonPrefixes `xml:"CommonPrefixes"`
}

https://cloud.google.com/storage/docs/xml-api/get-bucket-uploads

type ListObjectPartsRequest

type ListObjectPartsRequest struct {
	Bucket           string
	Key              string
	UploadID         string
	MaxParts         int
	PartNumberMarker int
}

type ListObjectPartsResult

type ListObjectPartsResult struct {
	XMLName              xml.Name                    `xml:"ListPartsResult"`
	Bucket               string                      `xml:"Bucket"`
	Key                  string                      `xml:"Key"`
	UploadID             string                      `xml:"UploadId"`
	StorageClass         string                      `xml:"StorageClass"`
	PartNumberMarker     int                         `xml:"PartNumberMarker"`
	NextPartNumberMarker int                         `xml:"NextPartNumberMarker"`
	MaxParts             int                         `xml:"MaxParts"`
	IsTruncated          bool                        `xml:"IsTruncated"`
	Parts                []ListObjectPartsResultPart `xml:"Part"`
}

type ListObjectPartsResultPart

type ListObjectPartsResultPart struct {
	XMLName      xml.Name  `xml:"Part"`
	PartNumber   int       `xml:"PartNumber"`
	LastModified time.Time `xml:"LastModified"`
	Etag         string    `xml:"ETag"`
	Size         int64     `xml:"Size"`
}

type ListUpload

type ListUpload struct {
	XMLName      xml.Name  `xml:"Upload"`
	Key          string    `xml:"Key"`
	UploadID     string    `xml:"UploadId"`
	StorageClass string    `xml:"StorageClass"`
	Initiated    time.Time `xml:"Initiated"`
}

TODO: Support headers

type MultipartClient

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

Client for using GCS XML Multipart API: https://cloud.google.com/storage/docs/multipart-uploads

func New

func New(hc *http.Client) *MultipartClient

Create a multipart client that uses the specified http.Client.

func NewWithBaseURL

func NewWithBaseURL(hc *http.Client, baseURL string) *MultipartClient

NewWithBaseURL creates a multipart client with a custom base URL (useful for testing).

func (*MultipartClient) AbortMultipartUpload

func (mpuc *MultipartClient) AbortMultipartUpload(ctx context.Context, req *AbortMultipartUploadRequest) error

Abort multipart upload. https://cloud.google.com/storage/docs/xml-api/delete-multipart

func (*MultipartClient) CompleteMultipartUpload

func (mpuc *MultipartClient) CompleteMultipartUpload(ctx context.Context, req *CompleteMultipartUploadRequest) (*CompleteMultipartUploadResult, error)

Complete a multipart upload. https://cloud.google.com/storage/docs/xml-api/post-object-complete

func (*MultipartClient) InitiateMultipartUpload

func (mpuc *MultipartClient) InitiateMultipartUpload(ctx context.Context, req *InitiateMultipartUploadRequest) (*InitiateMultipartUploadResult, error)

InitiateMultipartUpload calls the XML Multipart API to Inititate a Multipart Upload.

func (*MultipartClient) ListMultipartUploads

func (mpuc *MultipartClient) ListMultipartUploads(ctx context.Context, req *ListMultipartUploadsRequest) (*ListMultipartUploadsResult, error)

List Multipart Uploads https://cloud.google.com/storage/docs/xml-api/get-bucket-uploads

func (*MultipartClient) ListObjectParts

func (mpuc *MultipartClient) ListObjectParts(ctx context.Context, req *ListObjectPartsRequest) (*ListObjectPartsResult, error)

List Object Parts https://cloud.google.com/storage/docs/xml-api/get-object-multipart

func (*MultipartClient) UploadObjectPart

func (mpuc *MultipartClient) UploadObjectPart(ctx context.Context, req *UploadObjectPartRequest) (*UploadObjectPartResult, error)

Upload an object part request. https://cloud.google.com/storage/docs/xml-api/put-object-multipart

type UploadObjectPartRequest

type UploadObjectPartRequest struct {
	// Query string parameters
	Bucket     string
	Key        string
	PartNumber int
	UploadID   string

	// Headers
	CRC32C        string
	MD5           string
	ContentLength int64 // Length of the part data.

	// Object body part contents.
	Body io.ReadCloser
}

type UploadObjectPartResult

type UploadObjectPartResult struct {
	ETag   string
	CRC32C string
	MD5    string
}